eucm/beaconing-analytics-webhook

beaconing-analytics-webhook

该镜像由e-UCM研究组开发，属于H2020 BEACONING项目，用于向服务器发送分析信息；若服务器不可用，则将信息本地存储直至服务器恢复。

.png)

此镜像帮助创建用于通知事件的webhook，webhook可包含以下字段：

• name：webhook名称
• payload_url：接收通知的端点URL
• content_type：事件类型（如application/json、application/xml）
• secret（目前未使用）
• active：webhook是否处于激活状态

镜像概述

beaconing-analytics-webhook是H2020 BEACONING项目的核心组件之一，负责分析信息的可靠传递与事件管理，确保数据在服务器不可达时不丢失，并提供标准化的webhook接口。

核心功能

1. Webhook生命周期管理：支持创建、删除、列出webhook
2. 事件类型管理：支持创建、删除、列出事件类型，以及向webhook推送事件
3. 特殊同步事件处理：处理5种需A2认证的同步事件（GLP分配、用户/组创建、组参与者变更等）

使用场景

适用于BEACONING项目中的以下场景：

• 实时向指定服务器传输分析数据
• 服务器故障时的本地数据暂存与自动恢复
• Webhook和事件类型的集中管理
• 用户、组等实体变更时的同步数据处理

配置说明

• 访问webhook功能需验证密码，密码存储在分析框架根目录的.env文件中
• 特殊事件需包含有效的A2认证头（参考http://e-ucm.github.io/a2/#api-Login-Login）

使用方法

Webhook管理

• GET /webhooks/：列出所有webhook
• POST /webhooks/：创建新webhook
• GET /webhooks/delete/id：删除指定ID的webhook

事件管理

• GET /events/：列出所有事件类型
• POST /events/：创建新事件类型
• GET /events/delete/id：删除指定ID的事件类型
• POST /events/collector/event_type：向webhook推送事件（端点接收包含event_type的头部和请求体）

特殊事件

以下事件为同步处理，需携带A2认证头：

GLP分配

当GLP分配到组时，创建活动、仪表盘等分析资源：

• POST /events/glp_assigned：处理GLP分配
• 请求体：{"glp":"GLP_ID","groupId":"GROUP_ID"}
• 返回：装饰后的GLP（含跟踪代码、仪表盘链接等）或错误信息

用户创建

克隆BEACONING中的新用户：

• POST /events/user_created：克隆用户
• 请求体：{"id":"USER_ID","username":"NAME","role":"teacher/student"}
• 返回：成功状态或错误信息

组创建

克隆BEACONING中的新组：

• POST /events/group_created：克隆组
• 请求体：{"id":"GROUP_ID","name":"GROUP_NAME","students":["STUDENT_ID1"]}
• 返回：成功状态或错误信息

组参与者添加

向组添加学生/教师：

• POST /events/group_participants_added：添加参与者
• 请求体：{"id":"GROUP_ID","participants":{"students":["STUDENT_ID2"],"teachers":["TEACHER_ID1"]}}
• 返回：成功状态或错误信息

组参与者移除

从组移除学生/教师：

• POST /events/group_participants_removed：移除参与者
• 请求体：{"id":"GROUP_ID","participants":{"students":["STUDENT_ID2"]}}
• 返回：成功状态或错误信息

组删除

删除BEACONING中的组：

• POST /events/group_removed：删除组
• 请求体：{"id":"GROUP_ID"}
• 返回：成功状态或错误信息