Skip to content

docs: outputs: http: general updates and fixes, added missing config parameters#2434

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

docs: outputs: http: general updates and fixes, added missing config parameters#2434
eschabell wants to merge 1 commit intofluent:masterfrom
eschabell:erics_out_http_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 17, 2026

  • Add 16 missing oauth2.* parameters sourced from plugin config_map
  • Fix json_date_format default: "double" -> none
  • Fix uri default: "/" -> none
  • Fix config param table column alignment
  • Remove redundant intro sentence
  • Fix trailing space in aws_service description
  • Fix classic config example case issues
  • Use "OAuth 2.0" per style guide in all oauth2 parameter descriptions
  • Spell out JWT (JSON Web Token) on first use per style guide

Applies to #2412

Summary by CodeRabbit

  • Documentation
    • Updated HTTP output configuration documentation with improved table formatting and enhanced example clarity.
    • Expanded documentation to include OAuth 2.0 authentication configuration options and parameters.

…parameters

  - Add 16 missing oauth2.* parameters sourced from plugin config_map
  - Fix json_date_format default: "double" -> _none_
  - Fix uri default: "/" -> _none_
  - Fix config param table column alignment
  - Remove redundant intro sentence
  - Fix trailing space in aws_service description
  - Fix classic config example case issues
  - Use "OAuth 2.0" per style guide in all oauth2 parameter descriptions
  - Spell out JWT (JSON Web Token) on first use per style guide

  Applies to fluent#2412

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 17, 2026
@eschabell eschabell requested a review from a team as a code owner March 17, 2026 09:12
@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

📝 Walkthrough

Walkthrough

Documentation update to HTTP output configuration guide with table formatting adjustments, configuration key naming refinements (URI/Uri, header_tag/Header_tag), and expanded OAuth 2.0 parameter documentation. No functional code changes.

Changes

Cohort / File(s) Summary
HTTP Output Configuration Docs
pipeline/outputs/http.md
Table header formatting and alignment adjustments; configuration key naming updates in examples; parameter description refinements; addition of OAuth 2.0 configuration options (oauth2.* keys) with defaults.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 A hop through docs, so neat and bright,
OAuth keys now shine in light,
Headers aligned, formatting true,
HTTP wisdom, refreshed and new! 📝✨

🚥 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 accurately summarizes the main changes: documentation updates and fixes to HTTP output configuration, including addition of missing OAuth 2.0 config parameters and correction of default values.
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.

🧹 Nitpick comments (1)
pipeline/outputs/http.md (1)

150-152: Optional: fully normalize URI casing across this page.

These updates switch to Uri, but the earlier classic snippet still uses URI at Line 113. Consider normalizing that remaining instance for full intra-page consistency.

Based on learnings: classic fluent-bit.conf examples intentionally use Title_Case plugin-specific keys.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pipeline/outputs/http.md` around lines 150 - 152, Update the remaining
classic fluent-bit.conf snippet to use the same Title_Case key name "Uri"
(replace the lone "URI" instance) so the page consistently uses "Uri" across
both the newer and classic examples; ensure you only change the casing of the
key (retain plugin-specific Title_Case convention and surrounding config text)
in the snippet that currently shows "URI".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@pipeline/outputs/http.md`:
- Around line 150-152: Update the remaining classic fluent-bit.conf snippet to
use the same Title_Case key name "Uri" (replace the lone "URI" instance) so the
page consistently uses "Uri" across both the newer and classic examples; ensure
you only change the casing of the key (retain plugin-specific Title_Case
convention and surrounding config text) in the snippet that currently shows
"URI".

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fa12c0a3-d8a3-49b8-89ec-8f9b4f70d2b8

📥 Commits

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

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

@eschabell
Copy link
Collaborator Author

@cosmo0920 and @patrick-stephens ready for review!

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.

1 participant