You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pipeline/inputs/health.md
+21-18Lines changed: 21 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,40 +1,41 @@
1
1
# Health
2
2
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.
4
4
5
-
## Configuration Parameters
5
+
## Configuration parameters
6
6
7
7
The plugin supports the following configuration parameters:
8
8
9
-
| Key | Description |
9
+
| Key | Description | Default |
10
10
| :--- | :--- |
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`|
19
19
20
-
## Getting Started
20
+
## Get started
21
21
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:
23
23
24
-
### Command Line
24
+
### Command line
25
25
26
26
From the command line you can let Fluent Bit generate the checks with the following options:
27
27
28
28
```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
30
30
```
31
31
32
-
### Configuration File
32
+
### Configuration file
33
33
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:
35
35
36
36
{% tabs %}
37
37
{% tab title="fluent-bit.conf" %}
38
+
38
39
```python
39
40
[INPUT]
40
41
Name health
@@ -47,9 +48,11 @@ In your main configuration file append the following _Input_ & _Output_ sections
47
48
Name stdout
48
49
Match *
49
50
```
51
+
50
52
{% endtab %}
51
53
52
54
{% tab title="fluent-bit.yaml" %}
55
+
53
56
```yaml
54
57
pipeline:
55
58
inputs:
@@ -62,10 +65,10 @@ pipeline:
62
65
- name: stdout
63
66
match: '*'
64
67
```
68
+
65
69
{% endtab %}
66
70
{% endtabs %}
67
71
68
-
69
72
## Testing
70
73
71
74
Once Fluent Bit is running, you will see some random values in the output interface similar to this:
0 commit comments