From 6862bf9cc0836a614a37e86c83450dcecb826edd Mon Sep 17 00:00:00 2001 From: RockChinQ <1010553892@qq.com> Date: Wed, 30 Sep 2026 22:37:26 +0800 Subject: [PATCH] docs: move telemetry configuration out of READMEs (#2619) --- README.md | 4 ---- README_CN.md | 4 ---- docs/TELEMETRY.md | 20 ++++++++++++++++++++ 3 files changed, 20 insertions(+), 8 deletions(-) create mode 100644 docs/TELEMETRY.md diff --git a/README.md b/README.md index b117b149c..6a36e7b94 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,3 @@ Thanks to all [contributors](https://github.com/langbot-app/LangBot/graphs/contr - -## Optional telemetry - -Telemetry is enabled by default. To opt out, set `space.disable_telemetry: true` in your instance’s `data/config.yaml`, preserve other settings, and restart the instance. This disables usage, heartbeat and execution telemetry. In Cloud, the instance operator controls this setting for every workspace in the instance. Delivery is best-effort in background tasks; connection failures, timeouts and server errors do not block normal operations. Failure details are logged only at DEBUG level. diff --git a/README_CN.md b/README_CN.md index b2c4b1604..33b92645e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -212,7 +212,3 @@ LangBot **从设计上就对 Agent 友好** —— 你的编码 Agent(Claude C If you're a code agent based on LLM, you should read [AGENTS.md](AGENTS.md) to understand the project structure and development process before you start any development. --> - -## 可选遥测 - -遥测默认开启。可以在实例 `data/config.yaml` 中将 `space.disable_telemetry` 改为 `true`,保留其他配置,然后重启实例。此开关关闭使用统计、实例心跳和功能执行遥测;Cloud 由实例运维方配置,对该实例所有工作区生效。遥测在后台尽力发送,网络故障、超时或服务端错误不会阻断正常操作;失败详情仅记录在 DEBUG 日志中。 diff --git a/docs/TELEMETRY.md b/docs/TELEMETRY.md new file mode 100644 index 000000000..f5c8ec504 --- /dev/null +++ b/docs/TELEMETRY.md @@ -0,0 +1,20 @@ +# Telemetry / 遥测 + +## 可选遥测 + +遥测默认开启。可以在实例 `data/config.yaml` 中将 `space.disable_telemetry` 改为 `true`,保留其他配置,然后重启实例。此开关关闭使用统计、实例心跳和功能执行遥测;Cloud 由实例运维方配置,对该实例所有工作区生效。遥测在后台尽力发送,网络故障、超时或服务端错误不会阻断正常操作;失败详情仅记录在 DEBUG 日志中。 + +## Optional telemetry + +Telemetry is enabled by default. To opt out, set `space.disable_telemetry: true` in your instance’s `data/config.yaml`, preserve other settings, and restart the instance. This disables usage, heartbeat and execution telemetry. In Cloud, the instance operator controls this setting for every workspace in the instance. Delivery is best-effort in background tasks; connection failures, timeouts and server errors do not block normal operations. Failure details are logged only at DEBUG level. + +## Configuration / 配置示例 + +```yaml +space: + disable_telemetry: true +``` + +修改现有 `space` 节点,保留其他配置;不要创建重复的节点。恢复默认行为时,将此项改回 `false` 并重启实例。 + +Edit the existing `space` section and preserve other settings; do not create a duplicate section. To restore the default, set this option to `false` and restart the instance.