Skip to content

Commit 9abf597

Browse files
authored
Fixes to standardize health input plugin doc. Fixes #2264. (#2265)
* Fixes to standardize health input plugin doc. Fixes #2264. Signed-off-by: Eric D. Schabell <eric@schabell.org> * Small review suggestion fixed. Signed-off-by: Eric D. Schabell <eric@schabell.org> --------- Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 2153f99 commit 9abf597

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

pipeline/inputs/health.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ The plugin supports the following configuration parameters:
88

99
| Key | Description | Default |
1010
|:----------------|:-------------------------------------------------------------------------------------------------------------------|:--------|
11-
| `Host` | Name of the target host or IP address. | _none_ |
12-
| `Port` | TCP port where to perform the connection request. | _none_ |
13-
| `Interval_Sec` | Interval in seconds between the service checks. | `1` |
14-
| `Internal_Nsec` | Specify a nanoseconds interval for service checks. Works in conjunction with the `Interval_Sec` configuration key. | `0` |
15-
| `Alert` | If enabled, it generates messages if the target TCP service is down. | `false` |
16-
| `Add_Host` | If enabled, hostname is appended to each records. | `false` |
17-
| `Add_Port` | If enabled, port number is appended to each records. | `false` |
18-
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
11+
| `add_host` | If enabled, hostname is appended to each record. | `false` |
12+
| `add_port` | If enabled, port number is appended to each record. | `false` |
13+
| `alert` | If enabled, it generates messages only when the target TCP service is down. | `false` |
14+
| `host` | Name of the target host or IP address. | _none_ |
15+
| `interval_nsec` | Specify a nanoseconds interval for service checks. Works with the `interval_sec` configuration key. | `0` |
16+
| `interval_sec` | Interval in seconds between the service checks. | `1` |
17+
| `port` | TCP port where to perform the connection request. | _none_ |
18+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1919

2020
## Get started
2121

@@ -44,7 +44,7 @@ pipeline:
4444
port: 80
4545
interval_sec: 1
4646
interval_nsec: 0
47-
47+
4848
outputs:
4949
- name: stdout
5050
match: '*'
@@ -71,7 +71,7 @@ pipeline:
7171

7272
## Testing
7373

74-
Once Fluent Bit is running, you will see some random values in the output interface similar to this:
74+
Once Fluent Bit is running, you will see health check results in the output interface similar to this:
7575

7676
```shell
7777
$ fluent-bit -i health -p host=127.0.0.1 -p port=80 -o stdout

0 commit comments

Comments
 (0)