Skip to content

Commit 3df1e25

Browse files
Merge pull request #1861 from fluent/alexakreizinger/sc-136198/update-fluent-bit-docs-pipeline-inputs-random
2 parents e6b7049 + 9302b18 commit 3df1e25

File tree

3 files changed

+23
-21
lines changed

3 files changed

+23
-21
lines changed

pipeline/inputs/process.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The plugin supports the following configuration parameters:
1313
| --- | ----------- | ------- |
1414
| `Proc_Name` | The name of the target process to check. | _none_ |
1515
| `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` |
16+
| `Interval_Nsec` | Specifies the interval between service checks, in nanoseconds. This works in conjunction with `Interval_Sec`. | `0` |
1717
| `Alert` | If enabled, the plugin will only generate messages if the target process is down. | `false` |
1818
| `Fd` | If enabled, a number of `fd` is appended to each record. | `true` |
1919
| `Mem` | If enabled, memory usage of the process is appended to each record. | `true` |
@@ -45,7 +45,7 @@ pipeline:
4545
interval_nsec: 0
4646
fd: true
4747
mem: true
48-
48+
4949
outputs:
5050
- name: stdout
5151
match: '*'
@@ -105,4 +105,4 @@ ______ _ _ ______ _ _ ___ _____
105105
[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}]
106106
[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}]
107107
[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}]
108-
```
108+
```

pipeline/inputs/prometheus-remote-write.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ The _Prometheus remote write_ input plugin lets you ingest a payload in the Prom
1919
| `uri` | Specifies an optional HTTP URI for the target web server listening for Prometheus remote write payloads (for example, `/api/prom/push`). | _none_ |
2020
| `threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2121

22-
A sample config file to get started will look something like the following:
22+
## Configuration file
23+
24+
The following examples are sample configuration files for this input plugin:
2325

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

6264
### Communicate with TLS
6365

64-
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.
66+
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.
6567

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

pipeline/inputs/random.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
11
# Random
22

3-
_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.
3+
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.
44

5-
## Configuration Parameters
5+
## Configuration parameters
66

77
The plugin supports the following configuration parameters:
88

9-
| Key | Description |
10-
| :--- | :--- |
11-
| 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. |
12-
| Interval\_Sec | Interval in seconds between samples generation. Default value is _1_. |
13-
| Interval\_Nsec | Specify a nanoseconds interval for samples generation, it works in conjunction with the Interval\_Sec configuration key. Default value is _0_. |
14-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
9+
| Key | Description | Default |
10+
| --- | ----------- | ------- |
11+
| `Samples` | Specifies the number of samples to generate. The default value of `-1` generates unlimited samples. | `-1` |
12+
| `Interval_Sec` | Specifies the interval between generated samples, in seconds. | `1` |
13+
| `Interval_Nsec` | Specifies the interval between generated samples, in nanoseconds. This works in conjunction with `Interval_Sec`. | `0` |
14+
| `Threaded` | Specifies whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1515

16-
## Getting Started
16+
## Get started
1717

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

20-
### Command Line
20+
### Command line
2121

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

2424
```shell
2525
$ fluent-bit -i random -o stdout
2626
```
2727

28-
### Configuration File
28+
### Configuration file
2929

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

3232
{% tabs %}
3333
{% tab title="fluent-bit.yaml" %}
@@ -65,7 +65,7 @@ pipeline:
6565

6666
## Testing
6767

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

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

0 commit comments

Comments
 (0)