Skip to content

Commit

Permalink
Update with better docs around log events
Browse files Browse the repository at this point in the history
  • Loading branch information
@mountaindude
mountaindude committed Feb 18, 2022
1 parent e03c2f8 commit c1de56d
Show file tree
Hide file tree
Showing 72 changed files with 253 additions and 160 deletions.
19 changes: 17 additions & 2 deletions content/en/_index.html
View file
Expand Up @@ -12,8 +12,12 @@
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/ptarmiganlabs/butler-sos/releases" target="_blank">
Download <i class="fab fa-github ml-2 "></i>
</a>
<p class="lead mt-5">If you don't measure it, you can't improve it.
</p>
<p class="lead mt-5">Warnings lead to errors ➡️ Errors lead to unhappy users ➡️ Unhappy users call you</p>
<p class="lead mt-2">Wouldn't you rather get the warnings yourself, before anyone else?</p>


<p class="lead mt-5"></p>
<p class="-bg-primary p-2 display-4">If you don't measure it, you can't improve it. </p>

<div class="mx-auto mt-5">
{{< blocks/link-down color="info" >}}
Expand Down Expand Up @@ -55,6 +59,17 @@
{{% /blocks/lead %}}


{{% blocks/lead color="info" %}}
**--- Can I get alerts when errors or warnings occur in Qlik Sense? ---**

Yes! In version 7 Butler SOS added a new, unique feature: Real-time monitoring of Qlik Sense log events.

This means that you get notifications about warnings or errors within seconds of them happening in your Sense server(s). You can take action within minutes rather than hours or days.

The same concept also works for user events. Need to track sessions over time or alert when a users from a certain department logs on? No problem.
{{% /blocks/lead %}}



{{% blocks/lead color="primary" %}}
**--- We use system \<*our-preferred-monitoring–tool*\> for monitoring. Can it be used with Butler SOS? ---**
Expand Down
30 changes: 27 additions & 3 deletions content/en/docs/concepts/errors warnings/_index.md
View file
Expand Up @@ -13,12 +13,13 @@ description: >
Wouldn't you rather get the warnings yourself, before anyone else?
---

## Sense log files
## Sense log events

Sense creates a large number of log files for the various parts of the larger Qlik Sense Enterprise environment.
Those logs track more or less everything - from extensions being installed, users logging in, to incorrect structure of Active Directory user directories.

Butler SOS monitors select parts of these logs and provides a way to get an aggregated, close to real-time view into warnings and errors.
Butler SOS monitors select parts of these logs and provides a way to get an aggregated, close to real-time view into warnings and errors.

The [log events](/docs/getting_started/setup/log-events/) page has more info on this.

## Grafana dashboards
Expand All @@ -28,8 +29,14 @@ It is therefore possible to create Grafana dashboards that combine both operatio

Showing warnings and errors visually is often an effective way to quickly identify developing or recurring issues.

### Example 1: Circular Active Directory references

Here is an example where bursts of warnings tell us visually that something is not quite right.
We can then look at the actual warnings to see what's going on.
50-60 warnings arriving in bursts every few minutes - something is not right.
There is also a single error during this time period - what's going on there?

We can then look at the actual warnings (=log events) to see what's going on.

In this case it turns out to be circular references in the Active Directory data used in Qlik Sense. Not a problem with Sense per se, but still something worth looking into:

![Warnings and errors from Qlik Sense in Grafana dashboard](butler-sos-warnings-errors-graph-1.png "Warnings and errors from Qlik Sense in Grafana dashboard")
Expand All @@ -40,6 +47,23 @@ Looking at that single error then, it turns out it's caused by a task already ru

![Errors from Qlik Sense in Grafana table](butler-sos-errors-table-1.png "Errors from Qlik Sense in Grafana table")

### Example 2: Session bursts causing proxy overload

This example is would have been hard or impossible to investigate without Butler SOS.

The problem was that the Sense environment from time to time became very slow or even unresponsive. A restart solved the problem.

Grafana was set up to send alerts when session count increase very rapidly. Thanks to this actions could be taken within minutes from the incident occuring.

Looking in the Grafana dashboard could then show something like below.
New sessions started every few seconds, all coming from a single client. The effect for this Sense user was that Sense was unresponsive.

The log events section of the Grafana dashboard showed that this user had been given 5 proxy sessions, after which further access to Sense internal resources (engine etc) was denied.

![Sessions increasing very quickly](butler-sos-session-runaway-1.png "Qlik Sense sessions increasing very quickly")

In this case the problem was caused by a mashup using iframes that when recovering from session timeouts caused race conditions, trying to re-establish a session to Sense over and over again.

