Apache Flagon UserALE 技术文档

1. 安装指南

通过 npm 安装

你可以通过 npm 安装 Apache Flagon UserALE：

npm install flagon-userale

如果你需要强制使用支持的 Node.js 版本，可以使用以下命令：

npm install flagon-userale --engine-strict

作为模块引入

在你的项目中，可以通过以下方式将 UserALE 作为模块引入：

import * as userale from 'flagon-userale';

或者：

const userale = require('flagon-userale');

作为脚本标签引入

你也可以通过脚本标签引入 UserALE：

<script src="./node_modules/flagon-userale/build/userale-2.4.0.min.js"></script>

如果你希望通过 CDN 引入，可以使用以下方式：

<script src="https://cdn.jsdelivr.net/npm/flagon-userale@2.4.0/build/userale-2.4.0.min.js"></script>

作为 WebExtension 引入

UserALE 还支持作为 WebExtension 引入，具体步骤请参考项目文档。

2. 项目的使用说明

快速开始

1. 在你的项目中引入 UserALE，可以通过模块或脚本标签的方式。
2. 设置日志接收端点。你可以使用项目提供的示例服务器工具，或者使用 Elasticsearch (ELK) 堆栈示例。
3. 使用 UserALE 的 API 配置日志发送的 URL 和其他参数。
4. 进一步探索 UserALE 的 API，自定义日志流、添加过滤器、自定义日志等。
5. 可视化和分析你的日志，使用项目提供的 Kibana 仪表盘示例。

3. 项目 API 使用文档

配置选项

如果你通过模块引入 UserALE，可以使用 userale.options() 函数来配置选项。例如：

userale.options({
    "userId": "example-user",
    "autostart": false,
    "url": "http://localhost:8000/",
    "version": "2.4.0",
    "logDetails": false,
    "sessionId": "example-session"
});

userale.start();

配置参数

参数	描述	默认值
url	日志发送的 URL	http://localhost:8000
autostart	是否在页面加载时自动开始记录日志	true
transmitInterval	传输检查的延迟时间	5000 (ms)
logCountThreshold	发送日志的最小数量	5
userId	用户标识符	null
sessionId	会话标识符	null
version	应用程序版本标识符	null
logDetails	是否记录详细日志（按键和输入/更改值）	false
resolution	高频日志之间的延迟时间（鼠标悬停、滚动等）	500 (ms)
userFromParams	从页面 URL 中获取 userId 的查询参数	null
toolName	正在记录的工具名称	null
authHeader	传递给日志端点的授权头	null

通过脚本标签配置

如果你通过脚本标签引入 UserALE，可以使用 HTML 数据参数来配置选项：

<script
    src="./node_modules/flagon-userale/build/userale-2.4.0.min.js"
    data-url="http://localhost:8000/"
    data-user="example-user"
    data-version="2.4.0"
    data-tool="Apache UserALE Example"
></script>

4. 项目安装方式

通过 npm 安装

npm install flagon-userale

作为模块引入

import * as userale from 'flagon-userale';

作为脚本标签引入

<script src="./node_modules/flagon-userale/build/userale-2.4.0.min.js"></script>

通过 CDN 引入

<script src="https://cdn.jsdelivr.net/npm/flagon-userale@2.4.0/build/userale-2.4.0.min.js"></script>

作为 WebExtension 引入

UserALE 还支持作为 WebExtension 引入，具体步骤请参考项目文档。

通过以上步骤，你可以在你的项目中成功安装和配置 Apache Flagon UserALE，并开始记录用户行为日志。