Skip to content

Commit 2502701

Browse files
Merge pull request #1837 from fluent/alexakreizinger/sc-136195/update-fluent-bit-docs-pipeline-inputs-process
2 parents 5268681 + a0cff00 commit 2502701

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

pipeline/inputs/process.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
# Process Metrics
2-
_Process_ input plugin allows you to check how healthy a process is. It does so by performing a service check at every certain interval of time specified by the user.
1+
# Process metrics
2+
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=91b97a84-1cd9-41fb-9189-a4f3b30b6bce" />
33

4-
The Process metrics plugin creates metrics that are log-based, such as JSON payload.
4+
The _Process metrics_ input plugin lets you check how healthy a process is. It does so by performing service checks at specified intervals.
55

6-
For Prometheus-based metrics, see the [Node Exporter Metrics input plugin](node-exporter-metrics).
6+
This plugin creates metrics that are log-based, such as JSON payloads. For Prometheus-based metrics, see the [Node exporter metrics](../pipeline/inputs/node-exporter-metrics) input plugin.
77

8-
## Configuration Parameters
8+
## Configuration parameters
99

1010
The plugin supports the following configuration parameters:
1111

12-
| Key | Description |
13-
| :--- | :--- |
14-
| Proc\_Name | Name of the target Process to check. |
15-
| Interval\_Sec | Interval in seconds between the service checks. Default value is _1_. |
16-
| Interval\_Nsec | Specify a nanoseconds interval for service checks, it works in conjunction with the Interval\_Sec configuration key. Default value is _0_. |
17-
| Alert | If enabled, it will only generate messages if the target process is down. By default this option is disabled. |
18-
| Fd | If enabled, a number of fd is appended to each records. Default value is true. |
19-
| Mem | If enabled, memory usage of the process is appended to each records. Default value is true. |
20-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
12+
| Key | Description | Default |
13+
| --- | ----------- | ------- |
14+
| `Proc_Name` | The name of the target process to check. | _none_ |
15+
| `Interval_Sec` | Specifies the interval between service checks, in seconds. | `1` |
16+
| `Interval_Nsec` | Specify the interval between service checks, in nanoseconds. This works in conjunction with `Interval_Sec`. | `0` |
17+
| `Alert` | If enabled, the plugin will only generate messages if the target process is down. | `false` |
18+
| `Fd` | If enabled, a number of `fd` is appended to each record. | `true` |
19+
| `Mem` | If enabled, memory usage of the process is appended to each record. | `true` |
20+
| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2121

22-
## Getting Started
22+
## Get started
2323

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

26-
The following example will check the health of _crond_ process.
26+
The following example checks the health of `crond` process.
2727

2828
```shell
2929
$ fluent-bit -i proc -p proc_name=crond -o stdout
3030
```
3131

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

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

3636
{% tabs %}
3737
{% tab title="fluent-bit.yaml" %}
@@ -73,7 +73,7 @@ pipeline:
7373

7474
## Testing
7575

76-
Once Fluent Bit is running, you will see the health of process:
76+
After Fluent Bit starts running, it outputs the health of the process:
7777

7878
```shell
7979
$ fluent-bit -i proc -p proc_name=fluent-bit -o stdout

0 commit comments

Comments
 (0)