Skip to content

Commit e372b73

Browse files
authored
Merge pull request #1728 from fluent/lynettemiles/sc-136180/update-fluent-bit-docs-pipeline-inputs-health
2 parents f6822f1 + 54cfb37 commit e372b73

File tree

1 file changed

+21
-18
lines changed

1 file changed

+21
-18
lines changed

pipeline/inputs/health.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
11
# Health
22

3-
_Health_ input plugin allows you to check how _healthy_ a TCP server is. It does the check by issuing a TCP connection every a certain interval of time.
3+
The _Health_ input plugin lets you check how healthy a TCP server is. It checks by issuing a TCP connection at regular intervals.
44

5-
## Configuration Parameters
5+
## Configuration parameters
66

77
The plugin supports the following configuration parameters:
88

9-
| Key | Description |
9+
| Key | Description | Default |
1010
| :--- | :--- |
11-
| Host | Name of the target host or IP address to check. |
12-
| Port | TCP port where to perform the connection check. |
13-
| Interval\_Sec | Interval in seconds between the service checks. Default value is _1_. |
14-
| Internal\_Nsec | Specify a nanoseconds interval for service checks, it works in conjunction with the Interval\_Sec configuration key. Default value is _0_. |
15-
| Alert | If enabled, it will only generate messages if the target TCP service is down. By default this option is disabled. |
16-
| Add\_Host | If enabled, hostname is appended to each records. Default value is _false_. |
17-
| Add\_Port | If enabled, port number is appended to each records. Default value is _false_. |
18-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
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` |
1919

20-
## Getting Started
20+
## Get started
2121

22-
In order to start performing the checks, you can run the plugin from the command line or through the configuration file:
22+
To start performing the checks, you can run the plugin from the command line or through the configuration file:
2323

24-
### Command Line
24+
### Command line
2525

2626
From the command line you can let Fluent Bit generate the checks with the following options:
2727

2828
```bash
29-
$ fluent-bit -i health -p host=127.0.0.1 -p port=80 -o stdout
29+
fluent-bit -i health -p host=127.0.0.1 -p port=80 -o stdout
3030
```
3131

32-
### Configuration File
32+
### Configuration file
3333

34-
In your main configuration file append the following _Input_ & _Output_ sections:
34+
In your main configuration file append the following `Input` and `Output` sections:
3535

3636
{% tabs %}
3737
{% tab title="fluent-bit.conf" %}
38+
3839
```python
3940
[INPUT]
4041
Name health
@@ -47,9 +48,11 @@ In your main configuration file append the following _Input_ & _Output_ sections
4748
Name stdout
4849
Match *
4950
```
51+
5052
{% endtab %}
5153

5254
{% tab title="fluent-bit.yaml" %}
55+
5356
```yaml
5457
pipeline:
5558
inputs:
@@ -62,10 +65,10 @@ pipeline:
6265
- name: stdout
6366
match: '*'
6467
```
68+
6569
{% endtab %}
6670
{% endtabs %}
6771
68-
6972
## Testing
7073
7174
Once Fluent Bit is running, you will see some random values in the output interface similar to this:

0 commit comments

Comments
 (0)