Telemetry docs: recipient, default-on/opt-out, and instance-name-in-route aren't documented (README says 'no personal data')
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 1/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 76/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với phần Telemetry trong README.md và xác minh hành vi dựa trên src/utils/sendTelemetry.ts, src/config/env.config.ts, src/api/guards/telemetry.guard.ts và src/api/abstract/abstract.router.ts. Cập nhật tài liệu để bao quát bên nhận, hành vi được bật mặc định và biến opt-out, cùng với nội dung của route, bao gồm cả tên các instance; hoàn tất có nghĩa là README.md khớp với mã được dẫn chiếu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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!
- Ngôn ngữ chính
- TypeScript
- Star
- 9.6k
- Fork
- 7.3k
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của evolution-foundation/evolution-api
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
evolution-foundation/evolution-api#2700 · 1 bình luận ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Tất cả issue của evolution-foundation/evolution-api
Issue tương tự
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Crush Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
ElementsProject/cln-application#167 · 1 bình luận · 1 reaction ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
Quantco/pnpm-licenses#17 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100