Skip to content

LogMan.io Collector configuration

LogMan.io Collector configuration typically consists of two files.

  • Connection configuration (/etc/lmio-collector.conf, INI format) specifies the path for pipeline configuration, web API, connection to Library, and encryption.
  • Pipeline configuration (/etc/lmio-collector.yaml, YAML format) specifies from which inputs the data is collected (inputs), how the data is transformed (transforms) and how the data is sent further (outputs).

Connection configuration

lmio-collector.conf
[config]
path=./etc/lmio-collector.yaml
key=./etc/aes.key

[web]
listen=0.0.0.0 8088

[library]
providers:
    provider 1
    provider 2
    ...

AES key must be specified, if the passwords in the configuration should be encrypted using LogMan.io Commander (see its documentation), i. e. !encpwd "<ENCRYPTED_LMIO_PASSWORD>". Otherwise, the encryption will not work.

Pipeline configuration

Pipeline configuration is a YAML file based on BSPump declarative language.

Every section represents one component of the pipeline. It always starts with either input:, transform:, output: or connection: and has the form:

input|transform|output:<TYPE>:<ID>
where <TYPE> determines the component type. <ID> is used for reference and can be chosen in any way.

  • Output creates a BSPump pipeline with specified sink/output and conversion processors.
  • Transform performs a preprocessing of the event before the event is passed to the output.
  • Input adds a source/input to a given pipeline, using output: <OUTPUT_ID> command.
lmio-collector.yaml
# Connection with LogMan.io Receiver
connection:CommLink:commlink:
  url: https://localhost:8443/

# Input
input:Datagram:UDPMySource:
  configuration for the specific input: goes here
  output: <output_id>

# Transformation

# Output
output:CommLink:<output_id>: {}

For the detailed configuration options of each component, see Inputs, Transformations and Outputs chapters. See LogMan.io Receiver documentation for the CommLink connection details.

Docker Compose

version: '3'
services:

  lmio-collector:
    image: docker.teskalabs.com/<PARTNER_CODE>/lmio-collector
    container_name: lmio-collector
    volumes:
      - ./lmio-collector:/conf
      - ./lmio-collector:/data
      - ./lmio-collector:/app/lmio-collector/var
      - ./lmio-collector/ws:/app/lmio-collector/var/lib/lmio-collector
    network_mode: host
    ports:
      - "8888:8888"
    restart: always