Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Dec 9, 2025

  • Add missing scrape_interval parameter (default: 5s)
  • Add TLS/SSL configuration section
  • Add info hint about metrics pipeline separation
  • Alphabetize and lowercase config parameter names
  • Fix NGINX config comment syntax (// → #)
  • Standardize indentation to 2 spaces in .conf examples
  • Minor style improvements for consistency with other input docs

Summary by CodeRabbit

  • Documentation
    • Updated NGINX metrics input documentation with standardized configuration parameter naming conventions.
    • Added new configuration sections for TLS/SSL and scrape interval settings.
    • Enhanced example configurations and improved clarity in setup instructions.

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

- Add missing scrape_interval parameter (default: 5s)
- Add TLS/SSL configuration section
- Add info hint about metrics pipeline separation
- Alphabetize and lowercase config parameter names
- Fix NGINX config comment syntax (// → #)
- Standardize indentation to 2 spaces in .conf examples
- Minor style improvements for consistency with other input docs

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Dec 9, 2025
@eschabell eschabell requested review from a team as code owners December 9, 2025 17:52
@eschabell eschabell added the 4.2.1 label Dec 9, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 9, 2025

Walkthrough

This PR updates the NGINX metrics input documentation, renaming configuration keys from camelCase to lowercase with underscores (Host→host, Port→port, Status_URL→status_url, Nginx_Plus→nginx_plus, Threaded→threaded), adding new keys like scrape_interval and status_url, introducing a TLS/SSL section, and revising examples and descriptions for consistency.

Changes

Cohort / File(s) Summary
NGINX Input Documentation
pipeline/inputs/nginx.md
Renamed configuration keys to lowercase with underscores; added scrape_interval and TLS/SSL section; updated YAML/CONF examples and command snippets to reflect new parameter names; improved descriptive text and example captions for clarity

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify configuration key naming consistency across all code examples and descriptions
  • Confirm all YAML/CONF snippets accurately reflect the new key names
  • Validate that the TLS/SSL section guidance is complete and accurate

Poem

🐰 Keys renamed, underscores flow,
Configuration docs now glow,
NGINX settings, clear and bright,
Documentation set just right!

Pre-merge checks and finishing touches

✅ 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 clearly and specifically describes the main change: updating NGINX exporter metrics documentation, matching the pull request's primary objectives of adding parameters, configuration sections, and improving documentation consistency.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e254c1b and 9bcec79.

📒 Files selected for processing (1)
  • pipeline/inputs/nginx.md (9 hunks)
🔇 Additional comments (1)
pipeline/inputs/nginx.md (1)

5-9: Well-executed documentation update across all segments.

The documentation changes comprehensively address all stated PR objectives:

  • Info hint (lines 5–9): Clear explanation of metrics pipeline separation with appropriate formatting.
  • Configuration table (lines 15–22): Parameters correctly alphabetized (host, nginx_plus, port, scrape_interval, status_url, threaded), using lowercase with underscores, with complete descriptions and defaults.
  • TLS/SSL section (lines 24–26): Concise section with appropriate reference to transport security documentation.
  • Comment syntax (lines 41, 58–62): NGINX config comments correctly changed from // to #.
  • YAML examples (lines 88–104, 132–144): Properly use lowercase snake_case parameter names (host, port, status_url, nginx_plus, scrape_interval).
  • CONF examples (lines 110–121, 150–161): Correctly maintain PascalCase for CONF format (Host, Port, Status_URL, Nginx_Plus, Scrape_Interval), which is the standard Fluent Bit convention.
  • Indentation: Consistently standardized to 2 spaces across all code blocks.
  • scrape_interval parameter: Properly added with default value of 5s and clear description.

All examples remain functionally consistent and the parameter naming conventions are correctly differentiated by format (YAML vs. CONF). Minor text refinements enhance clarity.

Also applies to: 15-26, 30-46, 52-67, 74-82, 88-164, 174-174


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

AI review accepted, merging.

@eschabell eschabell merged commit ef0fa03 into fluent:master Dec 9, 2025
8 checks passed
@eschabell eschabell deleted the erics_in_nginx_updates branch December 10, 2025 12:58
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.

1 participant