fix: remove invalid label field from non-pipeline component config examples#381
fix: remove invalid label field from non-pipeline component config examples#381
Conversation
The label field is not valid under metrics configuration. It was erroneously
included in auto-generated example YAML files for all metric types. Also fixes
the prometheus common example to use `prometheus: {}` (empty map) instead of
bare `prometheus:` (empty scalar).
Fixes DOC-1978.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis pull request removes empty Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Extends the metrics fix to all component types that don't support label: buffers, caches, rate-limits, scanners, and tracers (66 files total). The label field is only valid for inputs, outputs, and processors. The root cause is tracked in docs-extensions-and-macros#176. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
@mfernest Who is the eng SME for this one? All PRs that add or change technical content require at least one SME approval. |
…amples (#381) Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
…amples (#381) Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
…amples (#381) Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
…amples (#381) Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Summary
The `label` field is only valid for `inputs`, `outputs`, and `processors`. A bug in the doc-tools generator (docs-extensions-and-macros#176) causes it to be unconditionally added to the example YAML for all component types.
This PR removes the invalid `label: ""` from all affected component type examples:
The `metrics` fix was originally reported by a community member via Slack. See DOC-1978.
Also fixes the `prometheus` Common tab example to use `prometheus: {}` (empty map) instead of bare `prometheus:` (empty scalar).
Test plan
🤖 Generated with Claude Code
Page previews