Trench 安装与配置指南

Trench 安装与配置指南

trench Trench — Open-Source Analytics Infrastructure. A single production-ready Docker image built on ClickHouse, Kafka, and Node.js for tracking events, page views. Easily build product analytics dashboards, LLM RAGs, observability platforms, or any other analytics product. 项目地址: https://gitcode.com/gh_mirrors/tr/trench

1. 项目基础介绍

Trench 是一个开源的分析基础设施项目，基于 Apache Kafka 和 ClickHouse 构建而成。它能够处理大量的事件数据，并提供实时分析功能。Trench 符合 GDPR 和 PECR 规范，并且用户可以完全控制访问、更正或删除自己的数据。该项目主要用于事件跟踪系统，可以帮助开发者构建产品分析仪表板、观察性平台等分析产品。

主要编程语言：TypeScript、JavaScript

2. 项目使用的关键技术和框架

• Apache Kafka：用于构建实时数据管道，能够处理高吞吐量的数据流。
• ClickHouse：一个用于在线分析处理（OLAP）的数据库管理系统，能够提供快速的查询性能。
• Node.js：运行 JavaScript 代码的服务器端平台，用于构建后端服务。

3. 项目安装和配置的准备工作

在开始安装 Trench 之前，确保您的系统已经安装以下软件：

• Docker：用于容器化应用。
• Docker Compose：用于定义和运行多容器 Docker 应用。

详细安装步骤

1. 克隆项目仓库

   使用 Git 命令将 Trench 项目克隆到本地：

   git clone https://github.com/FrigadeHQ/trench.git
   

2. 进入项目目录

   克隆完成后，进入项目文件夹：

   cd trench
   

3. 配置环境变量

   复制 .env.example 文件为 .env 并根据实际情况编辑环境变量：

   cp .env.example .env
   

4. 启动 Trench 服务

   使用 Docker Compose 启动服务，运行以下命令：

   docker-compose -f docker-compose.yml -f docker-compose.dev.yml up --build --force-recreate --renew-anon-volumes
   

   此命令将启动 Trench 服务器，包括本地的 ClickHouse 和 Kafka 实例，你可以在浏览器中通过 http://localhost:4000 访问，并看到消息 "Trench server is running"。

5. 发送测试事件

   在 .env 文件中找到并更新默认的公开和私有 API 密钥。使用公开 API 密钥，你可以像下面这样发送一个测试事件：

   curl -i -X POST \
   -H "Authorization:Bearer PUBLIC_KEY" \
   -H "Content-Type:application/json" \
   -d '{
   "events": [
     {
       "userId": "USER_ID",
       "type": "track",
       "event": "TestEvent",
       "properties": {
         "test": "value"
       }
     }
   ]}' \
   http://localhost:4000/events
   

   确保 PUBLIC_KEY 替换为你的公开 API 密钥，USER_ID 替换为一个唯一的用户标识。

通过以上步骤，你应该能够成功安装和配置 Trench，并开始发送事件以及查询数据。

trench Trench — Open-Source Analytics Infrastructure. A single production-ready Docker image built on ClickHouse, Kafka, and Node.js for tracking events, page views. Easily build product analytics dashboards, LLM RAGs, observability platforms, or any other analytics product. 项目地址: https://gitcode.com/gh_mirrors/tr/trench