11# Dummy
22
3- The ** dummy ** input plugin, generates dummy events. It is useful for testing, debugging, benchmarking and getting started with Fluent Bit.
3+ The _ Dummy _ input plugin, generates dummy events. Use this plugin for testing, debugging, benchmarking and getting started with Fluent Bit.
44
5- ## Configuration Parameters
5+ ## Configuration parameters
66
77The plugin supports the following configuration parameters:
88
99| Key | Description | Default |
1010| :----------------- | :---------- | :------ |
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 they are generated . | ` 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 ` |
22-
23- ## Getting Started
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 ` |
22+
23+ ## Get started
2424
2525You can run the plugin from the command line or through the configuration file:
2626
27- ### Command Line
27+ ### Command line
28+
29+ Run the plugin from the command line using the following command:
2830
2931``` bash
30- $ fluent-bit -i dummy -o stdout
32+ fluent-bit -i dummy -o stdout
33+ ```
34+
35+ which returns results like the following:
36+
37+ ``` text
3138Fluent Bit v2.x.x
3239* Copyright (C) 2015-2022 The Fluent Bit Authors
3340* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
@@ -37,14 +44,15 @@ Fluent Bit v2.x.x
3744[0] dummy.0: [[1686451467.659679509, {}], {"message"=>"dummy"}]
3845```
3946
40- ### Configuration File
47+ ### Configuration file
4148
42- In your main configuration file append the following _ Input _ & _ Output _ sections:
49+ In your main configuration file append the following ` Input ` and ` Output ` sections:
4350
4451
4552{% tabs %}
4653{% tab title="fluent-bit.conf" %}
47- ``` text
54+
55+ ``` python
4856[INPUT ]
4957 Name dummy
5058 Dummy {" message" : " custom dummy" }
@@ -53,9 +61,11 @@ In your main configuration file append the following _Input_ & _Output_ sections
5361 Name stdout
5462 Match *
5563```
64+
5665{% endtab %}
5766
5867{% tab title="fluent-bit.yaml" %}
68+
5969``` yaml
6070pipeline :
6171 inputs :
@@ -65,5 +75,6 @@ pipeline:
6575 - name : stdout
6676 match : ' *'
6777` ` `
78+
6879{% endtab %}
6980{% endtabs %}
0 commit comments