Skip to content

Commit 0500439

Browse files
committed
docs: document telemetry configuration
1 parent 59d697d commit 0500439

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Gitte keeps all your repos in sync, runs startup checks to verify your local mac
1616
- [Commands](#commands)
1717
- [Configuration](#configuration)
1818
- [Environment variables](#environment-variables)
19+
- [Telemetry](#telemetry)
1920
- [Global flags](#global-flags)
2021
- [State and override files](#state-and-override-files)
2122

@@ -170,6 +171,36 @@ See [docs/config.md](./docs/config.md) for the full configuration reference.
170171

171172
---
172173

174+
## Telemetry
175+
176+
Gitte can export OpenTelemetry traces to an OTLP/HTTP endpoint (e.g. Elastic
177+
APM) to help debug failures. Traces capture the command run, per-repo git
178+
context (branch, commit SHA, dirty state), and per-task outcomes with errors.
179+
No PII is collected (no hostname, OS username, or full remote URLs).
180+
181+
Enable it via the shared config:
182+
183+
```yaml
184+
telemetry:
185+
endpoint: https://apm.example.com:8200
186+
headers:
187+
Authorization: "Bearer <secret-token>" # or: "ApiKey <base64-key>"
188+
```
189+
190+
Environment variables:
191+
192+
| Variable | Effect |
193+
|---|---|
194+
| `GITTE_TELEMETRY=off` | Disable telemetry locally (kill-switch) |
195+
| `GITTE_TELEMETRY_URL` | Override the endpoint |
196+
| `OTEL_EXPORTER_OTLP_ENDPOINT` / `OTEL_EXPORTER_OTLP_HEADERS` | Standard OTEL env vars, honored as a fallback when no gitte endpoint is set |
197+
198+
Precedence: `GITTE_TELEMETRY=off` > `GITTE_TELEMETRY_URL` > config endpoint >
199+
`OTEL_EXPORTER_OTLP_*`. Telemetry is best-effort and never blocks or slows
200+
gitte; export failures are silently ignored.
201+
202+
---
203+
173204
## Global flags
174205

175206
```

0 commit comments

Comments
 (0)