|
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" /> |
3 | 3 |
|
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. |
5 | 5 |
|
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. |
7 | 7 |
|
8 | | -## Configuration Parameters |
| 8 | +## Configuration parameters |
9 | 9 |
|
10 | 10 | The plugin supports the following configuration parameters: |
11 | 11 |
|
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` | |
21 | 21 |
|
22 | | -## Getting Started |
| 22 | +## Get started |
23 | 23 |
|
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: |
25 | 25 |
|
26 | | -The following example will check the health of _crond_ process. |
| 26 | +The following example checks the health of `crond` process. |
27 | 27 |
|
28 | 28 | ```shell |
29 | 29 | $ fluent-bit -i proc -p proc_name=crond -o stdout |
30 | 30 | ``` |
31 | 31 |
|
32 | | -### Configuration File |
| 32 | +### Configuration file |
33 | 33 |
|
34 | | -In your main configuration file append the following: |
| 34 | +In your main configuration file, append the following `Input` & `Output` sections: |
35 | 35 |
|
36 | 36 | {% tabs %} |
37 | 37 | {% tab title="fluent-bit.yaml" %} |
@@ -73,7 +73,7 @@ pipeline: |
73 | 73 |
|
74 | 74 | ## Testing |
75 | 75 |
|
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: |
77 | 77 |
|
78 | 78 | ```shell |
79 | 79 | $ fluent-bit -i proc -p proc_name=fluent-bit -o stdout |
|
0 commit comments