Skip to content

monitoring: use v2 APIs in examples where they are equivalent#2538

Merged
eschabell merged 1 commit intofluent:masterfrom
b1-systems:use-v2-urls-in-monitoring-examples
Apr 7, 2026
Merged

monitoring: use v2 APIs in examples where they are equivalent#2538
eschabell merged 1 commit intofluent:masterfrom
b1-systems:use-v2-urls-in-monitoring-examples

Conversation

@lilioid
Copy link
Copy Markdown
Contributor

@lilioid lilioid commented Apr 7, 2026

The monitoring documentation used /api/v1/ routes in examples without it being clear why they were used instead of equivalent /api/v2/ routes. This commit changes that so that the new /api/v2/ routes are documented appropriately.

Summary by CodeRabbit

  • Documentation
    • Updated monitoring documentation examples to reflect v2 API endpoints for Prometheus metrics collection and health endpoint monitoring.

@lilioid lilioid requested review from a team and eschabell as code owners April 7, 2026 16:35
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 7, 2026

📝 Walkthrough

Walkthrough

Documentation examples in administration/monitoring.md updated to reference v2 API routes. HTTP curl command examples changed from /api/v1/metrics/prometheus and /api/v1/health to their v2 counterparts (/api/v2/metrics/prometheus and /api/v2/health). Surrounding descriptions and endpoint tables remain unchanged.

Changes

Cohort / File(s) Summary
API Documentation Examples
administration/monitoring.md
Updated curl command examples to use v2 health and metrics API routes (/api/v2/health, /api/v2/metrics/prometheus) instead of v1 equivalents.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Poem

🐰 From v1 paths we hop away,
To v2 routes, hip hooray!
Metrics shine, health checks gleam,
Documentation's now supreme! ✨

🚥 Pre-merge checks | ✅ 3
✅ 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 'monitoring: use v2 APIs in examples where they are equivalent' clearly and concisely describes the main change: updating monitoring documentation examples to use v2 API routes instead of v1 routes.
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

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.

The monitoring documentation used /api/v1/ routes in examples without
it being clear why they were used instead of equivalent /api/v2/ routes.
This commit changes that so that the new /api/v2/ routes are documented
appropriately.

Signed-off-by: Lilly Sell <sell@b1-systems.de>
@lilioid lilioid force-pushed the use-v2-urls-in-monitoring-examples branch from 8c43058 to e8c392b Compare April 7, 2026 16:35
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@administration/monitoring.md`:
- Line 560: Update the /api/v2/health example to explicitly state the response
is JSON and show the key fields; mention that a successful response returns a
JSON object with a "status" field (values "ok" or "error") and additional health
counters (e.g., metrics/timestamps), so readers know the curl call to
/api/v2/health returns JSON like {"status":"ok", ...}.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 709eca4b-68b8-46e3-8411-fb4c6d766e6a

📥 Commits

Reviewing files that changed from the base of the PR and between 3da2d5f and e8c392b.

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

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.

@lilioid good catch and thanks for the PR!

@eschabell eschabell merged commit 3cac0d1 into fluent:master Apr 7, 2026
8 checks passed
@eschabell eschabell self-assigned this Apr 7, 2026
@eschabell eschabell added the 5.0.3 label Apr 7, 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.

2 participants