lukaszraczylo/go-telegram
1
0
Fork 0
mirror of https://github.com/lukaszraczylo/go-telegram.git synced 2026-07-10 14:43:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: collapse telemetry section to link upstream docs

Browse Source 
Replaces the duplicated opt-out table with a link to the canonical
oss-telemetry README section. Keeps the project-specific env var name
and the local source pointer; removes drift risk for the rest.
This commit is contained in:
Lukasz Raczylo
2026-05-21 04:03:55 +01:00
parent 609c4ce649
commit 8d85e61da5
1 changed files with 9 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -26
View File
@@ -373,34 +373,17 @@ The library's own generated test suite (`api/methods_gen_test.go`) covers 176 me
## Telemetry ## Telemetry
On the **first call to `client.New`** in a process, this library sends a single On the **first call to `client.New`** in a process, this library sends a
anonymous HTTP POST to `https://oss.raczylo.com/v1/ping` containing exactly single anonymous adoption ping — project name, version, timestamp; no
this body: identifiers, no message contents, no API call metadata. Fire-and-forget
with a 2-second timeout; cannot block `New` or panic.
```json Local source: [`client/telemetry.go`](client/telemetry.go). Upstream
{ "project": "go-telegram", "version": "0.7.11", "ts": 1747782200 } implementation, exact wire format, and full opt-out documentation:
``` **[oss-telemetry — Disabling telemetry](https://github.com/lukaszraczylo/oss-telemetry#disabling-telemetry)**.
This helps us see approximate adoption and version spread. No identifiers, Quick opt-out: set any of `DO_NOT_TRACK=1`, `OSS_TELEMETRY_DISABLED=1`,
no telemetry of API calls, no message contents, no tokens, no IPs stored or `GO_TELEGRAM_DISABLE_TELEMETRY=1`.
beyond a short server-side dedupe window. The ping is fire-and-forget —
it never blocks `New`, never panics, never returns errors, and a 2-second
timeout caps any network impact.
Telemetry source: [`client/telemetry.go`](client/telemetry.go) and the
upstream library [`github.com/lukaszraczylo/oss-telemetry`](https://github.com/lukaszraczylo/oss-telemetry).
### Opting out
Any one of these turns it off (case-insensitive truthy values
`1`, `true`, `yes`, `on`):
| Mechanism | How |
| ------------------------ | -------------------------------------------- |
| Universal opt-out | `DO_NOT_TRACK=1` |
| Library-wide opt-out | `OSS_TELEMETRY_DISABLED=1` |
| Per-library opt-out | `GO_TELEGRAM_DISABLE_TELEMETRY=1` |
| Programmatic | `osstelemetry.Disable()` before `client.New` |
## Contributing ## Contributing