butler-sos-v7.0.0

If you plan to run Butler SOS...

• ... as a native Node.js app you should get the downloadable package from the links below.
• ... in a Docker container, you find the needed image on Docker Hub.

Full documentation is available at https://butler-sos.ptarmiganlabs.com.

---

⚠ BREAKING CHANGES

• Log event handling in Butler SOS.
  A replacement for log db, which is no longer part of Qlik Sense Enterprise on Windows (QSEoW).
  The Butler SOS "log event" feature provide close to real-time insight into warnings and errors as they happen in QSEoW.
• Starting phasing out log db support.
  In a first step some of the settings in the main config file are renamed, with more focus shifting to the new log event feature.
• Add more control to user event MQTT msgs.
  When user events occur there is now more fine grained control over what is sent as MQTT messages. The config file has new fields to control this new feature.

Features

• Log event handling in Butler SOS (c082dbb)
• Add more control to user event MQTT msgs (85b7bbd)
• MQTT topics follow QSEoW subsystems (370a4ba)
• Starting phasing out log db support (d51d0bd)
• telemetry: Show instance ID on startup (c7277a7)

Bug Fixes

• Add port mappings to docker-compose file (18436cc)
• All MQTT substopics now lower case (6c4b209)
• Remove unused config file entries (93a69b3)
• Replace outdated scheduling library (8648cd3)

Refactoring

• Align handling of user and log events (efe0064)

Miscellaneous

• deps: Update dependencies to latest ver. (72b170b)
• deps: update prom/prometheus docker tag to v2.31.1 (62ead06)
• deps: Update systeminformation, snyk and eslint-plugin-import (f9e9481)
• Update dependencies (b9be7ed)

butler-sos-v6.1.2

Bug Fixes

• deps: update dependency axios to ^0.24.0 (c4a972a)

Miscellaneous

• deps: update dependency snyk to v1.753.0 (1ad9292)
• deps: update prom/prometheus docker tag to v2.31.0 (e6fbc32)

butler-sos-v6.1.1

Miscellaneous

• deps: pin dependency snyk to 1.741.0 (92d2997)
• deps: update influxdb docker tag to v1.8.10 (99f5b27)
• deps: update prom/prometheus docker tag to v2.30.3 (a35b331)
• deps: Updated dependencies (dbd3476)

butler-sos-v6.1.0

Features

• docker: Build Docker images on Node 16 (0f7c6e1)

butler-sos v6.0.2

Bug Fixes

• deps: update dependency fastify-metrics to v8 (f9e001a)

butler-sos v6.0.1

Bug Fixes

• Consistent log directory name (4dd53ae)
• Remove extra log files (#209) (f52eab8)

butler-sos v6.0.0

⚠ BREAKING CHANGES

• Extensive changes throughout the tool

Features

• 1st version of user events monitoring, #147 (c5468d7)
• add metrics for Prometheus (7cee28d)
• Add Node.js metrics to Prometheus endpoint (fb66055)
• Added Snyk scanning (f6791b7)
• Implements #148 (4fde651)
• Make TLS cert verification optional (#178) (132e502)
• Session blacklist for InfluxDB, #62 (de4849f)
• Switch to Luxon instead of Moment. #150 (358ff4a)
• User event tags in config file, #153 (fc341d4)
• Work towards several issues (5bed9fc)

Bug Fixes

• 102, #101 (396b267)

Code Refactoring

• Extensive changes throughout the tool (b0e5af3)

Updated dependencies & change Docker build

Nothing major:

• Updated dependencies to latest versions
• Switched to using GitHub Actions for building linux/amd64 images.

Documentation update

A PDF walking you through installing Butler SOS on Windows as been added to the docs folder.

The walkthrough covers Butler SOS 5.0.1. Things have changed since then - new features added, config parameters changed.
Still, it's a good read as it shows what basic steps are needed!

Welcome, user events! Good to have you here!

Some good new features in this release, most notably the detailed session start/stop and connection open/close (when users login/logout and open/close apps, respectively) have moved from the Butler project to its new home here in Butler SOS.
That particular feature has a much more natural home in Butler SOS, so this is where it will live from here on.

New features

1. Added exclude lists for user sessions. If some user accounts (such as system accounts) should not be included in the tracking of user sessions, just add them to the exclude list in the config file. (#62)
2. Copy user activity tracking ("user events") concept from Butler. That feature belongs to the domain handled by Butler SOS, so it's moved here instead. Future development will happen here rather than in the Butler project. (#147
3. Added user exclude list to user events config. #151
4. Added the ability to specify arbitrary tags that is attached to the user event metrics when stored in InfluxDB. #153)
5. Anonymous telemtry added. The data included in the telemetry data is a) what kinf of computer (Windows/Linux, Node.js version etc) Butler SOS runs on, and b) which features are enabled. That's it - no identifiable data what so ever, and of course no actual metrics. (#148)
6. Documented the dependency on InfluxDB 1.x, rather than the most recent version 2.x. The latest version is awesome but has some breaking changes which cause it to fail when used with Butler SOS. (#152)

Fixes and patches

1. Dependencies updated to stay sharp and secure.
2. Fixed some typos, made some log texts more descriptive. (#149 and more)
3. Replaced the end-of-life Moment.js library with Luxon.js. (#150)
4. A bit saner logging in Butler log files when some Sense servers in a cluster were not described in Butler SOS config file. (#155)

Changed behavior and/or breaking changes

1. The Butler SOS config file has not been very consistent when it comes to using "enable", "enabled" and variants thereof. Confusing. With this version we're cleaning up some of those variants.
   Going forward "enable" is used in Butler SOS (and also in more and more of the other Butler tools. Most of the cases fixed in this release, some remain as todos.
   Using the latest config file syntax is strongly recommended, but efforts have been made to ensure that the old "enabled" variants also work for time being.). (#154)