Skip to content
share library_books

Logagent Configuration File

Config File

Logagent can be configured via config files in YAML format. To use the config file run:

logagent --config configFileName.yml

When Logagent is installed as system service the default config file is located in


Section: options

# Global options
  # print stats every 60 seconds 
  printStats: 60
  # don't write parsed logs to stdout
  suppress: false
  # Enable/disable GeoIP lookups
  # Startup of logagent might be slower, when downloading the GeoIP database
  geoipEnabled: false
  # Directory to store Logagent status and temporary files
  diskBufferDir: ./tmp

Section: input

  # a list of glob patterns to watch files to tail
      - '/var/log/**/*.log'
      - '/opt/myapp/logs/*.log'
  # listen to udp syslog protocol  
  #  port: 514
  # listen to http to receive data from Heroku  log drains  
  #  port: 9999
  # listen to http to receive data from Cloud Foundry drains  
  #  port: 8888

Section: parser

This section defines loading of custom pattern files or inline pattern definitions for the log parser.

# optional, if not specified default patterns are used
    # load a list of pattern files to parse logs
    # later files overwrite settings from previous files
    # a 'hot reload' is done as soon one of the listed fiels changes on disk
    - patterns1.yml
    - patterns2.yml
  # inline pattern definitions, to put on top of patterns list
  # loaded from files or default librarary. For inline patterns hot reload is not available.  
    - # timestamped messages from /var/log/*.log on Mac OS X
      sourceName: !!js/regexp /\system\.log/ # catch all system.log files  
          type: system_log
          regex: !!js/regexp /([\w|\s]+\s+\d{2}\s[\d|\:]+)\s(.+?)\s(.+?)\s<(.+)>(.*)/
          fields: [ts,host,service,severity,message]
          dateFormat: MMM DD HH:mm:ss

Section: output

Logs could be shipped to Elasticsearch, AWS Elasticsearch Service, Sematext Cloud, MQTT, GELF, Apache Kafka, ZeroMQ, InfluxDB, ClickHouse DB, ...
The Elasticsearch output supports HTTPS and username/password in the URL. In addition, it is possible to route logs from different files to different indices in Elasticsearch. All logs that don't match any rules in the indices section are routed to the default Elasticsearch index.

  # index logs in Elasticsearch or Sematext Cloud
    module: elasticsearch
    # URL to Elasticearch server, defaults to Sematext Cloud logs receiver if not set

    # Proxy settings behind firewalls
    # httpProxy:  http://localProxy:port
    # httpsProxy: https://localHttpsProxy:port

    # default index to use, for all logs that don't match later in indices section
    # for Sematext Cloud use the Logs App Token here
    index: 0a835c75-9847-4f74-xxxx

    # specific index to use per logSource field of parsed logs
    # logSource is by default the file name of the log file
    # but it can be modified by JS transforms functions in the patterns.yml file
      # list of RegEx mathich logSource / filename  
      # all logs matching logSource name will be indexed to above index
        - .*wifi.*
        - .*bluetooth.*
        - system\.log
        - access\.log
        - auth\.log
  # print parsed logs in YAML format to stdout (only if options.supress is set to false)    
  stdout: yaml # use 'pretty' for pretty json and 'ldjson' for line delimited json (default)

A collection of example config files are here