Setup

Everything you need to know about Butler SOS configuration.

Overview

Once Butler SOS is installed, you need to configure it to work with your Qlik Sense environment.

Butler SOS uses a YAML configuration file that controls all aspects of its operation. The configuration file is comprehensive and allows you to:

• Connect to your Qlik Sense server(s)
• Configure which metrics to collect
• Set up data destinations (InfluxDB, Prometheus, New Relic, MQTT)
• Enable/disable various features
• Configure logging and monitoring of Butler SOS itself

Butler SOS 12.0 Features

Butler SOS 12.0 includes important configuration options for enhanced security and operational flexibility:

systemInfo Configuration Setting

The 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 false in 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 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.

Configuration Topics

The setup section is organized into the following topics:

Basic Configuration

• Which Config File? - How Butler SOS selects its configuration file
• Verify Config File - How to validate your configuration
• Config Visualization - Visualize the active configuration
• Logging - Configure Butler SOS logging
• Crash Dump - Configure crash dump file creation

Monitoring & Health

• Heartbeats - Send heartbeat messages to monitoring tools
• Docker Healthcheck - Docker container health checks
• Uptime Monitor - Track Butler SOS uptime and memory usage

Qlik Sense Connection

• Sense Server Settings - Connect to Qlik Sense
• Audit Screenshots - Configure Audit.qs screenshot downloads, ticket auth, and allowed hosts
• Servers to Monitor - Configure which servers to monitor
• App Names - Configure app name extraction
• User Sessions - Configure user session monitoring

Data Destinations

• InfluxDB - Store metrics in InfluxDB
• Prometheus - Expose metrics for Prometheus
• New Relic - Send data to New Relic
• MQTT - Publish metrics via MQTT
• Credentials - Manage third-party service credentials

Qlik Sense Events

• Qlik Sense Events Overview - General event settings
• Log Events - Capture log events
• Performance Log Events - Detailed engine performance data
• User Events - Track user activity

Other Settings

• Error Tracking - Track and log errors across Butler SOS
• Telemetry - Anonymous telemetry configuration