## Alerts

Grafana includes a set of built-in alert features that can be used to set up alerts as well as forward them to destinations such as Slack, MS Teams, email, Discord, Kafka, Webhooks, PagerDuty and others.
Expand Down
Binary file added content/en/docs/concepts/errors warnings/butler-sos-session-runaway-1.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/404.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -195,7 +195,7 @@ <h1 id="title">Not found</h1>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/about/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<link rel="alternate" type="application/rss&#43;xml" href="https://butler-sos.ptarmiganlabs.com/about/index.xml">
<meta name="robots" content="index, follow">

Expand Down Expand Up @@ -380,7 +380,7 @@ <h4 class="h3">Logging revisited</h4>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2019/10/17/new-documentation-site-for-butler-sos/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -344,7 +344,7 @@ <h1>New documentation site for Butler SOS</h1>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2019/10/17/v5.0.0-user-sessions-influxdb-logs-and-more/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -336,7 +336,7 @@ <h2 id="new-features">New features</h2>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2019/10/22/v5.0.1-fixing-a-few-typos-clarifying-a-few-things/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -329,7 +329,7 @@ <h1>v5.0.1: Fixing a few typos, clarifying a few things</h1>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2020/05/04/v5.2.0-app-names-heartbeats/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -333,7 +333,7 @@ <h1>v5.2.0: App names &amp; heartbeats</h1>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2020/05/05/v5.3.0-sorted-out-some-issues-with-app-names/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -327,7 +327,7 @@ <h1>v5.3.0: Sorted out some issues with app names</h1>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2020/05/29/v5.4.0-sorted-out-some-issues-with-app-names/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -337,7 +337,7 @@ <h1>v5.4.0: Sorted out some issues with app names</h1>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/2020/07/15/v5.5.0-multi-architecture-support-for-docker-images/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -332,7 +332,7 @@ <h1>v5.5.0: Multi architecture support for Docker images</h1>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<link rel="alternate" type="application/rss&#43;xml" href="https://butler-sos.ptarmiganlabs.com/blog/index.xml">
<meta name="robots" content="index, follow">

Expand Down Expand Up @@ -540,7 +540,7 @@ <h5 class="mt-0 mb-1"><a href="/blog/2019/10/17/new-documentation-site-for-butle

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/news/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<link rel="alternate" type="application/rss&#43;xml" href="https://butler-sos.ptarmiganlabs.com/blog/news/index.xml">
<meta name="robots" content="index, follow">

Expand Down Expand Up @@ -341,7 +341,7 @@ <h5 class="mt-0 mb-1"><a href="/blog/2019/10/17/new-documentation-site-for-butle

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/blog/releases/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<link rel="alternate" type="application/rss&#43;xml" href="https://butler-sos.ptarmiganlabs.com/blog/releases/index.xml">
<meta name="robots" content="index, follow">

Expand Down Expand Up @@ -499,7 +499,7 @@ <h5 class="mt-0 mb-1"><a href="/blog/2019/10/17/v5.0.0-user-sessions-influxdb-lo

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/community/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<link rel="alternate" type="application/rss&#43;xml" href="https://butler-sos.ptarmiganlabs.com/community/index.xml">
<meta name="robots" content="index, follow">

Expand Down Expand Up @@ -254,7 +254,7 @@ <h2>Develop and Contribute</h2>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/about/butler-family/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -572,7 +572,7 @@ <h2 class="feedback--title">Feedback</h2>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/about/butler-sos/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -527,7 +527,7 @@ <h2 class="feedback--title">Feedback</h2>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/about/contributing/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<meta name="robots" content="index, follow">


Expand Down Expand Up @@ -638,7 +638,7 @@ <h2 class="feedback--title">Feedback</h2>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/about/index.html
View file
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<meta name="generator" content="Hugo 0.89.4" />
<meta name="generator" content="Hugo 0.92.0" />
<link rel="alternate" type="application/rss&#43;xml" href="https://butler-sos.ptarmiganlabs.com/docs/about/index.xml">
<meta name="robots" content="index, follow">

Expand Down Expand Up @@ -580,7 +580,7 @@ <h2 class="feedback--title">Feedback</h2>

</div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2">
<small class="text-white">&copy; 2021 Ptarmigan Labs AB All Rights Reserved</small>
<small class="text-white">&copy; 2022 Ptarmigan Labs AB All Rights Reserved</small>


<p class="mt-2"><a href="/about/">About Butler SOS</a></p>
Expand Down

0 comments on commit c1de56d

Please sign in to comment.