From 382a72807b1d4fcb4d752c99f0598c27bd8ed355 Mon Sep 17 00:00:00 2001 From: Alexa Kreizinger Date: Wed, 2 Jul 2025 12:45:07 -0700 Subject: [PATCH 1/3] pipeline: inputs: process: general cleanup Signed-off-by: Alexa Kreizinger --- pipeline/inputs/process.md | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/pipeline/inputs/process.md b/pipeline/inputs/process.md index 06ba33913..1772a2cc5 100644 --- a/pipeline/inputs/process.md +++ b/pipeline/inputs/process.md @@ -1,38 +1,37 @@ -# Process Metrics +# Process metrics -_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. +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. -The Process metrics plugin creates metrics that are log-based, such as JSON payload. -For Prometheus-based metrics, see the Node Exporter Metrics input plugin. +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. -## Configuration Parameters +## Configuration parameters The plugin supports the following configuration parameters: | Key | Description | | :--- | :--- | -| Proc\_Name | Name of the target Process to check. | -| Interval\_Sec | Interval in seconds between the service checks. Default value is _1_. | -| Interval\_Nsec | Specify a nanoseconds interval for service checks, it works in conjunction with the Interval\_Sec configuration key. Default value is _0_. | -| Alert | If enabled, it will only generate messages if the target process is down. By default this option is disabled. | -| Fd | If enabled, a number of fd is appended to each records. Default value is true. | -| Mem | If enabled, memory usage of the process is appended to each records. Default value is true. | -| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. | +| `Proc_Name` | The name of the target process to check. | +| `Interval_Sec` | Specifies the interval between service checks, in seconds. Default: `1`. | +| `Interval_Nsec` | Specify the interval between service checks, in nanoseconds. This works in conjunction with `Interval_Sec`. Default: `0`. | +| `Alert` | If enabled, the plugin will only generate messages if the target process is down. Default: `false`. | +| `Fd` | If enabled, a number of `fd` is appended to each record. Default: `true`. | +| `Mem` | If enabled, memory usage of the process is appended to each record. Default: `true`. | +| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. | -## Getting Started +## Getting started -In order to start performing the checks, you can run the plugin from the command line or through the configuration file: +To start performing the checks, you can run the plugin from the command line or through the configuration file: -The following example will check the health of _crond_ process. +The following example checks the health of `crond` process. ```bash $ fluent-bit -i proc -p proc_name=crond -o stdout ``` -### Configuration File +### Configuration file -In your main configuration file append the following _Input_ & _Output_ sections: +In your main configuration file, append the following `Input` & `Output` sections: ```python [INPUT] @@ -50,7 +49,7 @@ In your main configuration file append the following _Input_ & _Output_ sections ## Testing -Once Fluent Bit is running, you will see the health of process: +After Fluent Bit starts running, it outputs the health of the process: ```bash $ fluent-bit -i proc -p proc_name=fluent-bit -o stdout From 1c4b4786339d92d6ec027554881aa87c864b41b3 Mon Sep 17 00:00:00 2001 From: Alexa Kreizinger Date: Wed, 2 Jul 2025 13:38:52 -0700 Subject: [PATCH 2/3] pipeline: inputs: process: add default column Signed-off-by: Alexa Kreizinger --- pipeline/inputs/process.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/pipeline/inputs/process.md b/pipeline/inputs/process.md index 1772a2cc5..a29dd4fca 100644 --- a/pipeline/inputs/process.md +++ b/pipeline/inputs/process.md @@ -9,15 +9,15 @@ This plugin creates metrics that are log-based, such as JSON payloads. For Prome The plugin supports the following configuration parameters: -| Key | Description | -| :--- | :--- | -| `Proc_Name` | The name of the target process to check. | -| `Interval_Sec` | Specifies the interval between service checks, in seconds. Default: `1`. | -| `Interval_Nsec` | Specify the interval between service checks, in nanoseconds. This works in conjunction with `Interval_Sec`. Default: `0`. | -| `Alert` | If enabled, the plugin will only generate messages if the target process is down. Default: `false`. | -| `Fd` | If enabled, a number of `fd` is appended to each record. Default: `true`. | -| `Mem` | If enabled, memory usage of the process is appended to each record. Default: `true`. | -| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. | +| Key | Description | Default | +| --- | ----------- | ------- | +| `Proc_Name` | The name of the target process to check. | _none_ | +| `Interval_Sec` | Specifies the interval between service checks, in seconds. | `1` | +| `Interval_Nsec` | Specify the interval between service checks, in nanoseconds. This works in conjunction with `Interval_Sec`. | `0` | +| `Alert` | If enabled, the plugin will only generate messages if the target process is down. | `false` | +| `Fd` | If enabled, a number of `fd` is appended to each record. | `true` | +| `Mem` | If enabled, memory usage of the process is appended to each record. | `true` | +| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | ## Getting started From b7eb3594162608af03ab956ef5e5378b38e165dc Mon Sep 17 00:00:00 2001 From: Alexa Kreizinger Date: Wed, 2 Jul 2025 13:49:02 -0700 Subject: [PATCH 3/3] Update pipeline/inputs/process.md Signed-off-by: Alexa Kreizinger --- pipeline/inputs/process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/inputs/process.md b/pipeline/inputs/process.md index a29dd4fca..357332b59 100644 --- a/pipeline/inputs/process.md +++ b/pipeline/inputs/process.md @@ -19,7 +19,7 @@ The plugin supports the following configuration parameters: | `Mem` | If enabled, memory usage of the process is appended to each record. | `true` | | `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` | -## Getting started +## Get started To start performing the checks, you can run the plugin from the command line or through the configuration file: