Skip to main content

Arguments and Settings

Arguments

OptionExpected valueDescription
-c, --config<filepath>Path to configuration file
-t, --time-modesample | live

Time mode of generating events

  • sample - publish all events immediately
  • live - publish events with respect to real time
-i, --interactive-Enable interactive mode: display progress bar and EPS stats
-s, --settings<plain json>Application core settings. See table below with listed settings
-p, --params<plain json>Parameters to use in configuration file as token values for params
-v, --verbose-Enable all informational messages in output.
-V, --version-Show package's version

Core settings

Following parameters can be used in json string passed to --settings argument:

KeyExpected valueDefault valueDescription
timezone<timezone> (e.g Europe/Moscow)UTCTime zone of timestamps in events
timezone_field_name<str>tzName of the variable in template with zone offset
tags_field_name<str>tagsName of the variable in template with input plugin tags
timestamp_field_name<str>timestampName of the variable in template with timestamp
events_batch_size<int>1,000,000Minimal events batch size to be published by input plugin to event plugin
events_batch_timeout<float>1.0Minimal seconds of events batch lifetime to be published by input plugin to event plugin
output_batch_size<int>10,000Minimal events batch size to be written by output plugin
output_batch_timeout<float>1.0Minimal seconds of events batch lifetime to be written by output plugin
input_queue_max_size<int>10,000,000Max size of input queue, input plugins are blocked if this queue is full
event_queue_max_size<int>1,000,000Max size of event queue, event plugin is blocked if this queue is full