Telemetry docs: recipient, default-on/opt-out, and instance-name-in-route aren't documented (README says 'no personal data')
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 76/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- typescript
调研方向
从 README.md 中的 Telemetry 部分开始,并对照 src/utils/sendTelemetry.ts、src/config/env.config.ts、src/api/guards/telemetry.guard.ts 和 src/api/abstract/abstract.router.ts 验证其行为。更新文档,涵盖接收方、默认启用行为和选择退出变量,以及 route 的内容(包括实例名称);当 README.md 与所引用的代码一致时即表示完成。
由索引模型根据 Issue 内容生成。
描述
Hi, and thank you for Evolution API.
While reading the telemetry code I noticed a small gap between what the README states and what the code does, and I wanted to flag it kindly in case it's helpful.
What the README says (README.md, "## Telemetry"):
Evolution API collects anonymous telemetry data (routes used, most accessed routes, API version) to help improve the service. No sensitive or personal data is collected.
What I observed in the code (at commit fa09d37):
src/utils/sendTelemetry.tsPOSTs{ route, apiVersion, timestamp }tohttps://log.evolution-api.com/telemetryby default (whenTELEMETRY_URLis unset).src/config/env.config.ts(~L880–882):TELEMETRY.ENABLEDdefaults to true whenTELEMETRY_ENABLEDis unset — i.e. telemetry is on by default (opt-out).src/api/guards/telemetry.guard.tspassesreq.pathas theroute;src/api/abstract/abstract.router.ts(~L22–24) builds instance routes as<path>/:instanceName, so the transmittedrouteincludes the user-chosen instance name.
Why I'm raising it: the disclosure is accurate in spirit, but as written it doesn't mention (a) the recipient endpoint (log.evolution-api.com), (b) that telemetry is on by default and how to disable it (TELEMETRY_ENABLED=false), or (c) that the instance name travels inside route. The last point sits a little uneasily with "no sensitive or personal data is collected."
Suggested fix: a short README addition naming the recipient, the default-on behaviour + the opt-out env var, and clarifying what route contains. I'd be glad to open a small PR against develop if you'd like.
For transparency: I used AI assistance to help find and draft this; I verified every file and line against the current source myself.
Thank you!
- 主要语言
- TypeScript
- 星标
- 9.6k
- 派生
- 7.3k
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
evolution-foundation/evolution-api 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
-
难度 1/5 1-3 小时 新手友好度 88/100
-
bug
难度 2/5 1-3 小时 新手友好度 68/100
-
难度 1/5 1 小时以内 新手友好度 88/100
evolution-foundation/evolution-api#2700 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 76/100
查看 evolution-foundation/evolution-api 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 70/100
-
难度 2/5 1-3 小时 新手友好度 75/100
mksglu/context-mode#1200 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
难度 2/5 1-3 小时 新手友好度 75/100
anthropics/claude-code#96687 ·
-
good first issue
难度 1/5 1 小时以内 新手友好度 95/100
AOSSIE-Org/DebateAI#582 · 2 条评论 ·