Apache Unomi 1.x - Documentation

• 语言: 英语
• 格式: .pdf
• 来源: downloads.apache.org

摘要

文档详细介绍了Apache Unomi 1.x的运行、配置和使用方法。内容涵盖如何启动服务、配置环境变量、安全设置、事件处理、配置文件管理以及与第三方服务的连接。文档还提供了关于如何处理用户配置文件合并、安全威胁检测、REST API访问控制等实用信息，并附带了多个配置示例和使用指南。

AI总结

## Apache Unomi 1.x 文档总结

### 1. 快速启动与运行
- **启动 Unomi**：根据五分钟快速启动指南或构建说明启动 Karaf。启动后，Karaf 控制台显示以下信息表示服务已启动并运行：

  Initializing user list service endpoint...
  Initializing geonames service endpoint...
  Initializing segment service endpoint...
  ...

- **访问服务**：启动后，可通过以下地址访问 RESTful 服务：
- RESTful 服务列表：`http://localhost:8181/cxs`
- 上下文信息：`http://localhost:8181/context.json`
- 入门页面：`http://localhost:8181`

### 2. 配置与管理
- **集中化配置**：Unomi 使用集中化配置文件，包含系统和配置属性。默认配置文件为 `$MY_KARAF_HOME/etc/custom.system.properties`，可通过创建 `unomi.custom.system.properties` 文件或使用环境变量覆盖默认值。
- **环境变量配置**：适用于 Docker 部署，通过环境变量修改默认配置。环境变量列表可在以下链接找到：[custom.system.properties](https://github.com/apache/unomi/blob/master/package/src/main/resources/etc/custom.system.properties)

### 3. 安全性
- **生产环境安全**：
- 配置防火墙，仅开放以下端口：
- `http://localhost:8181/context.js`
- `http://localhost:8181/eventcollector`
- 客户端访问端口：`8181`（HTTP）和 `9443`（HTTPS）
- 使用 HTTP Basic Auth 或 Digest Auth 保护 REST API，用户名和密码默认为 `karaf/karaf`。

### 4. 数据模型与事件
- **事件类型**：Unomi 支持自定义事件类型，如 `view`、`form`、`login` 等，默认事件类型可参考文档。
- **事件字段**：
- `eventType`：事件类型标识符
- `sessionId`：会话唯一标识符
- `profileId`：用户资料唯一标识符
- `timestamp`：事件接收时间（ISO 8601 格式）
- `scope`：事件范围标识符（可选）
- `source` 和 `target`：事件来源和目标（如网页、按钮等）

### 5. 高级功能
- **自动配置文件合并**：基于共同属性值（如 `email`）自动合并用户资料。合并后，旧资料会被标记为已合并，并替换为新的主资料。
- **地理位置服务**：
- 使用 MaxMind GeoIP 数据库进行 IP 地理位置解析，下载 `GeoLite2-City.mmdb` 数据库并放入 `etc` 目录。
- 使用 Geonames 数据库进行地理编码，下载 `allCountries.zip` 并放入 `etc` 目录，设置 `org.apache.unomi.geonames.forceImport` 开启导入。

### 6. 扩展与连接器
- **连接器**：Unomi 提供以下连接器：
- Salesforce CRM 连接器：支持与 Salesforce 集成，同步 Apache Unomi 用户资料与 Salesforce Leads。
- Mailchimp 连接器
- **开发连接器**：社区欢迎贡献更多连接器，详情可参考邮件列表。

### 7. 请求流程与查询
- **请求流程**：Unomi 通过 ContextServlet 处理请求，请求流程图详见文档。
- **查询与聚合**：Unomi 提供强大的查询 API，支持计数、求和、求平均值等操作，适用于复杂的数据分析需求。

### 总结
Apache Unomi 是一个功能强大的上下文服务器，支持用户行为分析、配置管理、安全防护、地理位置服务、事件处理和扩展连接器等功能。通过合理配置和使用，可以实现对用户行为的深度洞察和业务逻辑的灵活扩展。