Telemetry docs: recipient, default-on/opt-out, and instance-name-in-route aren't documented (README says 'no personal data')
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 76/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- typescript
- Ambito
- documentation
Direzione di ricerca
Inizia dalla sezione Telemetry di README.md e verifica il comportamento rispetto a src/utils/sendTelemetry.ts, src/config/env.config.ts, src/api/guards/telemetry.guard.ts e src/api/abstract/abstract.router.ts. Aggiorna la documentazione in modo da coprire il destinatario, il comportamento attivo per impostazione predefinita e la variabile di opt-out, nonché il contenuto della route, inclusi i nomi delle istanze; il lavoro è completato quando README.md corrisponde al codice citato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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!
- Lingua principale
- TypeScript
- Stelle
- 9.6k
- Fork
- 7.3k
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di evolution-foundation/evolution-api
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
evolution-foundation/evolution-api#2700 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
Tutte le issue di evolution-foundation/evolution-api
Issue simili
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Crush Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
ElementsProject/cln-application#167 · 1 commento · 1 reazione ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Quantco/pnpm-licenses#17 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100