Senders

Batching

Many output can batch events for improved performance. A batching output will use the following arguments:

• batchSize, batch size
• workers, the number of concurrent batches can be flushed at the same time
• flushInterval, how often to flush a batch, even if not full.

Outputs list

loghub.senders.ElasticSearch

It can batch.

• timeout
• protocol, http or https.
• destinations, an array of Elastic servers.
• index, an expression for the index name
• dateformat, a date format p`ttern, that can be used to generate index name; used only if index expression is not defined.
• type, an expression for the _type value
• templatePath
• templateName
• withTemplate, false disable any template handling from LogHub.
• login
• password
• typeHandling, can take the values USING, MIGRATING, DEPRECATED
  • USING means the old _type field is still used.
  • MIGRATING means the old _type is still used, but the parameter include_type_name=true is added when needed.
  • DEPRECATED means that no _type is used, in template handling or bulk send. So both type and typeX settings will be ignored.
• ilm, activate the index lifecycle management (ILM) feature; if true, index existence will be checked, and it’s missing, a new index with the name indexname-000001 will be created, and a an alias to indexname will be added.

It neither type or typeX is defined, the type of document default to _doc, unless of course if typeHandling is defined to DEPRECATED, in which case it's ignored.

loghub.senders.File

It can batch. If batching, the file on disk might be in an inconsistent state, with events missing and holes in the file, until a batch is totally committed to disk.

• fileName, an expression for the filename,
• cacheSize, if the filename is an expression, a cache should be used to avoid constant reopening of the same files, defines the open cache size; default to 10 entries.
• truncate, truncate before opening a file if it already exists.
• separator, the entry separator, as a String.

loghub.senders.Nsca

loghub.senders.Null

loghub.senders.Stdout

loghub.senders.Tcp

It can batch. When batching, each batch will use a dedicated socket, to the same destination.

• destination,
• port,
• separator, the entry separator, as a String

loghub.senders.Udp

loghub.senders.ZMQ

It can batch.