xinyin025/LangBot
1
0
Fork 0
mirror of https://github.com/langbot-app/LangBot.git synced 2026-10-30 04:15:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(insight): document telemetry features object and instance heartbeat (zh/en/ja)

Browse Source
This commit is contained in:
RockChinQ
2026-06-12 08:13:33 -04:00
parent 74376ec108
commit b1ee1ee12c
3 changed files with 87 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
en/insight/data-collection-policy.mdx
+29 -1
View File
@@ -19,9 +19,36 @@ When telemetry is enabled (via LangBot Space integration), the following data is
| `version` | The LangBot version you are running |
| `instance_id` | A randomly generated UUID identifying your LangBot instance (generated at first launch, not linked to personal identity) |
| `pipeline_plugins` | Names of pipeline plugins involved in the query |
| `features` | Anonymous feature-usage counters for the query (see below) |
| `error` | Error traceback if the query failed (no user content included) |
| `timestamp` | When the query occurred (UTC) |
#### The `features` object
To understand which capabilities are actually used, each query event may include the following counters and category names — **never the content** of tool calls, retrieved documents, or executed code:
| Key | Description |
|---|---|
| `tool_calls` | Number of tool invocations during the query, grouped by tool source (`native` / `plugin` / `mcp` / `skill`) |
| `tool_call_rounds` | How many agent tool-call rounds the query took |
| `kb` | Knowledge base usage: number of knowledge bases queried, knowledge engine plugin IDs in use, and the number of retrieved entries — not the retrieved text |
| `sandbox` | Number of sandbox code executions and sandbox errors — not the executed code or its output |
| `activated_skills` | Names of skills activated during the query |
| `mcp_servers` | Names of MCP servers bound to the pipeline (omitted when "all enabled" is used) |
### Instance heartbeat
In addition to per-query events, LangBot sends an anonymous **instance heartbeat** once shortly after startup and then once per day. It describes the instance's configuration profile — never its data:
| Field | Description |
|---|---|
| `deploy_platform` | How LangBot is deployed (`docker`, `linux`, `darwin`, `win32`, ...) |
| `database` | Database kind in use (`sqlite` or `postgresql`) — no connection details |
| `vdb` | Vector database kind in use (e.g., `chroma`, `milvus`, `qdrant`) — no connection details |
| `box` | Sandbox configuration: enabled flag, availability, backend kind (`docker` / `nsjail` / `e2b`), deployment topology — no workspace contents |
| `adapters` | Adapter type names of enabled bots |
| `bot_count`, `pipeline_count`, `mcp_server_count`, `knowledge_base_count`, `plugin_count`, `skill_count` | Object counts only — no names or contents of these resources |
### Surveys
LangBot may occasionally present in-app surveys (e.g., product-market fit surveys). Participation is **optional**. When a survey is submitted, the following is sent:
@@ -65,6 +92,7 @@ space:
When telemetry is disabled:
- No query data will be sent
- No instance heartbeats will be sent
- No surveys will be fetched or displayed
- All other LangBot features continue to work normally
@@ -72,4 +100,4 @@ When telemetry is disabled:
We may update this policy as LangBot evolves. Changes will be documented in our release notes and reflected in this page.
*Last updated: July 2025*
*Last updated: June 2026*
ja/insight/data-collection-policy.mdx
+29 -1
View File
@@ -19,9 +19,36 @@ LangBot は製品改善のため、最小限の匿名テレメトリデータを
| `version` | 実行中の LangBot バージョン |
| `instance_id` | LangBot インスタンスを識別するランダム生成 UUID（初回起動時に生成、個人情報とは紐付けられません） |
| `pipeline_plugins` | クエリに関与したパイプラインプラグイン名 |
| `features` | クエリの匿名機能使用カウンター（下記参照） |
| `error` | クエリ失敗時のエラートレースバック（ユーザーコンテンツは含まれません） |
| `timestamp` | クエリが発生した時刻（UTC） |
#### `features` オブジェクト
各機能の実際の利用状況を把握するため、各クエリイベントには以下のカウンターとカテゴリ名が含まれる場合があります — ツール呼び出しの内容、検索されたドキュメント、実行されたコードは**一切含まれません**：
| キー | 説明 |
|---|---|
| `tool_calls` | クエリ中のツール呼び出し回数（ツール種別ごと：`native` / `plugin` / `mcp` / `skill`） |
| `tool_call_rounds` | クエリで実行されたエージェントのツール呼び出しラウンド数 |
| `kb` | ナレッジベースの利用状況：クエリしたナレッジベース数、使用中のナレッジエンジンプラグイン ID、検索されたエントリ数 — 検索されたテキストは含まれません |
| `sandbox` | サンドボックスでのコード実行回数とエラー回数 — 実行されたコードやその出力は含まれません |
| `activated_skills` | クエリ中にアクティベートされたスキル名 |
| `mcp_servers` | パイプラインにバインドされた MCP サーバー名（「すべて有効」の場合は送信されません） |
### インスタンスハートビート
クエリごとのイベントに加え、LangBot は起動直後とその後 1 日 1 回、匿名の**インスタンスハートビート**を送信します。これはインスタンスの構成プロファイルを示すもので、インスタンスのデータは一切含まれません：
| フィールド | 説明 |
|---|---|
| `deploy_platform` | LangBot のデプロイ方法（`docker`、`linux`、`darwin`、`win32` など） |
| `database` | 使用中のデータベース種別（`sqlite` または `postgresql`）— 接続情報は含まれません |
| `vdb` | 使用中のベクトルデータベース種別（例：`chroma`、`milvus`、`qdrant`）— 接続情報は含まれません |
| `box` | サンドボックス構成：有効フラグ、可用性、バックエンド種別（`docker` / `nsjail` / `e2b`）、デプロイトポロジー — ワークスペースの内容は含まれません |
| `adapters` | 有効なボットのアダプター種別名 |
| `bot_count`、`pipeline_count`、`mcp_server_count`、`knowledge_base_count`、`plugin_count`、`skill_count` | オブジェクト数のみ — これらのリソースの名前や内容は含まれません |
### アンケート
LangBot はアプリ内でアンケート（例：プロダクトマーケットフィット調査）を表示する場合があります。参加は**任意**です。アンケート送信時には以下が送信されます：
@@ -65,6 +92,7 @@ space:
テレメトリを無効にすると：
- クエリデータは送信されません
- インスタンスハートビートは送信されません
- アンケートの取得・表示は行われません
- その他すべての LangBot 機能は通常通り動作します
@@ -72,4 +100,4 @@ space:
LangBot の発展に伴い、このポリシーを更新する場合があります。変更はリリースノートに記載され、このページに反映されます。
*最終更新：2025年7月*
*最終更新：2026年6月*
zh/insight/data-collection-policy.mdx
+29 -1
View File
@@ -19,9 +19,36 @@ LangBot 收集最少量的匿名遥测数据，以帮助改进产品。本文档
| `version` | 您正在运行的 LangBot 版本 |
| `instance_id` | 随机生成的 UUID，标识您的 LangBot 实例（首次启动时生成，不与个人身份关联） |
| `pipeline_plugins` | 参与查询的管道插件名称 |
| `features` | 本次查询的匿名功能使用计数（见下文） |
| `error` | 查询失败时的错误追踪信息（不包含用户内容） |
| `timestamp` | 查询发生的时间（UTC） |
#### `features` 对象
为了解各项能力的实际使用情况，每个查询事件可能包含以下计数和类别名称 — **绝不包含**工具调用内容、检索到的文档内容或执行的代码：
| 键 | 说明 |
|---|---|
| `tool_calls` | 本次查询中的工具调用次数，按工具来源分组（`native` / `plugin` / `mcp` / `skill`） |
| `tool_call_rounds` | 本次查询经历的 Agent 工具调用轮数 |
| `kb` | 知识库使用情况：查询的知识库数量、使用的知识引擎插件 ID、检索到的条目数量 — 不包含检索到的文本 |
| `sandbox` | 沙箱代码执行次数和沙箱错误次数 — 不包含执行的代码或其输出 |
| `activated_skills` | 本次查询中激活的技能名称 |
| `mcp_servers` | 绑定到管道的 MCP 服务器名称（使用"全部启用"时不发送） |
### 实例心跳
除每次查询事件外，LangBot 会在启动后不久发送一次匿名**实例心跳**，之后每天发送一次。心跳描述实例的配置概况 — 绝不包含实例数据：
| 字段 | 说明 |
|---|---|
| `deploy_platform` | LangBot 的部署方式（`docker`、`linux`、`darwin`、`win32` 等） |
| `database` | 使用的数据库类型（`sqlite` 或 `postgresql`）— 不包含连接信息 |
| `vdb` | 使用的向量数据库类型（如 `chroma`、`milvus`、`qdrant`）— 不包含连接信息 |
| `box` | 沙箱配置：启用状态、可用性、后端类型（`docker` / `nsjail` / `e2b`）、部署拓扑 — 不包含工作区内容 |
| `adapters` | 已启用机器人的适配器类型名称 |
| `bot_count`、`pipeline_count`、`mcp_server_count`、`knowledge_base_count`、`plugin_count`、`skill_count` | 仅对象数量 — 不包含这些资源的名称或内容 |
### 问卷调查
LangBot 可能会偶尔在应用内展示问卷调查（如产品市场匹配调查）。参与完全**自愿**。提交问卷时，将发送以下内容：
@@ -65,6 +92,7 @@ space:
关闭遥测后：
- 不会发送任何查询数据
- 不会发送实例心跳
- 不会获取或展示问卷调查
- 所有其他 LangBot 功能照常运行
@@ -72,4 +100,4 @@ space:
我们可能会随着 LangBot 的发展更新此政策。变更将记录在发布说明中并体现在此页面。
*最后更新：2025 年 7 月*
*最后更新：2026 年 6 月*