Skip to content

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

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_skywalking_updates
Mar 18, 2026
Merged

docs: outputs: skywalking: fix table header, sort order, host default, classic key casing#2424
eschabell merged 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
    • Changed parameter table header from "Parameter" to "Key" and clarified default value presentation.
    • Added a new auth_token option to the documented settings.
    • Reordered parameters so host and port appear before service name fields.
    • Updated sample configuration keys to CamelCase (Svc_Name, Svc_Inst_Name) and adjusted default values formatting.

@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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5a251a34-b5d2-4eee-aab3-7aac08432b1a

📥 Commits

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

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

📝 Walkthrough

Walkthrough

Documentation for the Apache SkyWalking output was updated: table header changed to "Key", an auth_token entry was added, defaults and ordering for host/port were normalized and reformatted, and example configuration keys were converted to CamelCase (svc_nameSvc_Name, svc_inst_nameSvc_Inst_Name).

Changes

Cohort / File(s) Summary
Documentation
pipeline/outputs/skywalking.md
Updated parameter table header to "Key", added auth_token, reformatted defaults (backticks) and reordered rows (host/port moved up), and changed example config keys to CamelCase (svc_nameSvc_Name, svc_inst_nameSvc_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 tiny tweak that softly shows,
Joyful 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 PR title clearly and specifically summarizes the main changes: documentation updates to the SkyWalking output plugin including table header fix, parameter sorting, host default correction, and key casing updates.
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
📝 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

You can disable sequence diagrams in the walkthrough.

Disable the reviews.sequence_diagrams setting to disable sequence diagrams in the walkthrough.

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

@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

@eschabell
Copy link
Collaborator Author

eschabell commented Mar 18, 2026

@patrick-stephens fixing the issue, 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
  - Fix classic config key casing to Title_Case

  Applies to fluent#2412

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_out_skywalking_updates branch from 2087bb2 to fd9dcb6 Compare March 18, 2026 11:40
@eschabell eschabell merged commit 5ef031d into fluent:master Mar 18, 2026
8 checks passed
@eschabell eschabell deleted the erics_out_skywalking_updates branch March 18, 2026 13:07
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants