Which config file to use
Butler SOS can use multiple config files. Here you learn to control which one is used by Butler SOS.
Setup
Everything you wanted to know about Butler SOS configuration but never dared to ask.
Butler SOS 12.0.0 Features
Butler SOS 12.0.0 includes important configuration options for enhanced security and operational flexibility:
systemInfo Configuration Setting
The new Butler-SOS.systemInfo.enable setting allows you to control whether Butler SOS gathers detailed system information about the host it’s running on. This setting addresses enterprise security concerns where the underlying systeminformation npm package executes OS commands that may be flagged by security monitoring tools.
Key points:
- Default value:
true(maintains backward compatibility) - Security consideration: Set to
falsein environments where OS command execution is restricted - Telemetry dependency: If telemetry is enabled, systemInfo must also be enabled
For detailed configuration information, see the Configuration File Format reference.
Conditional Validation
Butler SOS 12.0.0 also introduces conditional validation, meaning that configuration settings for disabled features are no longer validated. This allows you to leave placeholder values from production templates for features you have disabled without encountering validation errors.
Config file verification
How to verify that the Butler SOS config file is valid.
Visualise the config file
Butler SOS can visualise its config file on a web page, using an internal web server.
This can be useful for troubleshooting and understanding how Butler SOS is configured.
The configuration can optionally be obfuscated to hide sensitive information.
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.
General Sense event settings
Butler SOS can act as a receiver of Qlik Sense events, sent as UDP messages from Qlik Sense Enterprise.
This section of the config file contains general settings for how Butler SOS should handle these events.
More specific settings for each event type (user, log, …) can be found in the respective sections of the config file.
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 visualizing 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.