Skip to content

docs: inputs: http: document enable_health_endpoint parameter#2548

Merged
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_in_http_updates
Apr 23, 2026
Merged

docs: inputs: http: document enable_health_endpoint parameter#2548
eschabell merged 1 commit intofluent:masterfrom
eschabell:erics_in_http_updates

Conversation

@eschabell
Copy link
Copy Markdown
Collaborator

@eschabell eschabell commented Apr 19, 2026

  • add enable_health_endpoint configuration parameter to table
  • fix vale directional language suggestion

Applies to code fix in 5.0.3 with no doc PR.

Summary by CodeRabbit

  • New Features

    • Added optional enable_health_endpoint configuration parameter for HTTP input, enabling a GET /health endpoint that returns JSON with status and timestamp (default: disabled).
  • Documentation

    • Updated HTTP input configuration documentation.

  - add enable_health_endpoint configuration parameter to table
  - fix vale directional language suggestion

  Applies to code fix in 5.0.3 with no doc PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Apr 19, 2026
@eschabell eschabell requested a review from a team as a code owner April 19, 2026 19:51
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 19, 2026

📝 Walkthrough

Walkthrough

Updated HTTP input documentation by revising wording in the configuration parameters section and introducing a new enable_health_endpoint parameter that documents an optional health check endpoint returning status and timestamp information with a default value of false.

Changes

Cohort / File(s) Summary
HTTP Input Documentation
pipeline/inputs/http.md
Minor wording adjustment to section header and addition of enable_health_endpoint configuration parameter documentation describing an optional GET /health endpoint.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested labels

5.0

Suggested reviewers

  • patrick-stephens

Poem

🐰 A health check endpoint hops into view,
With status and timestamps, shiny and new,
Documented with care, so clear and so bright,
The HTTP input takes flight! ✨

🚥 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 clearly and specifically describes the main change: documenting the enable_health_endpoint parameter in HTTP input 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.

✨ 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.

@eschabell eschabell added the waiting-on-review Waiting on a review from mainteners label Apr 19, 2026
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.

🧹 Nitpick comments (1)
pipeline/inputs/http.md (1)

25-25: Consider adding version availability for this new parameter.

Since this documents a 5.0.3 fix, adding an “Available in 5.0.3+” note in the description would reduce ambiguity for users on earlier versions.

Proposed doc tweak
-| `enable_health_endpoint`   | Enable a `GET /health` endpoint for this input instance. When enabled, the endpoint returns a JSON response with `status` and `timestamp` fields.   | `false`   |
+| `enable_health_endpoint`   | Enable a `GET /health` endpoint for this input instance. When enabled, the endpoint returns a JSON response with `status` and `timestamp` fields. Available in Fluent Bit `5.0.3+`. | `false`   |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pipeline/inputs/http.md` at line 25, The docs entry for the parameter
`enable_health_endpoint` lacks version availability; update its description to
append a short availability note such as "Available in 5.0.3+" (or equivalent)
so users know this flag was introduced in 5.0.3; locate the
`enable_health_endpoint` table row in pipeline/inputs/http.md and modify the
description cell to include the "Available in 5.0.3+" text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@pipeline/inputs/http.md`:
- Line 25: The docs entry for the parameter `enable_health_endpoint` lacks
version availability; update its description to append a short availability note
such as "Available in 5.0.3+" (or equivalent) so users know this flag was
introduced in 5.0.3; locate the `enable_health_endpoint` table row in
pipeline/inputs/http.md and modify the description cell to include the
"Available in 5.0.3+" text.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2575c60d-8d8c-47a5-bf7b-2d7dba32b038

📥 Commits

Reviewing files that changed from the base of the PR and between 343903f and 0f0776f.

📒 Files selected for processing (1)
  • pipeline/inputs/http.md

@eschabell
Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@eschabell
Copy link
Copy Markdown
Collaborator Author

Merging on AI review.

@eschabell eschabell merged commit 3b7dcab into fluent:master Apr 23, 2026
8 checks passed
@eschabell eschabell deleted the erics_in_http_updates branch April 23, 2026 06:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

5.0.3 waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant