From 984fd1c08f69d78678487d0a04d5b152f02399df Mon Sep 17 00:00:00 2001 From: Lukasz Raczylo Date: Thu, 21 May 2026 04:07:19 +0100 Subject: [PATCH] docs: add Telemetry section linking to oss-telemetry opt-out docs Discloses the single anonymous adoption ping sent on first plugin instantiation. Points users to the upstream README section for the disclosure pattern and to the local telemetry.go for the inline implementation. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index d8576fb..8921311 100644 --- a/README.md +++ b/README.md @@ -411,6 +411,19 @@ namespaced claims, Cognito regions, GitLab self-hosted) live in Set `logLevel: debug` to surface detail. +## Telemetry + +On first plugin instantiation this middleware sends a single anonymous +adoption ping — project name, version, timestamp; no identifiers, no +request data, no token contents. Fire-and-forget with a 2-second timeout; +cannot block plugin load or panic. + +Local source: [`telemetry.go`](./telemetry.go). Disclosure mirrors +**[oss-telemetry — Disabling telemetry](https://github.com/lukaszraczylo/oss-telemetry#disabling-telemetry)**. + +Quick opt-out: set any of `DO_NOT_TRACK=1`, `OSS_TELEMETRY_DISABLED=1`, +or `TRAEFIKOIDC_DISABLE_TELEMETRY=1`. + ## License See [LICENSE](LICENSE).