Fix broken links, add info on successful QSEoW reload task emails

ptarmiganlabs · Oct 18, 2024 · 67b51ad · 67b51ad
1 parent 89a1ba2
commit 67b51ad
Show file tree

Hide file tree

Showing 45 changed files with 351 additions and 23 deletions.
diff --git a/content/en/docs/concepts/successful reloads/_index.md b/content/en/docs/concepts/successful reloads/_index.md
@@ -63,11 +63,21 @@ See [this page](/docs/getting-started/setup/reload-alerts/#adding-a-log-appender
 In the case of successful reload tasks, the UDP server will determine which app was reloaded, the duration of the reload task, who started the task etc.  
 Butler will then send this information to the enabled destinations.
 
+## Email notifications
+
+Butler can be configured to send email notifications when a reload task completes successfully.  
+The concept is the same as for failed/aborted reload tasks (described [here](/docs/concepts/failed-reloads/client-managed/alert-emails/)), except that emails are never sent to app owners for successfully completed reload tasks.
+
+Can look like this:
+
+![Email notification when reload task completes successfully](/img/butler-qseow-reload-task-success-email-1.png "Email notification when reload task completes successfully")
+
 ## Supported destinations
 
 The following destinations are supported:
 
 - InfluxDB
+- Email
 
 ### Config file settings
 
@@ -96,7 +106,50 @@ Butler:
           useAppTags: true      # Should app tags be sent to InfluxDb as tags?
           useTaskTags: true     # Should task tags be sent to InfluxDb as tags?
   ...
-  ...          
+  ...
+  # Settings needed to send email notifications when for example reload tasks fail.
+  # Reload failure notifications assume a log appender is configured in Sense AND that the UDP server in Butler is running.
+  emailNotification:
+    enable: false
+    reloadTaskSuccess:
+      enable: false
+      # Custom property used to control which task successes will cause alert emails to be sent
+      # If this setting is true, alerts will not be sent for all tasks, but *only* for tasks with the CP set to the enabledValue.
+      # If this setting is false, alerts will be sent for all failed reload tasks.
+      alertEnableByCustomProperty:
+        enable: false
+        customPropertyName: 'Butler_SuccessAlertEnableEmail'
+        enabledValue: 'Yes'
+      # Custom property used to say that alerts for a certain task should be sent to zero or more recipients
+      # These alerts will be sent irrespective of the alertEnableByCustomProperty.enable setting.
+      alertEnabledByEmailAddress:
+        customPropertyName: 'Butler_SuccessAlertSendToEmail'
+      rateLimit: 60              # Min seconds between emails for a given taskID/recipient combo. Defaults to 5 minutes.
+      headScriptLogLines: 15
+      tailScriptLogLines: 25
+      priority: high              # high/normal/low
+      subject: '✅ Qlik Sense reload success: "{{taskName}}"'
+      bodyFileDirectory: path/to/email_templates
+      htmlTemplateFile: success-reload-qseow
+      fromAddress: Qlik Sense (no-reply) <[email protected]>
+      recipients:
+        - <Email address 1>
+        - <Email address 2>
+    ...
+    ...
+    smtp:                                             # Email server settings. See https://nodemailer.com/smtp/ for details on the meaning of these fields.
+      host: <FQDN or IP or email server, e.g. smtp.gmail.com>
+      port: <port on which SMTP server is listening>
+      secure: true                                    # true/false
+      tls:
+        serverName:                                   # If specified the serverName field will be used for TLS verification instead of the host field.
+        ignoreTLS: false
+        requireTLS: true
+        rejectUnauthorized: false
+      auth:
+        enable: true
+        user: <Username, email address etc>
+        password: <your-secret-password>
 ```
 
 

diff --git a/.../docs/getting started/setup/reload alerts/client-managed/alert emails/_index.md b/.../docs/getting started/setup/reload alerts/client-managed/alert emails/_index.md
@@ -14,7 +14,7 @@ Butler can send two kinds of alert emails:
 - When a running reload task is somehow stopped/aborted.
 - When a reload task completes successfully. 
 
-See the [Concepts section](/docs/concepts/alert-emails/) for additional details and sample alert emails.
+See the [Concepts section](/docs/concepts/failed-reloads/client-managed/) for additional details and sample alert emails.
 
 ## Basic vs formatted email alerts
 

diff --git a/docs/docs/concepts/failed-reloads/client-managed/alert-emails/index.html b/docs/docs/concepts/failed-reloads/client-managed/alert-emails/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alert emails">
   <meta itemprop="description" content="Overview of the various kinds of alert emails Butler can send.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="1292">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alert emails">
@@ -612,6 +613,9 @@ <h2 id="seeing-is-believing">Seeing is believing</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/alert-emails/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/alert-emails/printview/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alert emails">
   <meta itemprop="description" content="Overview of the various kinds of alert emails Butler can send.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="1292">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alert emails">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/alerts-slack-teams/index.html b/docs/docs/concepts/failed-reloads/client-managed/alerts-slack-teams/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alerts via Slack and Microsoft Teams">
   <meta itemprop="description" content="Sending alerts to IM services like Slack and Microsoft Teams can be a great way to quickly notify people about urgent issues.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="240">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alerts via Slack and Microsoft Teams">
@@ -516,6 +517,9 @@ <h2 id="seeing-is-believing">Seeing is believing</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/alerts-slack-teams/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/alerts-slack-teams/printview/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alerts via Slack and Microsoft Teams">
   <meta itemprop="description" content="Sending alerts to IM services like Slack and Microsoft Teams can be a great way to quickly notify people about urgent issues.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="240">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alerts via Slack and Microsoft Teams">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/failed-logs-storage/index.html b/docs/docs/concepts/failed-reloads/client-managed/failed-logs-storage/index.html
@@ -38,6 +38,7 @@
   <meta itemprop="name" content="Storing script logs of failed reloads to disk">
   <meta itemprop="description" content="When investigating reload failures it can often be useful to have access to the entire reload log.
 Butler detects failed reloads and can store the entire reload log into easy to find and analyse files on disk. ">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="164">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Storing script logs of failed reloads to disk">
@@ -500,6 +501,9 @@ <h2 id="reload-script-logs">Reload script logs</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/failed-logs-storage/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/failed-logs-storage/printview/index.html
@@ -38,6 +38,7 @@
   <meta itemprop="name" content="Storing script logs of failed reloads to disk">
   <meta itemprop="description" content="When investigating reload failures it can often be useful to have access to the entire reload log.
 Butler detects failed reloads and can store the entire reload log into easy to find and analyse files on disk. ">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="164">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Storing script logs of failed reloads to disk">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/index.html b/docs/docs/concepts/failed-reloads/client-managed/index.html
@@ -38,6 +38,7 @@
   <meta itemprop="name" content="Client-managed Qlik Sense">
   <meta itemprop="description" content="Below follows a list of destinations to which Butler can send notifications when a reload task fails or is aborted.
 A comparison of the different alert destinations can be found here.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="31">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Client-managed Qlik Sense">
@@ -525,6 +526,9 @@ <h5>
                 <p>Webhooks provide a generic way to send information about failed/aborted reloads to any system that can receive HTTP POST/PUT/GET requests.<br></p>
             </div>
         </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/influxdb/index.html b/docs/docs/concepts/failed-reloads/client-managed/influxdb/index.html
@@ -39,6 +39,7 @@
   <meta itemprop="name" content="InfluxDB">
   <meta itemprop="description" content="Storing information about failed reloads in InfluxDB can be useful for monitoring and analysis purposes.  
 Once the data is in InfluxDB it can be visualized in Grafana or similar tools.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="110">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="InfluxDB">
@@ -495,6 +496,9 @@ <h2 id="configuration">Configuration</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/influxdb/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/influxdb/printview/index.html
@@ -39,6 +39,7 @@
   <meta itemprop="name" content="InfluxDB">
   <meta itemprop="description" content="Storing information about failed reloads in InfluxDB can be useful for monitoring and analysis purposes.  
 Once the data is in InfluxDB it can be visualized in Grafana or similar tools.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="110">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="InfluxDB">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/mqtt/index.html b/docs/docs/concepts/failed-reloads/client-managed/mqtt/index.html
@@ -43,6 +43,7 @@
 MQTT is a lightweight messaging protocol that is commonly used in IoT applications, but it is a mature and versatile protocol that can be used in many different scenarios.
 In short, MQTT works by having a broker that clients can connect to. Clients can publish messages to the broker, and clients can subscribe to messages from the broker.
 This makes MQTT a great way to integrate different systems in a publish/subscribe pattern.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="158">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="MQTT">
@@ -501,6 +502,9 @@ <h2 id="configuration">Configuration</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/mqtt/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/mqtt/printview/index.html
@@ -43,6 +43,7 @@
 MQTT is a lightweight messaging protocol that is commonly used in IoT applications, but it is a mature and versatile protocol that can be used in many different scenarios.
 In short, MQTT works by having a broker that clients can connect to. Clients can publish messages to the broker, and clients can subscribe to messages from the broker.
 This makes MQTT a great way to integrate different systems in a publish/subscribe pattern.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="158">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="MQTT">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/new-relic/index.html b/docs/docs/concepts/failed-reloads/client-managed/new-relic/index.html
@@ -40,6 +40,7 @@
   <meta itemprop="description" content="View reload alerts in New Relic When investigating reload failures it can often be useful to have access to the entire reload log, as this usually tells immediately what went wrong.
 Butler forwards a very comprehensive set of data to New Relic when a reload fails, including the failing part of the app’s script.
 This means that companies using New Relic as their enterprise monitoring solution can now also use it to monitor their Qlik Sense reloads, as well as all the Sense real-time metrics provided by Butler’s sibling tool Butler SOS.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="152">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="New Relic">
@@ -495,6 +496,9 @@ <h2 id="configuration">Configuration</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/new-relic/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/new-relic/printview/index.html
@@ -40,6 +40,7 @@
   <meta itemprop="description" content="View reload alerts in New Relic When investigating reload failures it can often be useful to have access to the entire reload log, as this usually tells immediately what went wrong.
 Butler forwards a very comprehensive set of data to New Relic when a reload fails, including the failing part of the app’s script.
 This means that companies using New Relic as their enterprise monitoring solution can now also use it to monitor their Qlik Sense reloads, as well as all the Sense real-time metrics provided by Butler’s sibling tool Butler SOS.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="152">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="New Relic">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/printview/index.html
@@ -38,6 +38,7 @@
   <meta itemprop="name" content="Client-managed Qlik Sense">
   <meta itemprop="description" content="Below follows a list of destinations to which Butler can send notifications when a reload task fails or is aborted.
 A comparison of the different alert destinations can be found here.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="31">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Client-managed Qlik Sense">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/signl4/index.html b/docs/docs/concepts/failed-reloads/client-managed/signl4/index.html
@@ -38,6 +38,7 @@
   <meta itemprop="name" content="Signl4">
   <meta itemprop="description" content="Signl4 is a mobile alerting app that offers an easy way to get started with monitoring and alerting in general,
 including Qlik Sense reloads via Butler&#39;s integration with Signl4. ">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="44">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Signl4">
@@ -490,6 +491,9 @@ <h2 id="configuration">Configuration</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/signl4/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/signl4/printview/index.html
@@ -38,6 +38,7 @@
   <meta itemprop="name" content="Signl4">
   <meta itemprop="description" content="Signl4 is a mobile alerting app that offers an easy way to get started with monitoring and alerting in general,
 including Qlik Sense reloads via Butler&#39;s integration with Signl4. ">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="44">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Signl4">

diff --git a/docs/docs/concepts/failed-reloads/client-managed/webhook/index.html b/docs/docs/concepts/failed-reloads/client-managed/webhook/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Webhooks">
   <meta itemprop="description" content="Webhooks provide a generic way to send information about failed/aborted reloads to any system that can receive HTTP POST/PUT/GET requests.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="178">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Webhooks">
@@ -498,6 +499,9 @@ <h2 id="configuration">Configuration</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/client-managed/webhook/printview/index.html b/docs/docs/concepts/failed-reloads/client-managed/webhook/printview/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Webhooks">
   <meta itemprop="description" content="Webhooks provide a generic way to send information about failed/aborted reloads to any system that can receive HTTP POST/PUT/GET requests.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="178">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Webhooks">

diff --git a/docs/docs/concepts/failed-reloads/cloud/alert-emails/index.html b/docs/docs/concepts/failed-reloads/cloud/alert-emails/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alert emails">
   <meta itemprop="description" content="Overview of the various kinds of alert emails Butler can send when app reloads fail in Qlik Sense Cloud.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="434">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alert emails">
@@ -525,6 +526,9 @@ <h3 id="template-fields">Template fields</h3>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/cloud/alert-emails/printview/index.html b/docs/docs/concepts/failed-reloads/cloud/alert-emails/printview/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alert emails">
   <meta itemprop="description" content="Overview of the various kinds of alert emails Butler can send when app reloads fail in Qlik Sense Cloud.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="434">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alert emails">

diff --git a/docs/docs/concepts/failed-reloads/cloud/alerts-slack-teams/index.html b/docs/docs/concepts/failed-reloads/cloud/alerts-slack-teams/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alerts via Slack and Microsoft Teams">
   <meta itemprop="description" content="Sending alerts to IM services like Slack and Microsoft Teams can be a great way to quickly notify people about urgent issues.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="221">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alerts via Slack and Microsoft Teams">
@@ -509,6 +510,9 @@ <h2 id="slack-notifications">Slack notifications</h2>
 
 
     </div>
+<div class="td-page-meta__lastmod">
+  Last modified October 18, 2024: <a href="https://github.com/ptarmiganlabs/butler-docs/commit/89a1ba21e3f4e689c05c99a06389bfb96f6be3b8">Updates wrt 13.0 (89a1ba21)</a>
+</div>
 </div>
 
           </main>

diff --git a/docs/docs/concepts/failed-reloads/cloud/alerts-slack-teams/printview/index.html b/docs/docs/concepts/failed-reloads/cloud/alerts-slack-teams/printview/index.html
@@ -36,6 +36,7 @@
 
   <meta itemprop="name" content="Alerts via Slack and Microsoft Teams">
   <meta itemprop="description" content="Sending alerts to IM services like Slack and Microsoft Teams can be a great way to quickly notify people about urgent issues.">
+  <meta itemprop="dateModified" content="2024-10-18T18:19:20+02:00">
   <meta itemprop="wordCount" content="221">
   <meta name="twitter:card" content="summary">
   <meta name="twitter:title" content="Alerts via Slack and Microsoft Teams">