Updated for new api endpoints and missing config options for vivo exporter output plugin docs. Fixes #2217.

[eschabell]

Updated for new api endpoints and missing config options for vivo exporter output plugin docs. Fixes #2217.

Summary by CodeRabbit

• New Features

  • Added configurable host and port parameters for HTTP server binding
  • New /api/v1/internal/metrics API endpoint available

• Documentation

  • Updated API endpoints to consolidated v1 routes (/api/v1/logs, /api/v1/metrics, /api/v1/traces)
  • Added documentation for log output formats with group metadata support

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

[coderabbitai]

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 13 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4083400 and 3886c97.

📒 Files selected for processing (1)

• pipeline/outputs/vivo-exporter.md (7 hunks)

Walkthrough

Documentation for the Vivo exporter was updated to reflect new API endpoints under /api/v1/ prefix, introduce configuration parameters for host and port binding, and document output formats for OTLP and grouped log data.

Changes

Cohort / File(s)	Change Summary
Vivo exporter documentation pipeline/outputs/vivo-exporter.md	Added host and port configuration parameters; updated all endpoint references from /logs, /metrics, /traces to /api/v1/logs, /api/v1/metrics, /api/v1/traces; added /api/v1/internal/metrics endpoint; updated curl command examples to target new API paths; introduced "Log output format with groups" section describing OTLP and flb_group field output structures with metadata

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify all endpoint path changes are consistent and correctly prefixed with /api/v1/
• Confirm new "Log output format with groups" JSON structure examples are accurate and match implementation

Poem

🐰 Hops through the docs with glee,
New paths unveiled, so structured and free,
/api/v1 blooms where old routes used to be,
Groups and formats, a joy to see! ✨

Pre-merge checks and finishing touches

✅ 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 clearly summarizes the main changes: updating documentation for new API endpoints and adding missing configuration options for the vivo exporter.
Linked Issues check	✅ Passed	The pull request addresses the requirements from issue #2217 by updating API endpoints to /api/v1/ paths and documenting group support functionality.
Out of Scope Changes check	✅ Passed	All changes are documentation updates directly related to the vivo exporter's new API endpoints and configuration options specified in issue #2217.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

pipeline/outputs/vivo-exporter.md (2)

12-12: New configuration parameters added, but usage examples would improve clarity.

The new host and port parameters are documented with defaults, but the "Get started" configuration examples (lines 25–38, 43–55) don't demonstrate these parameters. While defaults may be suitable for most users, adding at least one example showing how to override the host/port binding would help users understand when and how to use these settings.

Consider adding a configuration snippet that explicitly sets host and port to make the feature more discoverable.

Also applies to: 14-15

---

184-216: The new groups section lacks clarity on triggering conditions and usage.

The "Log output format with groups" section introduces the JSON structure for OTLP and non-OTLP grouped output, but important context is missing:

1. Unclear triggering conditions: There is no explanation of what configuration or conditions cause the otlp or flb_group fields to appear in the output. Is this automatic based on input type? Is a configuration option required?

2. No configuration or invocation examples: The section shows hypothetical JSON structures but doesn't explain how to actually produce this output (e.g., no curl examples or configuration snippets showing group setup).

3. Vague terminology: The phrase "group metadata or attributes" is not defined in relation to Fluent Bit concepts.

To align with the PR objective of "adding support for groups," please clarify:

• Under what conditions groups appear in the output
• Any new configuration options needed to enable group support
• At least one curl example demonstrating grouped output retrieval

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 86e267a and 4083400.

📒 Files selected for processing (1)

• pipeline/outputs/vivo-exporter.md (5 hunks)

🔇 Additional comments (1)

pipeline/outputs/vivo-exporter.md (1)

70-75: API endpoint updates are clear and consistent.

The endpoint table has been properly updated to reflect the new /api/v1/ prefix, and the curl examples throughout the document (lines 116 and 165) are consistently updated. The addition of the /api/v1/internal/metrics endpoint is well-documented.

[eschabell]

AI review passed, merging.

[eschabell]

@esmerel would you mind a post merge PR review here?