Skip to content

docs: outputs: skywalking: fix table header, sort order, host default, classic key casing#2424

Open
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_out_skywalking_updates
Open

docs: outputs: skywalking: fix table header, sort order, host default, classic key casing#2424
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_out_skywalking_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 16, 2026

  • 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 #2412

Summary by CodeRabbit

Documentation

  • Revised Apache SkyWalking output parameter table header and column formatting for clarity.
  • Added new auth_token parameter to the documented options.
  • Reordered parameters so host and port appear before service name fields.
  • Updated sample configuration keys to CamelCase (Svc_name, Svc_inst_name) for consistency.

@eschabell eschabell self-assigned this Mar 16, 2026
@eschabell eschabell requested a review from a team as a code owner March 16, 2026 08:50
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 16, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2026

📝 Walkthrough

Walkthrough

Updated Apache SkyWalking output documentation: restructured parameter table, added auth_token, normalized host/port defaults, reordered parameter listing, and converted sample configuration keys to CamelCase (svc_nameSvc_name, svc_inst_nameSvc_inst_name).

Changes

Cohort / File(s) Summary
Documentation Updates
pipeline/outputs/skywalking.md
Modified documentation table header and column formatting, added new auth_token key, reordered parameters (host/port moved before svc entries), normalized default formatting (backticks), and updated example config keys to CamelCase (Svc_name, Svc_inst_name).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 I hopped through docs with nimble paws,
I tucked in tokens, smoothed the rows,
CamelCase caps and tidy hosts,
A little change that lightly glows,
Happy hops for readers near and far!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main changes: documentation fixes for SkyWalking output including table header, sort order, host default, and key casing adjustments.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

@eschabell
Copy link
Collaborator Author

@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>
@eschabell eschabell force-pushed the erics_out_skywalking_updates branch from 87e01cf to 2087bb2 Compare March 16, 2026 14:32
@eschabell eschabell changed the title docs: utputs: skywalking: fix table header, sort order, host default, classic key casing docs: outputs: skywalking: fix table header, sort order, host default, classic key casing Mar 16, 2026
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 87e01cf and 2087bb2.

📒 Files selected for processing (1)
  • pipeline/outputs/skywalking.md

Comment on lines +51 to +52
Svc_name dummy-service
Svc_inst_name dummy-service-fluentbit
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants