Context
Surfaced during the audit for #464 (extending validator-recipe.sh to walk module/**/example_config.yaml).
docs/examples/with-telemetry.yaml is independently broken on main:
$ ./_build/tracecore validate --config=docs/examples/with-telemetry.yaml; echo $?
'receivers' unknown type: "clockreceiver" (valid values: [otlp filelog journald k8sobjects prometheus hostmetrics nccl_fr])
'exporters' unknown type: "stdoutexporter" (valid values: [otlphttp debug datadog clickhouse])
'' has invalid keys: telemetry
1
The file's header comment already calls out it was a v0.0.x-era artifact (# RFC-0013 note: clockreceiver and stdoutexporter below are the v0.0.x in-tree components. At v0.1.0 they map to OCB-bundled equivalents...). RFC-0013 PR-A2 shipped that mapping; this file was never migrated alongside.
Scope
Two reasonable outcomes -- pick one:
-
Migrate: rewrite to OCB-bundled equivalents (telemetrygeneratorreceiver + debug exporter), drop the telemetry: block (validate rejects it), then add docs/examples/*.yaml to validator-recipe.sh so this doesn't drift again.
-
Delete: this file predates the v0.1.0 pivot; if docs/integrations/examples/*.yaml + the per-module example_config.yaml already cover operator-facing onboarding, the historical artifact can be retired.
Either way: extend the gate to cover docs/examples/*.yaml afterward so the next regression is caught.
Why this wasn't bundled into #464
#464 scope was module/**/example_config.yaml. Migrating-vs-deleting with-telemetry.yaml is a content decision that deserves its own PR with reviewer eyes on the operator-facing implications, not a drive-by inside a CI-extension PR.
Refs
Context
Surfaced during the audit for #464 (extending
validator-recipe.shto walk module/**/example_config.yaml).docs/examples/with-telemetry.yamlis independently broken onmain:The file's header comment already calls out it was a v0.0.x-era artifact (
# RFC-0013 note: clockreceiver and stdoutexporter below are the v0.0.x in-tree components. At v0.1.0 they map to OCB-bundled equivalents...). RFC-0013 PR-A2 shipped that mapping; this file was never migrated alongside.Scope
Two reasonable outcomes -- pick one:
Migrate: rewrite to OCB-bundled equivalents (
telemetrygeneratorreceiver+debugexporter), drop thetelemetry:block (validate rejects it), then adddocs/examples/*.yamltovalidator-recipe.shso this doesn't drift again.Delete: this file predates the v0.1.0 pivot; if
docs/integrations/examples/*.yaml+ the per-moduleexample_config.yamlalready cover operator-facing onboarding, the historical artifact can be retired.Either way: extend the gate to cover
docs/examples/*.yamlafterward so the next regression is caught.Why this wasn't bundled into #464
#464 scope was
module/**/example_config.yaml. Migrating-vs-deletingwith-telemetry.yamlis a content decision that deserves its own PR with reviewer eyes on the operator-facing implications, not a drive-by inside a CI-extension PR.Refs
module/receiver/ncclfrreceiver/example_config.yaml)