sample

Search…

sample

The in_sample input plugin generates sample events. It is useful for testing, debugging, benchmarking and getting started with Fluentd.
It is included in Fluentd's core.
This plugin is the renamed version of in_dummy.
Example Configuration
1
<source>
2
  @type sample
3
  sample {"hello":"world"}
4
  tag sample
5
</source>
6
​
7
# If you use fluentd v1.11.1 or earlier, use following configuration
8
<source>
9
  @type dummy
10
  dummy {"hello":"world"}
11
  tag dummy
12
</source>
Copied!
Please see the Config File article for the basic structure and syntax of the configuration file.
Plugin Helpers
​thread​
​storage​
See also: Input Plugin Overview​
Parameters
See Common Parameters.
@type
The value must be sample.
If you use fluentd v1.11.1 or earlier, use dummy.
tag
type
default
version
string
Nothing
0.14.0
The value is the tag assigned to the generated events.
size
type
default
version
integer
1
0.14.4
The number of events in the event stream of each emit.
rate
type
default
version
integer
1
0.14.0
It configures how many events to generate per second.
auto_increment_key
type
default
version
string
nil
0.14.0
If specified, each generated event has an auto-incremented key field.
For example, with auto_increment_key foo_key, the first couple of events look like:
1
2014-12-14 23:23:38 +0000 test: {"message":"sample","foo_key":0}
2
2014-12-14 23:23:38 +0000 test: {"message":"sample","foo_key":1}
3
2014-12-14 23:23:38 +0000 test: {"message":"sample","foo_key":2}
Copied!
suspend
type
default
version
bool
false
0.14.2
This parameter is removed since v1.10.0. This feature is automatically handled in the core.
sample
type
default
version
string
[{"message":"sample"}]
0.14.0
The sample data to be generated. It should be either an array of JSON hashes or a single JSON hash. If it is an array of JSON hashes, the hashes in the array are cycled through in order.
If you use fluentd v1.11.1 or earlier, use dummy.
If this article is incorrect or outdated, or omits critical information, please let us know. Fluentd is an open-source project under Cloud Native Computing Foundation (CNCF). All components are available under the Apache 2 License.