Skip to content

pipeline: inputs: random: general cleanup #1861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 3, 2025
Merged

pipeline: inputs: random: general cleanup #1861

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
471120d
pipeline: inputs: process: fix stray phrasing error
alexakreizinger Jul 3, 2025
2ea1473
pipeline: inputs: prometheus-remote-write: fix missing header
alexakreizinger Jul 3, 2025
4df0663
phrasing
alexakreizinger Jul 3, 2025
a4287a2
pipeline: inputs: random: general cleanup
alexakreizinger Jul 3, 2025
9302b18
Update pipeline/inputs/random.md
alexakreizinger Jul 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pipeline/inputs/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The plugin supports the following configuration parameters:
| --- | ----------- | ------- |
| `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` |
| `Interval_Nsec` | Specifies 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` |
Expand Down Expand Up @@ -45,7 +45,7 @@ pipeline:
interval_nsec: 0
fd: true
mem: true

outputs:
- name: stdout
match: '*'
Expand Down Expand Up @@ -105,4 +105,4 @@ ______ _ _ ______ _ _ ___ _____
[1] proc.0: [1485780298, {"alive"=>true, "proc_name"=>"fluent-bit", "pid"=>10964, "mem.VmPeak"=>14740000, "mem.VmSize"=>14740000, "mem.VmLck"=>0, "mem.VmHWM"=>1148000, "mem.VmRSS"=>1148000, "mem.VmData"=>2276000, "mem.VmStk"=>88000, "mem.VmExe"=>1768000, "mem.VmLib"=>2328000, "mem.VmPTE"=>68000, "mem.VmSwap"=>0, "fd"=>18}]
[2] proc.0: [1485780299, {"alive"=>true, "proc_name"=>"fluent-bit", "pid"=>10964, "mem.VmPeak"=>14740000, "mem.VmSize"=>14740000, "mem.VmLck"=>0, "mem.VmHWM"=>1152000, "mem.VmRSS"=>1148000, "mem.VmData"=>2276000, "mem.VmStk"=>88000, "mem.VmExe"=>1768000, "mem.VmLib"=>2328000, "mem.VmPTE"=>68000, "mem.VmSwap"=>0, "fd"=>18}]
[3] proc.0: [1485780300, {"alive"=>true, "proc_name"=>"fluent-bit", "pid"=>10964, "mem.VmPeak"=>14740000, "mem.VmSize"=>14740000, "mem.VmLck"=>0, "mem.VmHWM"=>1152000, "mem.VmRSS"=>1148000, "mem.VmData"=>2276000, "mem.VmStk"=>88000, "mem.VmExe"=>1768000, "mem.VmLib"=>2328000, "mem.VmPTE"=>68000, "mem.VmSwap"=>0, "fd"=>18}]
```
```
6 changes: 4 additions & 2 deletions pipeline/inputs/prometheus-remote-write.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ The _Prometheus remote write_ input plugin lets you ingest a payload in the Prom
| `uri` | Specifies an optional HTTP URI for the target web server listening for Prometheus remote write payloads (for example, `/api/prom/push`). | _none_ |
| `threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

A sample config file to get started will look something like the following:
## Configuration file

The following examples are sample configuration files for this input plugin:

{% tabs %}
{% tab title="fluent-bit.yaml" %}
Expand Down Expand Up @@ -61,7 +63,7 @@ These sample configurations configure Fluent Bit to listen for data on port `808

### Communicate with TLS

Prometheus Remote Write input plugin supports TLS and SSL. For more details about the properties available and general configuration, refer to the [Transport security](../../administration/transport-security.md) documentation.
The Prometheus remote write input plugin supports TLS and SSL. For more details about the properties available and general configuration, refer to the [Transport security](../../administration/transport-security.md) documentation.

To communicate with TLS, you must use these TLS-related parameters:

Expand Down
32 changes: 16 additions & 16 deletions pipeline/inputs/random.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
# Random

_Random_ input plugin generate very simple random value samples using the device interface _/dev/urandom_, if not available it will use a unix timestamp as value.
The _Random_ input plugin generates random value samples using the device interface `/dev/urandom`. If that interface is unavailable, it uses a Unix timestamp as a value.

## Configuration Parameters
## Configuration parameters

The plugin supports the following configuration parameters:

| Key | Description |
| :--- | :--- |
| Samples | If set, it will only generate a specific number of samples. By default this value is set to _-1_, which will generate unlimited samples. |
| Interval\_Sec | Interval in seconds between samples generation. Default value is _1_. |
| Interval\_Nsec | Specify a nanoseconds interval for samples generation, it works in conjunction with the Interval\_Sec configuration key. Default value is _0_. |
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
| Key | Description | Default |
| --- | ----------- | ------- |
| `Samples` | Specifies the number of samples to generate. The default value of `-1` generates unlimited samples. | `-1` |
| `Interval_Sec` | Specifies the interval between generated samples, in seconds. | `1` |
| `Interval_Nsec` | Specifies the interval between generated samples, in nanoseconds. This works in conjunction with `Interval_Sec`. | `0` |
| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

## Getting Started
## Get started

In order to start generating random samples, you can run the plugin from the command line or through the configuration file:
To start generating random samples, you can either run the plugin from the command line or through a configuration file.

### Command Line
### Command line

From the command line you can let Fluent Bit generate the samples with the following options:
Use the following command line options to generate samples.

```shell
$ fluent-bit -i random -o stdout
```

### Configuration File
### Configuration file

In your main configuration file append the following:
The following examples are sample configuration files for this input plugin:

{% tabs %}
{% tab title="fluent-bit.yaml" %}
Expand Down Expand Up @@ -65,7 +65,7 @@ pipeline:

## Testing

Once Fluent Bit is running, you will see the reports in the output interface similar to this:
After Fluent Bit starts running, it generates reports in the output interface:

```shell
$ fluent-bit -i random -o stdout
Expand Down Expand Up @@ -98,4 +98,4 @@ ______ _ _ ______ _ _ ___ _____
[2] random.0: [1475893656, {"rand_value"=>7580417447354808203}]
[3] random.0: [1475893657, {"rand_value"=>1501010137543905482}]
[4] random.0: [1475893658, {"rand_value"=>16238242822364375212}]
```
```