Skip to content

docs: document oauth2.user_agent for OAuth2 token requests#2578

Open
rja5 wants to merge 2 commits into
fluent:masterfrom
rja5:add-oauth2-user-agent-docs
Open

docs: document oauth2.user_agent for OAuth2 token requests#2578
rja5 wants to merge 2 commits into
fluent:masterfrom
rja5:add-oauth2-user-agent-docs

Conversation

@rja5
Copy link
Copy Markdown

@rja5 rja5 commented May 20, 2026

Add oauth2.user_agent documentation for outgoing OAuth 2.0 token requests.

Summary by CodeRabbit

  • Documentation
    • Added docs for the oauth2.user_agent option so HTTP and OpenTelemetry outputs can include an optional User-Agent header on OAuth 2.0 token requests.
    • Clarified that omitting or setting the option to _none_ results in no User-Agent header being sent.
    • Updated pipeline docs to describe this shared oauth2.user_agent behavior.

Review Change Stack

@rja5 rja5 requested review from a team and eschabell as code owners May 20, 2026 21:13
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 20, 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: a560a55d-8929-41bd-894e-7a53ff862764

📥 Commits

Reviewing files that changed from the base of the PR and between c13fbe8 and ee7d0eb.

📒 Files selected for processing (1)
  • administration/configuring-fluent-bit/yaml/pipeline-section.md
✅ Files skipped from review due to trivial changes (1)
  • administration/configuring-fluent-bit/yaml/pipeline-section.md

📝 Walkthrough

Walkthrough

Adds documentation for a new oauth2.user_agent option that controls an optional User-Agent header sent with OAuth 2.0 client-credentials token requests; updates the pipeline overview, HTTP output, and OpenTelemetry output docs.

Changes

OAuth 2.0 User-Agent Option Documentation

Layer / File(s) Summary
OAuth 2.0 user agent option across output plugins
administration/configuring-fluent-bit/yaml/pipeline-section.md, pipeline/outputs/http.md, pipeline/outputs/opentelemetry.md
Adds the oauth2.user_agent documentation row to the pipeline outputs table and documents the option in the HTTP and OpenTelemetry output guides, describing when a User-Agent header is included in OAuth 2.0 token requests.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

5.0

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 I nibble lines and tidy docs with care,
A User-Agent now hums on token calls there,
Pipeline, HTTP, Telemetry all in a row,
A tiny header, optional and low,
I hop to the commit and give it a glow.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and clearly describes the main change: documenting the oauth2.user_agent configuration option for OAuth 2.0 token requests, which aligns with all three file modifications in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Signed-off-by: rja5 <rallen99@gmail.com>
@rja5 rja5 force-pushed the add-oauth2-user-agent-docs branch from 23ce2ca to c13fbe8 Compare May 21, 2026 04:25
@eschabell eschabell self-assigned this May 22, 2026
Copy link
Copy Markdown
Collaborator

@eschabell eschabell left a comment

Choose a reason for hiding this comment

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

@rja5 one back-tick fix for a vale issue and it's good to go, please fix.

| `oauth2.refresh_skew_seconds` | Seconds before expiry at which to refresh the access token. | `60` |
| `oauth2.timeout` | Timeout for token requests. | `0s` |
| `oauth2.connect_timeout` | Connect timeout for token requests. | `0s` |
| `oauth2.user_agent` | Optional `User-Agent` header to include on OAuth 2.0 token requests. | _none_ |
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@rja5 use back-ticks around the OAuth 2.0 to fix this vale issue.

@eschabell eschabell added waiting-for-user Waiting for user/contributors feedback or requested changes waiting-on-review Waiting on a review from mainteners labels May 22, 2026
@eschabell eschabell added the dco DCO failing label May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco DCO failing waiting-for-user Waiting for user/contributors feedback or requested changes waiting-on-code-merge waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants