evstats

外观

在线演示源码

文档导航 ​

evstats 的文档按读者分成四块：做产品调研的人、照着手册部署运维的人、接入与使用的人、做二次开发的人。每类人要看的内容不一样，这一页给出各自的阅读路径和整套文档的目录。

产品调研 ​

目标：判断 evstats 能不能满足需求、和别的方案差在哪、部署和维护要多少投入。

  1. 产品概览：是什么，四种用法（管理界面看数、Agent 对话问数、OpenAPI 取数、SDK 采集）。
  2. 功能全景：埋点、事件统计、漏斗、留存、路径、画像、热力图、回放、归因、A/B 实验……每一项能回答什么问题。
  3. 界面一览：四段操作动图和全部主要界面的截图。
  4. 系统架构：一个二进制加 ClickHouse 和 Redis，数据怎么流、部署形态有哪几种。
  5. 为什么是 evstats：和常见选择的差别，以及什么时候不该选它。
  6. 想亲手试：快速体验 十分钟跑起来，或者打开 在线演示。

读完应当能回答：数据存在哪、能不能满足我们的分析需求、要准备几台机器、有没有收费功能（没有）。

部署运维 ​

目标：照着手册把 evstats 装起来、放到公网、长期稳定运行。

  1. 部署总览：选部署方式，准备机器、端口、域名。
  2. 安装二选一：快速体验（单机 Compose）或 生产环境部署（ClickHouse、Redis、evstats 独立服务器，推荐）；不用容器时看 二进制与 systemd。
  3. 首次引导：设置超级管理员，选择是否创建演示项目。
  4. 反向代理与 HTTPS：Nginx 或 Caddy，可信代理与对外地址。
  5. 上线后：运维与排障、升级、备份与恢复、多节点与分片。
  6. 需要时查：系统配置、配置项、安全与隐私、错误码。

读完应当能：独立部署一套生产环境，知道每个组件挂了会怎样、怎么升级和备份。

接入与使用 ​

目标：把网站、App、服务端的数据收进来，在管理界面、Agent、OpenAPI 里用起来。

  1. 使用指南 与 核心概念：项目、两把钥匙、模块、看板、时区。
  2. 接入：接入概览、事件与属性（埋点设计）、全埋点与热力图、会话回放、接入检查；各端的 SDK 参考。
  3. 分析：看数、看板与书签、漏斗、留存与路径、用户画像、A/B 实验、归因、自定义 SQL。
  4. 问数与取数：Agent 问数、OpenAPI、API 参考、给外部 Agent 用。
  5. 管理：项目设置、用户与角色、操作日志。
  6. 口径与上限：指标口径、限制与上限、常见问题。

二次开发 ​

目标：读懂代码结构，按自己的需求加功能、改界面、接系统，并能构建出自己的镜像。

  1. 开发者导读：仓库结构、贯穿全局的约定、改一个功能会动到哪里。
  2. 开发环境：本机起 ClickHouse、Redis、服务端、管理界面、官网。
  3. 代码架构：服务端的包、启动顺序、一次上报和一次查询经过的代码、契约文件。
  4. 常见改动：新增一个统计模块、采集协议与 SDK、仪表盘开发、官网与文档。
  5. 交付：测试、构建与发布、贡献指南。

全部文档 ​

栏目读者页面
产品产品调研产品概览 · 功能全景 · 界面一览 · 系统架构 · 为什么是 evstats
部署部署运维部署总览 · 快速体验 · 生产环境 · 二进制与 systemd · 首次引导 · 反向代理与 HTTPS · 多节点与分片 · 运维与排障 · 升级 · 备份与恢复
使用指南接入与使用使用指南 · 核心概念 · 接入（5 篇）· 分析（7 篇）· Agent 与 OpenAPI（3 篇）· 管理（5 篇）· 安全与隐私 · 常见问题
开发二次开发开发者导读 · 开发环境 · 代码架构 · 新增统计模块 · 采集协议与 SDK · 仪表盘开发 · 官网与文档 · 测试 · 构建与发布 · 贡献指南
参考所有人SDK（Web、Go、Java、HTTP 协议、像素）· API 参考 · 指标口径 · 错误码 · 配置项 · 限制与上限 · 事件与属性名
其它所有人更新日志 · 路线图 · 社区与支持 · 许可证 · 隐私说明 · 报告安全问题