Skip to content

Commit 91f88a9

Browse files
authored
Updated health input plugin docs to standarize on YAML and shell usage. Fixes #1807. (#1808)
Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 52fd9e2 commit 91f88a9

File tree

1 file changed

+42
-30
lines changed

1 file changed

+42
-30
lines changed

pipeline/inputs/health.md

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -25,32 +25,15 @@ To start performing the checks, you can run the plugin from the command line or
2525

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

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

3232
### Configuration file
3333

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

3636
{% tabs %}
37-
{% tab title="fluent-bit.conf" %}
38-
39-
```python
40-
[INPUT]
41-
Name health
42-
Host 127.0.0.1
43-
Port 80
44-
Interval_Sec 1
45-
Interval_NSec 0
46-
47-
[OUTPUT]
48-
Name stdout
49-
Match *
50-
```
51-
52-
{% endtab %}
53-
5437
{% tab title="fluent-bit.yaml" %}
5538

5639
```yaml
@@ -61,33 +44,62 @@ pipeline:
6144
port: 80
6245
interval_sec: 1
6346
interval_nsec: 0
47+
6448
outputs:
6549
- name: stdout
6650
match: '*'
6751
```
6852
53+
{% endtab %}
54+
{% tab title="fluent-bit.conf" %}
55+
56+
```text
57+
[INPUT]
58+
Name health
59+
Host 127.0.0.1
60+
Port 80
61+
Interval_Sec 1
62+
Interval_NSec 0
63+
64+
[OUTPUT]
65+
Name stdout
66+
Match *
67+
```
68+
6969
{% endtab %}
7070
{% endtabs %}
7171

7272
## Testing
7373

7474
Once Fluent Bit is running, you will see some random values in the output interface similar to this:
7575

76-
```bash
76+
```shell
7777
$ fluent-bit -i health -p host=127.0.0.1 -p port=80 -o stdout
78-
Fluent Bit v1.8.0
79-
* Copyright (C) 2019-2021 The Fluent Bit Authors
80-
* Copyright (C) 2015-2018 Treasure Data
78+
79+
Fluent Bit v4.0.0
80+
* Copyright (C) 2015-2025 The Fluent Bit Authors
8181
* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
8282
* https://fluentbit.io
8383

84-
[2021/06/20 08:39:47] [ info] [engine] started (pid=4621)
85-
[2021/06/20 08:39:47] [ info] [storage] version=1.1.1, initializing...
86-
[2021/06/20 08:39:47] [ info] [storage] in-memory
87-
[2021/06/20 08:39:47] [ info] [storage] normal synchronization mode, checksum disabled, max_chunks_up=128
88-
[2021/06/20 08:39:47] [ info] [sp] stream processor started
84+
______ _ _ ______ _ _ ___ _____
85+
| ___| | | | | ___ (_) | / || _ |
86+
| |_ | |_ _ ___ _ __ | |_ | |_/ /_| |_ __ __/ /| || |/' |
87+
| _| | | | | |/ _ \ '_ \| __| | ___ \ | __| \ \ / / /_| || /| |
88+
| | | | |_| | __/ | | | |_ | |_/ / | |_ \ V /\___ |\ |_/ /
89+
\_| |_|\__,_|\___|_| |_|\__| \____/|_|\__| \_/ |_(_)___/
90+
91+
92+
[2025/06/30 16:12:06] [ info] [fluent bit] version=4.0.0, commit=3a91b155d6, pid=91577
93+
[2025/06/30 16:12:06] [ info] [storage] ver=1.5.2, type=memory, sync=normal, checksum=off, max_chunks_up=128
94+
[2025/06/30 16:12:06] [ info] [simd ] disabled
95+
[2025/06/30 16:12:06] [ info] [cmetrics] version=0.9.9
96+
[2025/06/30 16:12:06] [ info] [ctraces ] version=0.6.2
97+
[2025/06/30 16:12:06] [ info] [input:health:health.0] initializing
98+
[2025/06/30 16:12:06] [ info] [input:health:health.0] storage_strategy='memory' (memory only)
99+
[2025/06/30 16:12:06] [ info] [sp] stream processor started
100+
[2025/06/30 16:12:06] [ info] [output:stdout:stdout.0] worker #0 started
89101
[0] health.0: [1624145988.305640385, {"alive"=>true}]
90102
[1] health.0: [1624145989.305575360, {"alive"=>true}]
91103
[2] health.0: [1624145990.306498573, {"alive"=>true}]
92104
[3] health.0: [1624145991.305595498, {"alive"=>true}]
93-
```
105+
```

0 commit comments

Comments
 (0)