Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#2,641 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
typescript
Domain
documentation

Research direction

Start with the Telemetry section in README.md and verify the behavior against src/utils/sendTelemetry.ts, src/config/env.config.ts, src/api/guards/telemetry.guard.ts, and src/api/abstract/abstract.router.ts. Update the documentation to cover the recipient, default-on behavior and opt-out variable, and the contents of route, including instance names; done means the README matches the cited code.

Written by the indexing model from the issue text.

Description

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!

Dominant language
TypeScript
Stars
9.7k
Forks
7.3k
No merged PRs in 30d

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from evolution-foundation/evolution-api

All issues in evolution-foundation/evolution-api

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.