Skip to content

Releases: ptarmiganlabs/butler

butler: v8.0.0

20 May 11:43
b68b41c
Compare
Choose a tag to compare

8.0.0 (2022-05-20)

With this version 8 Butler gets proper support for using New Relic as a destination for both failed/aborted reload events as well as more comprehensive script logs for failed/aborted reloads.

This means:

  • Reload failed/aborted events can be forwarded to New Relic (as new relic "events").
  • The same comprehensive metadata that was previously only available in alert emails/Slack/Teams messages is also sent to New Relic. This includes
    • The last x lines of the script log. Makes it a lot easier to right away understand what caused a reload to fail.
    • A complete list of all the states (started, running, failed...) a task went through, include timestamps
    • App name, app ID, task name, task ID
    • User that stopped/aborted a task in the QMC
    • ...

While self-hosted InfluxDB + Grafana arguably still gives more flexibility and better looking SenseOps dashboards, at least InfluxDB has to be self hosted.
By using New Relic for storage of the reload failed/aborted events data generated by Butler, we get a solution that only require a single component to be installed in your network: Butler itself.

Bottom line is that Butler + New Relic is currently the fastest and easiest way to first-class reload failed alerts for client-managed Qlik Sense Enterprise on Windows.

The breaking change in this version consist of a changed format of Butler's config file.
This was needed to support the various features offered by New Relic, as well as prepare for more New Relic related features being added to Butler in the future.

⚠ BREAKING CHANGES

  • Forward script logs for failed and aborted reloads to New Relic

Features

  • Command line option for sending test email (4899e6c), closes #430
  • Forward script logs for failed and aborted reloads to New Relic (d1237ab), closes #460

Miscellaneous

  • deps: Updated dependencies (7e3aed0)

butler: v7.5.1

16 May 19:56
5ae5505
Compare
Choose a tag to compare

7.5.1 (2022-05-16)

Bug Fixes

  • config: Disable API-generate-doc setting in sample config file (0b4a784), closes #453
  • config: Disable sending alerts to New Relic in sample config file (38219f6), closes #452

butler: v7.5.0

15 May 19:24
5c4b299
Compare
Choose a tag to compare

7.5.0 (2022-05-15)

Small release that adds automatic creation of the API documentation files.
This greatly reduces (eliminates, really...) the risk of the API docs not being updated after some change has been made to Butler's REST API.

Features

  • Automatic cration of API docs as part of CI pipeline (7ecf05b), closes #444

butler: v7.4.0

14 May 20:41
342a2d7
Compare
Choose a tag to compare

7.4.0 (2022-05-14)

Features

  • Enable/disable alert emails per reload task. (3a2a9f6)
  • Base alert email rate limits on taskId + email address combination (bc07935), closes #424
  • Add config setting to enable create-API-docs-mode (d9127f0), closes #447
  • API endpoint for sending gauge metrics to New Relic (13063a0), closes #440

Bug Fixes

  • API docs REST endpoint doesn't work for pre-built binaries (53cf3fa), closes #443
  • Change name of New Relic event for failed and aborted reload tasks (d81ab39), closes #418
  • Change New Relic metric names for Butler uptime metrics (6ead1f6), closes #419
  • REST API docs not showing (bef031f), closes #442
  • Verify that Slack/Teams message template file exists before opening it. (0a44792), closes #427

Refactoring

  • Change Butler's log prefixes for failed reloads (5d6e19b), closes #425
  • Enable better logging of errors to console (f52d716), closes #434
  • Make source code file names consistent throughout Butler (590285a), closes #422

Miscellaneous

  • deps: pin dependency snyk to 1.931.0 (b04767b)
  • deps: Update dependencies (7e95736)
  • deps: update dependency jest to v28.0.3 (918cad1)
  • deps: update dependency jest to v28.1.0 (910eb8a)
  • deps: update dependency snyk to v1.914.0 (2fc2275)
  • deps: update dependency snyk to v1.922.0 (769fadd)
  • deps: update Fastify plugins (f16c0fb)
  • deps: Updated dependencies (d957494)
  • Source code formatting (f8b6e1c)

butler: v7.3.2

25 Apr 20:22
159c947
Compare
Choose a tag to compare

7.3.2 (2022-04-25)

Bug Fixes

  • Add New Relic fields to sample/template config file (9f7db18), closes #411

Miscellaneous

  • deps: Update dependencies to latest versions. (a0f6b8d)

butler: v7.3.0

25 Apr 17:20
5fe038d
Compare
Choose a tag to compare

7.3.0 (2022-04-25)

Features

  • Add rate limiting to Butler's REST API (852346d), closes #403
  • Optionally send uptime metrics to New Relic (4417a3a), closes #398
  • Send failed/aborted task events to New Relic (575f256), closes #400

Bug Fixes

  • Better parsing of Sense log files before sent to Teams/Slack (b95ad05), closes #408
  • Include Signl4 status in telemetry data (0f21774), closes #402
  • Incorrect telemetry status (true/false) for uptime data sent to InfluxDB (9eb7ebd), closes #401

Miscellaneous

  • deps: update dependency jest to v28 (f3df976)
  • deps: update node.js to v18 (433b9dc)
  • deps: Updated dependencies (99a84a5)

butler: v7.2.1

19 Apr 14:32
57ce744
Compare
Choose a tag to compare

7.2.1 (2022-04-19)

No new features but staying safe: Updated dependencies to get latest patches and security updates.

Miscellaneous

  • deps: Pin dev dependencies (871f9fb)
  • deps: Update dependencies to latest versions (7d18589)

butler: v7.2.0

07 Apr 08:17
e5ba139
Compare
Choose a tag to compare

7.2.0 (2022-04-07)

Features

  • Create standalone binaries for Win, macOS, Linux (6ae4e43)
  • Store failed reload logs to disk for later analysis (137dd60)
  • Make a few important config options available as command line parameters. Specifically, the config file to use and the log level can be specified via command line options --configfile and --loglevel, respectively. #381

Bug Fixes

  • Better error checking when calling Sense APIs (3b3d76e), closes #386
  • Clean up Docker image and release ZIP files (cb715b9), closes #361
  • Handle long script logs in MS Teams (98ddbe3), closes #389
  • Handle long script logs in Slack notifications without crashing. (d43e024), closes #388

Miscellaneous

  • deps: pin dependency jest to 27.5.1 (6326d20)
  • deps: Pin versions of dev dependencies (723da92)
  • deps: Update dependencies (e6cae58)

butler: v7.1.3

24 Mar 07:52
bc15966
Compare
Choose a tag to compare

7.1.3 (2022-03-24)

Update dependencies to stay secure.

Miscellaneous

  • deps: update dependency eslint-config-prettier to v8.5.0 (cdbc60b)
  • deps: update dependency fastify-swagger to v5 (d9a89fe)
  • deps: update dependency express-handlebars to 5.3.1 [security] (616a07e)
  • deps: update dependency nodemailer-express-handlebars to v5 (a9ab9c2)
  • Update dep Prettier (46c96fa)
  • Update dependencies (daaf3e2)

butler: v7.1.2

15 Feb 07:42
1858f1c
Compare
Choose a tag to compare

7.1.2 (2022-02-15)

Bug Fixes

  • deps: update dependency axios to ^0.26.0 (71ef323)

Refactoring

  • Better logging for API file operations endpoints (0001e7d), closes #348

Miscellaneous

  • deps: update dependency jest to v27.5.1 (9399294)
  • deps: update dependency snyk to v1.852.0 (943c448)