Generator

Generate fake events, which can be useful for testing, benchmarking, and demos

status: stable role: daemon role: sidecar delivery: at-least-once egress: stream state: stateless output: log
Generates fakes events, useful for testing, benchmarking, and demoing.

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "generator",
      "format": "shuffle"
    }
  }
}
[sources.my_source_id]
type = "generator"
format = "shuffle"
---
sources:
  my_source_id:
    type: generator
    format: shuffle
{
  "sources": {
    "my_source_id": {
      "type": "generator",
      "format": "shuffle",
      "interval": 1,
      "count": null,
      "lines": [
        "Line 1"
      ],
      "sequence": null
    }
  }
}
[sources.my_source_id]
type = "generator"
format = "shuffle"
interval = 1
lines = [ "Line 1" ]
---
sources:
  my_source_id:
    type: generator
    format: shuffle
    interval: 1
    count: null
    lines:
      - Line 1
    sequence: null

count

optional uint
The total number of lines to output. By default the source continuously prints logs (infinitely).

format

required string literal enum
The format of the randomly generated output.
Examples
"shuffle"
"apache_common"
"apache_error"
"syslog"
"bsd_syslog"
"json"
Enum options string literal
OptionDescription
apache_commonRandomly generated logs in Apache common format.
apache_errorRandomly generated logs in Apache error format.
bsd_syslogRandomly generated logs in Syslog format (RFC 3164).
jsonRandomly generated HTTP server logs in JSON format.
shuffleLines are chosen at random from the list specified using lines.
syslogRandomly generated logs in Syslog format (RFC 5424).

interval

optional float
The amount of time, in seconds, to pause between each batch of output lines. If not set, there is no delay.
Examples
1
0.1
0.01

lines

optional [string]
The list of lines to output.
Array string literal
Examples
[
  "Line 1",
  "Line 2"
]
Relevant when: `format` = `shuffle`

sequence

optional bool
If true, each output line starts with an increasing sequence number, beginning with 0.
default: false
Relevant when: `format` = `shuffle`

Output

Telemetry

Metrics

link

events_out_total

counter
The total number of events emitted by this component.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

processed_events_total

counter
The total number of events processed by this component. This metric is deprecated in place of using events_in_total and events_out_total metrics.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

utilization

gauge
A ratio from 0 to 1 of the load on a component. A value of 0 would indicate a completely idle component that is simply waiting for input. A value of 1 would indicate a that is never idle. This value is updated every 5 seconds.
component_id required
The Vector component ID.
component_kind required
The Vector component kind.
component_name required
Deprecated, use component_id instead. The value is the same as component_id.
component_type required
The Vector component type.
host required
The hostname of the system Vector is running on.
pid required
The process ID of the Vector instance.

How it works

Context

By default, the generator source augments events with helpful context keys.

State

This component is stateless, meaning its behavior is consistent across each input.