Skip to content

Commit 382a728

Browse files
pipeline: inputs: process: general cleanup
Signed-off-by: Alexa Kreizinger <[email protected]>
1 parent 52fd9e2 commit 382a728

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

pipeline/inputs/process.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,37 @@
1-
# Process Metrics
1+
# Process metrics
22
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=91b97a84-1cd9-41fb-9189-a4f3b30b6bce" />
33

4-
_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.
4+
The _Process metrics_ input plugin lets you check how healthy a process is. It does so by performing a service check at a specified interval.
55

6-
The Process metrics plugin creates metrics that are log-based, such as JSON payload.
7-
For Prometheus-based metrics, see the Node Exporter Metrics input plugin.
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.
87

9-
## Configuration Parameters
8+
## Configuration parameters
109

1110
The plugin supports the following configuration parameters:
1211

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

23-
## Getting Started
22+
## Getting started
2423

25-
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:
2625

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

2928
```bash
3029
$ fluent-bit -i proc -p proc_name=crond -o stdout
3130
```
3231

33-
### Configuration File
32+
### Configuration file
3433

35-
In your main configuration file append the following _Input_ & _Output_ sections:
34+
In your main configuration file, append the following `Input` & `Output` sections:
3635

3736
```python
3837
[INPUT]
@@ -50,7 +49,7 @@ In your main configuration file append the following _Input_ & _Output_ sections
5049

5150
## Testing
5251

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

5554
```bash
5655
$ fluent-bit -i proc -p proc_name=fluent-bit -o stdout

0 commit comments

Comments
 (0)