Setup

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

Which config file to use

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

Connecting to a Qlik Sense server

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

Enabling endpoints in Butler's REST API

API endpoints can be individually enabled/disabled. By only enabling the endpoints needed for your Qlik Sense environment, memory usage is minimised and security maximised.

Reload related alerts

Butler offers a lot of flexibility when it comes to alerts when reloads fail or are aborted.
Learn how to set up the desired features, the alert layout, formatting and more.

Configuring the Butler scheduler

Butler’s scheduler complements the Qlik Sense built-in scheduler with more flexible triggers and a devops friendly API/file format for storing scheduling data.

Configuring the key-value store

Butler contains a key-value store that is accessible via the REST API.

Configuring file system access via REST API

Butler contains REST API endpoints for moving, copying and deleting files.

Setting up MQTT messaging

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

Configuring Butler heartbeats

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

Configuring Butler metrics & monitoring

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

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 can be configured to send such health check messages to Docker.

Creating Sense data connections

If you intend to call Butler’s REST API from the load script of Sense apps, you must create a few data connections first. A couple of them are mandatory, one is optional.

Forwarding user activity events to Butler

Butler can receive and act on any user event detected in the Sense log files. This page describes how to set this up using Sense log appenders.

Configuring telemetry


Last modified 2021-04-22: First commit (c105eb7)