Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Telemetry docs: recipient, default-on/opt-out, and instance-name-in-route aren't documented (README says 'no personal data')

Aperta Adatta ai principianti
#2,641 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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.ts POSTs { route, apiVersion, timestamp } to https://log.evolution-api.com/telemetry by default (when TELEMETRY_URL is unset).
  • src/config/env.config.ts (~L880–882): TELEMETRY.ENABLED defaults to true when TELEMETRY_ENABLED is unset — i.e. telemetry is on by default (opt-out).
  • src/api/guards/telemetry.guard.ts passes req.path as the route; src/api/abstract/abstract.router.ts (~L22–24) builds instance routes as <path>/:instanceName, so the transmitted route includes 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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di evolution-foundation/evolution-api

Tutte le issue di evolution-foundation/evolution-api

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.