Skip to content

Commit e201df1

Browse files
authored
docs: in_random: fix config params, sorting, descriptions (#2343)
- Sort configuration parameters alphabetically - Change parameter names to lowercase to match other input plugin docs - Fix inconsistent casing in classic config example (Interval_NSec -> Interval_Nsec) - Update table header alignment to match other docs - Shorten descriptions to match documentation style conventions Fixes #2342 Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 0b9e3f7 commit e201df1

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

pipeline/inputs/random.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ The _Random_ input plugin generates random value samples using the device interf
66

77
The plugin supports the following configuration parameters:
88

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` |
9+
| Key | Description | Default |
10+
|:----|:------------|:--------|
11+
| `interval_nsec` | Set the interval between generated samples, in nanoseconds. This works in conjunction with `interval_sec`. | `0` |
12+
| `interval_sec` | Set the interval between generated samples, in seconds. | `1` |
13+
| `samples` | Set the number of samples to generate. `-1` generates unlimited samples. | `-1` |
14+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1515

1616
## Get started
1717

@@ -53,7 +53,7 @@ pipeline:
5353
Name random
5454
Samples -1
5555
Interval_Sec 1
56-
Interval_NSec 0
56+
Interval_Nsec 0
5757

5858
[OUTPUT]
5959
Name stdout

0 commit comments

Comments
 (0)