Skip to content

docs: outputs: gelf: general doc updates and cleanup#2433

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

docs: outputs: gelf: general doc updates and cleanup#2433
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_gelf_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 17, 2026

  • Lowercase all config parameter Key column entries
  • Fix incorrect default listings in config parameter table
  • Sort configuration parameters table alphabetically
  • Fix config parameter table column alignment
  • Remove trailing spaces on gelf_full_message_key row
  • Fix missing space in mode description: "Allowed values:tls" -> "Allowed values: tls"

Applies to #2412

Summary by CodeRabbit

Documentation

  • Standardized GELF configuration keys to consistent snake_case naming format
  • Updated configuration reference table with improved formatting and aligned descriptions

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

coderabbitai bot commented Mar 17, 2026

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 11 minutes and 7 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3d120525-a2a7-4475-87b3-4fa13d54e83d

📥 Commits

Reviewing files that changed from the base of the PR and between 8fbf75b and 8f33219.

📒 Files selected for processing (1)
  • pipeline/outputs/gelf.md
📝 Walkthrough

Walkthrough

Documentation update to the GELF configuration guide: configuration table keys renamed from mixed case (e.g., Gelf_*Key, Packet_Size) to lowercase snake_case format, with a new header row introduced to the table structure.

Changes

Cohort / File(s) Summary
GELF Configuration Documentation
pipeline/outputs/gelf.md
Configuration table keys refactored from mixed case to lowercase snake_case (e.g., Gelf_HostKeygelf_host_key, Packet_Sizepacket_size). New header row added to table; default/description values updated accordingly.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Hop, hop—the keys now dance in snake,
No more camelCase to take,
Documentation clean and bright,
GELF configuration set just right!

🚥 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 'docs: outputs: gelf: general doc updates and cleanup' directly matches the pull request's scope, which involves documentation updates to the GELF configuration table including parameter renaming, default value fixes, alphabetical sorting, column alignment, and minor formatting corrections.
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.

@eschabell
Copy link
Collaborator Author

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 17, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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/gelf.md`:
- Line 19: The table entry for `gelf_timestamp_key` contains a sentence
fragment; update the description to be a complete sentence (for example: "Your
log timestamp. This should be set in GELF.") so the second clause has a subject
and reads as a full sentence; edit the `gelf_timestamp_key` row in
pipeline/outputs/gelf.md to replace "Should be set in GELF." with a complete
sentence like the suggested phrasing.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6e41fe8a-d553-434c-948a-dbf02d754c21

📥 Commits

Reviewing files that changed from the base of the PR and between 9691fb1 and 8fbf75b.

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

  - Lowercase all config parameter Key column entries
  - Fix incorrect default listings in config parameter table
  - Sort configuration parameters table alphabetically
  - Fix config parameter table column alignment
  - Remove trailing spaces on gelf_full_message_key row
  - Fix missing space in mode description: "Allowed values:`tls`" -> "Allowed values: `tls`"
  - Fix `gelf_timestamp_key` description: "Should be set in GELF." → "This should be set in GELF."

  Applies to fluent#2412

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_out_gelf_updates branch from 8fbf75b to 8f33219 Compare March 17, 2026 09:59
@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

@eschabell eschabell merged commit dd906a6 into fluent:master Mar 18, 2026
8 checks passed
@eschabell eschabell deleted the erics_out_gelf_updates branch March 18, 2026 11:14
@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