Skip to content

docs: outputs: opentelemetry: add OAuth2 client credentials and worke…#2489

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_opentelemetry_fixes
Mar 20, 2026
Merged

docs: outputs: opentelemetry: add OAuth2 client credentials and worke…#2489
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_out_opentelemetry_fixes

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 19, 2026

Add 16 oauth2.* configuration parameters introduced by the out_opentelemetry OAuth2 client credentials support:

  • oauth2.enable: enable OAuth2 client credentials flow
  • oauth2.token_url: token endpoint URL
  • oauth2.client_id / oauth2.client_secret: client credentials
  • oauth2.scope / oauth2.audience / oauth2.resource: optional parameters
  • oauth2.auth_method: basic, post, or private_key_jwt (default: basic)
  • oauth2.jwt_key_file / oauth2.jwt_cert_file: private_key_jwt key material
  • oauth2.jwt_aud / oauth2.jwt_header / oauth2.jwt_ttl_seconds: JWT options
  • oauth2.refresh_skew_seconds: token refresh lead time (default: 60)
  • oauth2.timeout / oauth2.connect_timeout: token request timeouts

Also add the missing workers parameter (default: 0) which is supported by all outputs via the framework but was undocumented here.

Fixes #2484

Summary by CodeRabbit

  • Documentation
    • Added OAuth 2.0 authentication configuration options for the OpenTelemetry output plugin, including token management, client credentials, JWT settings, and authentication methods.
    • Added workers configuration parameter to control the number of workers used for flush operations.

…rs options

  Add 16 oauth2.* configuration parameters introduced by the
  out_opentelemetry OAuth2 client credentials support:

  - oauth2.enable: enable OAuth2 client credentials flow
  - oauth2.token_url: token endpoint URL
  - oauth2.client_id / oauth2.client_secret: client credentials
  - oauth2.scope / oauth2.audience / oauth2.resource: optional parameters
  - oauth2.auth_method: basic, post, or private_key_jwt (default: basic)
  - oauth2.jwt_key_file / oauth2.jwt_cert_file: private_key_jwt key material
  - oauth2.jwt_aud / oauth2.jwt_header / oauth2.jwt_ttl_seconds: JWT options
  - oauth2.refresh_skew_seconds: token refresh lead time (default: 60)
  - oauth2.timeout / oauth2.connect_timeout: token request timeouts

  Also add the missing workers parameter (default: 0) which is supported
  by all outputs via the framework but was undocumented here.

  Fixes fluent#2484

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Mar 19, 2026
@eschabell eschabell requested a review from a team as a code owner March 19, 2026 18:58
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0 labels Mar 19, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 19, 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: b75c995b-d127-4787-91fb-83060a9b1bc4

📥 Commits

Reviewing files that changed from the base of the PR and between 21b6f3c and bd7bfbd.

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

📝 Walkthrough

Walkthrough

Documentation update to the OpenTelemetry output plugin that adds a comprehensive OAuth 2.0 client credentials configuration section mirroring the HTTP output plugin, along with a new workers parameter for controlling flush operation concurrency.

Changes

Cohort / File(s) Summary
OpenTelemetry Output Documentation
pipeline/outputs/opentelemetry.md
Added OAuth 2.0 client credentials config keys (enable, token_url, client credentials, authentication method, JWT fields, timeouts, scope, audience, resource, refresh skew) and workers configuration entry.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 Oauth blooms in telemetry's field,
Workers now control the yield,
Configuration keys all set,
Security tokens, no regret!
Documentation shines so bright,
OpenTelemetry reaches new height!

🚥 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 accurately summarizes the main changes: adding OAuth2 client credentials documentation and the workers parameter to the OpenTelemetry output plugin documentation.
Linked Issues check ✅ Passed The PR successfully documents all 16 OAuth2 parameters and the workers parameter as required by issue #2484, providing complete coverage of the requested configuration keys and defaults.
Out of Scope Changes check ✅ Passed All changes are within scope—the PR updates only the OpenTelemetry output documentation to add OAuth2 and workers configuration parameters as specified in issue #2484, with no extraneous modifications.
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

@patrick-stephens and @cosmo0920 ready for review!

@eschabell eschabell merged commit 18121f1 into fluent:master Mar 20, 2026
8 checks passed
@eschabell eschabell deleted the erics_out_opentelemetry_fixes branch March 20, 2026 18:31
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 20, 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.

docs: outputs: opentelemetry: oauth2 doc section update needed

2 participants