Skip to content

Commit 3b7dcab

Browse files
authored
docs: inputs: http: document enable_health_endpoint parameter (#2548)
- 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>
1 parent 4f5e12f commit 3b7dcab

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

pipeline/inputs/http.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The _HTTP_ input plugin lets Fluent Bit open an HTTP port that you can then rout
99

1010
## Configuration parameters
1111

12-
The table below includes both:
12+
The following table includes both:
1313

1414
- settings specific to the HTTP input plugin
1515
- shared `http_server.*` listener settings that are used by several HTTP-based inputs
@@ -22,6 +22,7 @@ For a cross-plugin explanation of the shared listener settings, see
2222
| `add_remote_addr` | Adds a `REMOTE_ADDR` field to the record. The value of `REMOTE_ADDR` is the client's address, which is extracted from the `X-Forwarded-For` header. | `false` |
2323
| `buffer_chunk_size` | This sets the chunk size for incoming JSON messages. These chunks are then stored and managed in the space available by `buffer_max_size`. Compatibility alias for `http_server.buffer_chunk_size`. | `512K` |
2424
| `buffer_max_size` | Specify the maximum buffer size to receive a JSON message. Compatibility alias for `http_server.buffer_max_size`. | `4M` |
25+
| `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` |
2526
| `http2` | Enable HTTP/2 support. Compatibility alias for `http_server.http2`. | `true` |
2627
| `http_server.max_connections` | Maximum number of concurrent active HTTP connections. `0` means unlimited. | `0` |
2728
| `http_server.workers` | Number of HTTP listener worker threads. | `1` |

0 commit comments

Comments
 (0)