Telemetry docs: recipient, default-on/opt-out, and instance-name-in-route aren't documented (README says 'no personal data')
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 76/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- typescript
- Área
- documentation
Línea de trabajo
Comienza con la sección Telemetry de README.md y verifica el comportamiento con src/utils/sendTelemetry.ts, src/config/env.config.ts, src/api/guards/telemetry.guard.ts y src/api/abstract/abstract.router.ts. Actualiza la documentación para cubrir el destinatario, el comportamiento activado de forma predeterminada y la variable de exclusión, así como el contenido de la ruta, incluidos los nombres de las instancias; se considera terminado cuando README.md coincide con el código citado.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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!
- Lenguaje dominante
- TypeScript
- Estrellas
- 9.6k
- Forks
- 7.3k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de evolution-foundation/evolution-api
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
evolution-foundation/evolution-api#2700 · 1 comentario ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
Todos los issues de evolution-foundation/evolution-api
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
mksglu/context-mode#1200 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
anthropics/claude-code#96687 ·
-
good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
AOSSIE-Org/DebateAI#582 · 2 comentarios ·