Be notified of new releases
Create your free GitHub account today to subscribe to this repository for new releases and build software alongside 36 million developers.Sign up
With version 4 several features are added, many of them intended to make it easier to monitor large scale Qlik Sense environments.
- Improved tagging of data logged in Influxdb. Data can now be tagged with any number of user defined tags. This makes it possible to create much more refined dashboards in Grafana. NOTE: these configurable tags are not compatible with previous Influx database schemas. The SenseOps database in Influxdb must be deleted before deploying Butler SOS v3.2. Next time Butler SOS is started a new SenseOps database in Influxdb will be created.
- Let the user control (by means of properties in the config file) which entries are extracted from Qlik Sense log db. This is configured on a per log level basis, for example "extract warning and errors, but not info messages".
- Added optional logging to disk file. If enabled, log files are rotated daily and stored for 30 days, after which they are automatically deleted.
Turns out that Qlik Sense sometimes creates empty error and warning messages in its log files.
That's probably fine from a Sense perspective, but it caused InfluxDB to get hiccups when it got those empty (actually they were all together missing) strings.
Fixed now, InfluxDb is a happy camper again.
The main new feature of v3.1 is the optional storage of what Qlik Sense apps are loaded, active and in_memory at each call Butler SOS does to the Qlik Sense healthcheck API.
This information can be critically important when dealing with large Sense apps that consume too much RAM when loaded from disk into RAM, potentially bringing the entire server to its knees.
Note that on a busy server with many apps loaded into RAM, enabling any of the new config options will significantly increase the amount of data stored in InfluxDB. For debugging purposes that is typically fine, but you should probably not have these new options enabled in a production setting.
Classify each monitored server with a serverGroup property to get Grafana dashboards that update automatically as Qlik Sense servers are added/removed from the Butler SOS config file.
Great for Qlik Sense environments that have separate production and development servers, for example.
A small release, but still nice for those running Butler SOS in Docker:
- FEATURE: Add support for Docker health checks.
- BUG: Only attempt Influxdb connection when Influxdb is actually enabled in Butler SOS config file.
- Misc upgrades of dependencies.
In some cases you don't want to query the Qlik Sense log database from Butler SOS.
A new config setting (Butler-SOS.logdb.enableLogDb) in the configuration YAML file controls whether log db will be queried for warnings/errors or not. If set to true querying will be done, any other value means no querying.
Docker is in fact the preferred way of running Butler SOS - it's quick and easy to get started, no installation of Node.js needed etc.
More info over at ptarmiganlabs.com.