Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Jan 22, 2026

  • Add missing parameters: bearer_token, buffer_max_size, http_passwd, http_user
  • Fix host default: none -> localhost
  • Fix port default: none -> 9100
  • Sort configuration table alphabetically
  • Add TLS configuration section with link to transport security docs

Fixes #2336.

Summary by CodeRabbit

  • Documentation

    • Expanded Prometheus configuration documentation with comprehensive authentication methods (bearer tokens, HTTP credentials), TLS configuration guidance, enhanced configuration parameters with updated defaults, buffer management settings, and detailed usage examples.
  • Chores

    • Updated repository configuration.

✏️ Tip: You can customize this high-level summary in your review settings.

  - Add missing parameters: bearer_token, buffer_max_size, http_passwd, http_user
  - Fix host default: _none_ -> localhost
  - Fix port default: _none_ -> 9100
  - Sort configuration table alphabetically
  - Add TLS configuration section with link to transport security docs

Fixes fluent#2336.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Jan 22, 2026
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 4.2.3 labels Jan 22, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 22, 2026

📝 Walkthrough

Walkthrough

This PR updates the Prometheus scrape metrics input plugin documentation to include missing configuration parameters and correct default values, while also adding CLAUDE.md to the .gitignore file.

Changes

Cohort / File(s) Summary
Configuration & Meta Files
\.gitignore
Added CLAUDE.md to ignored files list
Documentation Updates
pipeline/inputs/prometheus-scrape-metrics\.md
Expanded configuration documentation with authentication keys (bearer_token, http_user, http_passwd), buffer_max_size parameter, corrected defaults (host: localhost, port: 9100), added TLS configuration section and guidance, replaced compact table with descriptive configuration table, and added usage example with vault endpoint

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • cosmo0920

Poem

🐰 A hop, a skip, and docs refined,
With configs now so well-aligned,
We've tidied CLAUDE away,
And Prometheus shines bright today,
With parameters and defaults in line!

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The addition of CLAUDE.md to .gitignore appears unrelated to the Prometheus scrape documentation updates and may be an incidental or out-of-scope change. Remove the CLAUDE.md .gitignore entry unless it is essential to this PR, or clarify its relationship to the documentation updates in the PR description.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: fixing configuration parameters and adding missing options for the Prometheus scrape input plugin documentation.
Linked Issues check ✅ Passed The PR successfully addresses all coding objectives from issue #2336: adds missing parameters (bearer_token, buffer_max_size, http_passwd, http_user), fixes defaults (host to localhost, port to 9100), and adds TLS documentation.
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.


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 eschabell merged commit 9010d0f into fluent:master Jan 22, 2026
8 checks passed
@eschabell eschabell deleted the erics_in_prom_scrape_updates branch January 22, 2026 13:29
@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Jan 22, 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.

Prometheus scrape metrics input plugin doc need cleanup.

2 participants