Skip to content

Commit 02dfc5a

Browse files
committed
Fixed dummy input plugin doc with missing config option and standard layout. Fixes #2243.
Signed-off-by: Eric D. Schabell <eric@schabell.org>
1 parent 7f3d35f commit 02dfc5a

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

pipeline/inputs/dummy.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,20 @@ The _Dummy_ input plugin generates dummy events. Use this plugin for testing, de
66

77
The plugin supports the following configuration parameters:
88

9-
| Key | Description | Default |
10-
|:-------------------|:------------------------------------------------------------------------------------------------------------------------|:----------------------|
11-
| `Dummy` | Dummy JSON record. | `{"message":"dummy"}` |
12-
| `Metadata` | Dummy JSON metadata. | `{}` |
13-
| `Start_time_sec` | Dummy base timestamp, in seconds. | `0` |
14-
| `Start_time_nsec` | Dummy base timestamp, in nanoseconds. | `0` |
15-
| `Rate` | Rate at which messages are generated expressed in how many times per second. | `1` |
16-
| `Interval_sec` | Set time interval, in seconds, at which every message is generated. If set, `Rate` configuration is ignored. | `0` |
17-
| `Interval_nsec` | Set time interval, in nanoseconds, at which every message is generated. If set, `Rate` configuration is ignored. | `0` |
18-
| `Samples` | If set, the events number will be limited. For example, if Samples=3, the plugin generates only three events and stops. | _none_ |
19-
| `Copies` | Number of messages to generate each time messages generate. | `1` |
20-
| `Flush_on_startup` | If set to `true`, the first dummy event is generated at startup. | `false` |
21-
| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
9+
| Key | Description | Default |
10+
|:----|:------------|:--------|
11+
| `copies` | Number of messages to generate each time messages are generated. | `1` |
12+
| `dummy` | Dummy JSON record. | `{"message":"dummy"}` |
13+
| `fixed_timestamp` | If enabled, use a fixed timestamp. This allows the message to be pre-generated once. | `false` |
14+
| `flush_on_startup` | If set to `true`, the first dummy event is generated at startup. | `false` |
15+
| `interval_nsec` | Set time interval, in nanoseconds, at which every message is generated. If set, `rate` configuration is ignored. | `0` |
16+
| `interval_sec` | Set time interval, in seconds, at which every message is generated. If set, `rate` configuration is ignored. | `0` |
17+
| `metadata` | Dummy JSON metadata. | `{}` |
18+
| `rate` | Rate at which messages are generated, expressed in how many times per second. | `1` |
19+
| `samples` | Limit the number of events generated. For example, if `samples=3`, the plugin generates only three events and stops. `0` means no limit. | `0` |
20+
| `start_time_nsec` | Set a dummy base timestamp, in nanoseconds. If set to `-1`, the current time is used. | `-1` |
21+
| `start_time_sec` | Set a dummy base timestamp, in seconds. If set to `-1`, the current time is used. | `-1` |
22+
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2223

2324
## Get started
2425

@@ -65,7 +66,7 @@ pipeline:
6566
```text
6667
[INPUT]
6768
Name dummy
68-
Dummy {"message": "custom dummy"}
69+
Dummy {"message": "custom dummy"}
6970

7071
[OUTPUT]
7172
Name stdout

0 commit comments

Comments
 (0)