Skip to content

docs: administration: monitoring: fix fluentbit_hot_reloaded_times metric type and unit#2492

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

docs: administration: monitoring: fix fluentbit_hot_reloaded_times metric type and unit#2492
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_admin_monitoring_updates

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Mar 19, 2026

  • Fix fluentbit_hot_reloaded_times metric type from gauge to counter in the first Prometheus metrics table (reflects source change from cmt_gauge_create to cmt_counter_create in src/flb_metrics.c)
  • Fix fluentbit_hot_reloaded_times unit from seconds to times in the second metrics table
  • Add /api/v2/health endpoint to the HTTP API endpoints table
  • Update /api/v2/reload entry to document 405 Method Not Allowed response with Allow: GET, POST, PUT header for unsupported methods

Fixes #2488

Summary by CodeRabbit

  • Documentation
    • Clarified REST API monitoring endpoints for /api/v2 health checks and reload operations with HTTP response codes and headers
    • Corrected Prometheus metrics definitions to accurately reflect metric types and units for monitoring

@eschabell eschabell self-assigned this Mar 19, 2026
@eschabell eschabell requested a review from a team as a code owner March 19, 2026 19:25
@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: 1c0c8ea5-e452-4997-9ab7-10989213575d

📥 Commits

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

📒 Files selected for processing (1)
  • administration/monitoring.md

📝 Walkthrough

Walkthrough

Documentation updates to the REST API monitoring table and Prometheus metrics definitions in administration/monitoring.md. Added /api/v2/health endpoint documentation, clarified /api/v2/reload HTTP method support and 405 error behavior, and corrected the fluentbit_hot_reloaded_times metric type from gauge to counter with unit corrected from seconds to times.

Changes

Cohort / File(s) Summary
Documentation Updates
administration/monitoring.md
Added /api/v2/health endpoint entry with JSON response fields and HTTP 200/500 semantics; expanded /api/v2/reload with supported methods (GET, POST, PUT) and 405 Method Not Allowed behavior; corrected fluentbit_hot_reloaded_times Prometheus metric type from gauge to counter and unit from seconds to times.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • cosmo0920
  • patrick-stephens

Poem

🐰 A rabbit hops through docs so fine,
Metrics gleam and endpoints align,
Health checks flow with counters true,
405 errors bid adieu—
Clarity counts in every line! 📝

🚥 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 matches the main changes: fixing fluentbit_hot_reloaded_times metric type and unit corrections in monitoring documentation.
Linked Issues check ✅ Passed All three coding requirements from issue #2488 are addressed: /api/v2/health endpoint added, fluentbit_hot_reloaded_times type changed from gauge to counter, unit corrected from seconds to times, and /api/v2/reload 405 behavior documented.
Out of Scope Changes check ✅ Passed All changes in the pull request directly align with requirements in linked issue #2488; no out-of-scope modifications were introduced.
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.

…tric type and unit

  - Fix `fluentbit_hot_reloaded_times` metric type from `gauge` to `counter`
    in the first Prometheus metrics table (reflects source change)
  - Fix `fluentbit_hot_reloaded_times` unit from `seconds` to `times`
    in the second metrics table
  - Add `/api/v2/health` endpoint to the HTTP API endpoints table
  - Update `/api/v2/reload` entry to document `405 Method Not Allowed`
    response with `Allow: GET, POST, PUT` header for unsupported methods

  Fixes fluent#2488

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_admin_monitoring_updates branch from 09c321b to f3f3736 Compare March 19, 2026 20:36
@eschabell
Copy link
Collaborator Author

@patrick-stephens and @cosmo0920 ready for review!

@eschabell eschabell removed the waiting-on-review Waiting on a review from mainteners label Mar 20, 2026
@eschabell eschabell merged commit 4bdc287 into fluent:master Mar 20, 2026
8 checks passed
@eschabell eschabell deleted the erics_admin_monitoring_updates branch March 20, 2026 18:35
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: administration: monitoring: general doc updates needed

2 participants