LogMan.io Collector Outputs
The collector output is specified as follows:
output:<output-type>:<output-name>:
debug: false
...
Common output options
In every output, meta information can be specified as dictionary in meta
attribute.
meta:
my_meta_tag: my_meta_tag_value # (optional) Custom meta information, that will be later available in LogMan.io Parser in event's context
tenant
meta information can be specified in the output's config directly.
Debugging
debug
(optional)
Specify if to write output also to the log for debugging.
Default: false
Prepend the meta information
prepend_meta
(optional)
Prepend the meta information to the the incoming event as key-values pairs separated by spaces.
Default: false
Note
Meta information include file name or extracted information from it (in case of Smart File input), custom defined fields (see below) etc.
TCP Output
Outputs events over TCP to a server specified by the IP address and the Port.
output:TCP:<output-name>:
address: <IP address>:<Port>
...
Address
address
The server address consists of the IP address and the port.
Hint
IPv4 and IPv6 addresses are supported.
Maximum size of packets
max_packet_size
(optional)
Specify the maximum size of packets in bytes.
Default: 65536
Receiver size of the buffer
receiver_buffer_size
(optional)
Limit the receiver size of the buffer in bytes.
Default: 0
UDP Output
Outputs events over a UDP to the specified IP address and the Port.
output:UDP:<output-name>:
address: <IP address>:<Port>
...
Address
address
The server address consists of the IP address and the port.
Hint
IPv4 and IPv6 addresses are supported.
Maximum size of packets
max_packet_size
(optional)
Specify the maximum size of packets in bytes.
Default: 65536
Receiver size of the buffer
receiver_buffer_size
(optional)
Limit the receiver size of the buffer in bytes.
Default: 0
WebSocket Output
Outputs events over WebSocket to a specified URL.
output:WebSocket:<output-name>:
url: <Server URL>
...
URL
url
Specify WebSocket destination URL. For example http://example.com/ws
Tenant
tenant
Name of the tenant the LogMan.io Collector, the tenant name is forwarded to LogMan.io parser and put to the event.
Inactive time
inactive_time
(optional)
Specify inactive time in seconds, after which idle Web Sockets will be closed.
Default: 60
Output queue size
output_queue_max_size
(optional)
Specify in-memory outcoming queue size for every Web Socket
Path to store persistent files
buffer
(optional)
Path to store persistent files in, when the Web Socket connection is offline.
SSL configuration options
The following configuration options specify the SSL (HTTPS) connection:
cert
: Path to the client SSL certificatekey
: Path to the private key of the client SSL certificatepassword
: Private key file password (optional, default: none)cafile
: Path to a PEM file with CA certificate(s) to verify the SSL server (optional, default: none)capath
: Path to a directory with CA certificate(s) to verify the SSL server (optional, default: none)ciphers
: SSL ciphers (optional, default: none)dh_params
: Diffie–Hellman (D-H) key exchange (TLS) parameters (optional, default: none)verify_mode
: One of CERT_NONE, CERT_OPTIONAL or CERT_REQUIRED (optional); for more information, see: github.com/TeskaLabs/asab
File Output
Outputs events into a specified file.
output:File:<output-name>:
path: /data/output.log
...
Path
path
Path of the output file.
Hint
Make sure the location of the output file is accessible within the Docker container when using Docker.
Flags
flags
(optional)
One of O_CREAT
and O_EXCL
, where the first one tell the output to create the file if it does not exist.
Default: O_CREAT
Mode
mode
(optional)
The mode by which the file is going to be written to.
Default: ab
(append bytes).
Unix Socket (datagram)
Outputs events into a datagram-oriented Unix Domain Socket.
output:UnixSocket:<output-name>:
address: <path>
...
Address
address
The Unix socket file path, e.g. /data/myunix.socket
.
Maximum size of packets
max_packet_size
(optional)
Specify the maximum size of packets in bytes.
Default: 65536
Unix Socket (stream)
Outputs events into a stream-oriented Unix Domain Socket.
output:UnixStreamSocket:<output-name>:
address: <path>
...
Address
address
The Unix socket file path, e.g. /data/myunix.socket
.
Maximum size of packets
max_packet_size
(optional)
Specify the maximum size of packets in bytes.
Default: 65536
Print Output
Helper output that print events to the terminal.
output:Print:<output-name>:
...
Null Output
Helper outputs that discard events.
output:Null:<output-name>:
...