docs: outputs: skywalking: fix table header, sort order, host default, classic key casing#2424
docs: outputs: skywalking: fix table header, sort order, host default, classic key casing#2424eschabell wants to merge 1 commit intofluent:masterfrom
Conversation
📝 WalkthroughWalkthroughUpdated Apache SkyWalking output documentation: restructured parameter table, added Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 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)
📝 Coding Plan
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 Tip CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present. |
|
@cosmo0920 and @patrick-stephens ready for review! |
…, classic key casing - Fix table column header: "Parameter" -> "Key" for consistency with other output plugin docs - Remove redundant "This plugin supports the following parameters:" intro sentence - Sort configuration parameters table alphabetically - Fix stray space in host default value - Apply Title_Case to classic config keys: Svc_name, Svc_inst_name Applies to fluent#2412 Signed-off-by: Eric D. Schabell <eric@schabell.org>
87e01cf to
2087bb2
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@pipeline/outputs/skywalking.md`:
- Around line 51-52: Replace the underscored classic config keys `Svc_name` and
`Svc_inst_name` with Title_Case `SvcName` and `SvcInstName` respectively; locate
all occurrences (e.g., the entries showing "Svc_name dummy-service" and
"Svc_inst_name dummy-service-fluentbit") and update the key names, preserving
their values and spacing/formatting, and run any config validation or tests that
parse these keys to ensure nothing else relies on the old underscored names.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e30e2e08-4e24-4b9a-93b8-f853f6f9ac6a
📒 Files selected for processing (1)
pipeline/outputs/skywalking.md
| Svc_name dummy-service | ||
| Svc_inst_name dummy-service-fluentbit |
There was a problem hiding this comment.
Incomplete Title_Case transformation in classic config keys.
The PR description states: "Apply Title_Case to classic config keys: Svc_name → SvcName, Svc_inst_name → SvcInstName." However, the actual changes show Svc_name and Svc_inst_name (still containing underscores) instead of the target SvcName and SvcInstName. Based on learnings, classic config Title_Case keys typically don't use underscores (e.g., Rate, Window, Interval).
✏️ Proposed fix to complete the Title_Case transformation
- Svc_name dummy-service
- Svc_inst_name dummy-service-fluentbit
+ SvcName dummy-service
+ SvcInstName dummy-service-fluentbit📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Svc_name dummy-service | |
| Svc_inst_name dummy-service-fluentbit | |
| SvcName dummy-service | |
| SvcInstName dummy-service-fluentbit |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@pipeline/outputs/skywalking.md` around lines 51 - 52, Replace the underscored
classic config keys `Svc_name` and `Svc_inst_name` with Title_Case `SvcName` and
`SvcInstName` respectively; locate all occurrences (e.g., the entries showing
"Svc_name dummy-service" and "Svc_inst_name dummy-service-fluentbit") and
update the key names, preserving their values and spacing/formatting, and run
any config validation or tests that parse these keys to ensure nothing else
relies on the old underscored names.
There was a problem hiding this comment.
I guess this is part of the usual not-really-yaml config issues @eschabell but it looks like this is a valid statement as we are not using Title_Case here?
Applies to #2412
Summary by CodeRabbit
Documentation