Skip to content

Commit 1842ae6

Browse files
committed
Correct PerfTrace export prerequisites and settings secrets guidance
Drop the fixed count of PostHog product events, remove the auth header from the settings example, and state that an endpoint alone enables export.
1 parent 9f37404 commit 1842ae6

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

docs/PERFTRACE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ error code `OTEL_CONFIG_INVALID` and does not half-enable export.
4646
"otel": {
4747
"enabled": true,
4848
"endpoint": "https://collector.example/v1",
49-
"headers": { "Authorization": "Bearer …" },
5049
"serviceName": "corbits-code",
5150
"resourceAttributes": {
5251
"deployment.environment": "dev"
@@ -55,6 +54,9 @@ error code `OTEL_CONFIG_INVALID` and does not half-enable export.
5554
}
5655
```
5756

57+
Do not put auth headers in settings; pass them via `OTEL_EXPORTER_OTLP_HEADERS`
58+
so secrets stay out of the settings file.
59+
5860
Precedence:
5961

6062
- **endpoint:** env overrides settings
@@ -65,6 +67,9 @@ Precedence:
6567
`resourceAttributes["service.name"]` is always set to the resolved name so
6668
the two never diverge.
6769
- **resourceAttributes:** settings merged with env; env wins on key conflict
70+
- **enabling export:** setting an endpoint (settings or env) enables export;
71+
`otel.enabled` need not be set. Service name or resource attributes alone do
72+
not enable export.
6873
- **`otel.enabled: false`:** disables export when only settings provide an
6974
endpoint; an explicit env endpoint still enables export
7075

@@ -132,7 +137,7 @@ export OTEL_EXPORTER_OTLP_HEADERS="Authorization=Bearer%20<phc_…>"
132137
export OTEL_SERVICE_NAME="corbits-code"
133138
```
134139

135-
This does **not** expand the three PostHog product events in `docs/TELEMETRY.md`.
140+
This does **not** expand the PostHog product events in `docs/TELEMETRY.md`.
136141
Product analytics opt-out (`CORBITS_TELEMETRY`, `DO_NOT_TRACK`, settings) does
137142
not control OTEL export, and vice versa.
138143

@@ -166,7 +171,7 @@ Then supply auth only via env when needed.
166171

167172
| Pipe | Purpose | Default | Content |
168173
| ----------------------------- | ------------------------------ | --------- | --------------------------- |
169-
| PostHog (`docs/TELEMETRY.md`) | Aggregate product usage | Opt-out | Three allowlisted events |
174+
| PostHog (`docs/TELEMETRY.md`) | Aggregate product usage | Opt-out | Allowlisted product events |
170175
| Local PerfTrace | Operator/dev attribution | Always on | Privacy-strict phase spans |
171176
| OTEL export | Your APM / Phoenix / collector | Opt-in | Full span tree when enabled |
172177

0 commit comments

Comments
 (0)