Everything you wanted to know about Butler SOS configuration but never dared to ask.

Which config file to use

Butler SOS can use multiple config files. Here you learn to control which one is used by Butler SOS.

Config file verification

How to verify that the Butler SOS config file is valid.

Configuring Butler SOS logging

Butler SOS can log its activities to console and disk files.
Log files can be useful for retrospective troubleshooting of Butler SOS.

Configuring Butler SOS heartbeats

Heartbeats provide a way to monitor that Butler SOS is running and working as intended.
Butler SOS can send periodic heartbeat messages to a monitoring tool, which can then alert if Butler SOS hasn’t checked in as expected.

Docker healthcheck

Docker has a concept of “health checks”, which is a way for Docker containers to tell the Docker runtime engine that the container is alive and well. Butler SOS can be configured to send such health check messages to Docker.

Configuring Butler SOS uptime monitor

Butler SOS can optionally log how long it’s been running and how much memory it uses.
Optionally the memory usage can also be stored to an InfluxDB database or sent to New Relic, for later viewing/alerting in for example a Grafana dashboard or within New Relic.

Credentials to third party services

Configuring user events

Configuring log events

Configuring the log database

Connecting to a Qlik Sense server

Details on how to configure the connection from Butler SOS to Qlik Sense Enterprise on Windows.

Setting up MQTT messaging

Butler SOS can use MQTT as a channel for pub-sub style M2M (machine to machine) messages. This page describes how to configure MQTT in Butler SOS.

Setting up the New Relic integration

Butler SOS can send metrics and events to New Relic.
This way it’s possible use their SaaS solution for storing and visualising Butler SOS data.

Setting up Prometheus

Butler SOS can store metrics in Prometheus.

Setting up InfluxDB time series database

Butler SOS can store metrics in InfluxDB.

Configuring extraction of app names from Qlik Sense

Configuring user sessions

Configure which Sense servers to monitor

Configuring telemetry

Last modified April 21, 2021: 5.6 docs RC1 (8c67a19)