Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit dd8f6ea

Browse files
committed
Update scenario doc
1 parent 4d2de6e commit dd8f6ea

File tree

3 files changed

+30
-25
lines changed

3 files changed

+30
-25
lines changed
-263 KB
Loading

alerts-detectors-notifications/slo/create-slo.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Follow these steps to create an SLO.
5151
#. For the :guilabel:`Metric type` field, select :guilabel:`Custom metric` from the dropdown menu. The SignalFlow editor appears.
5252
#. In the SignalFlow editor, you can see the following placeholder text:
5353

54-
.. code-block:: none
54+
.. code-block:: python
5555
5656
G = data('good.metric', filter=filter('sf_error', 'false'))
5757
T = data('total.metric')

alerts-detectors-notifications/slo/custom-metric-scenario.rst

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -18,31 +18,41 @@ Use custom metric as service level indicator (SLI)
1818
From the :guilabel:`Detectors & SLOs` page, Kai configures the SLI and sets up a target for their SLO. Kai follows these steps:
1919

2020
#. Kai wants to use custom metrics as the system health indicators, so they select the :guilabel:`Custom metric` from the :guilabel:`Metric type` menu.
21-
#. Kai enters the custom metrics they want to measure in the following fields:
21+
#. Kai enters following into the SignalFlow editor:
2222

23-
.. list-table::
24-
:header-rows: 1
25-
:widths: 10 20 30 40
23+
.. code-block:: python
2624
27-
* - Field
28-
- Metric name
29-
- Filters
30-
- Description
25+
G = data('synthetics.run.count', filter=filter('test', 'Monitoring Services - Emby check') and filter('success', 'true'))
26+
T = data('synthetics.run.count', filter=filter('test', 'Monitoring Services - Emby check'))
27+
28+
While Kai uses the same metric name for both the ``G`` and ``T`` variables, they use the :strong:`success` dimension to count the number of successful requests for the Emby service on the Buttercup Games website.
3129

32-
* - :guilabel:`Good events (numerator)`
33-
- :strong:`synthetics.run.count`
34-
- Kai adds the following filters for this metric:
30+
.. image:: /_images/images-slo/custom-metric-slo-scenario.png
31+
:width: 100%
32+
:alt: This image shows Kai's SLO configuration using the ``synthetics.run.count`` metric and appropriate filters.
33+
34+
.. :header-rows: 1
35+
.. :widths: 10 20 30 40
36+
37+
.. * - Field
38+
.. - SignalFlow editor
39+
.. - Filters
40+
.. - Description
41+
42+
.. * - :guilabel:`Good events (numerator)`
43+
.. - :strong:`synthetics.run.count`
44+
.. - Kai adds the following filters for this metric:
3545
36-
* :strong:`test = Emby check`
37-
* :strong:`success = true`
38-
- Kai uses the :strong:`success = true` filter to count the number of successful requests for the Emby service on the Buttercup Games website.
46+
.. * :strong:`test = Emby check`
47+
.. * :strong:`success = true`
48+
.. - Kai uses the :strong:`success = true` filter to count the number of successful requests for the Emby service on the Buttercup Games website.
3949
40-
* - :guilabel:`Total events (denominator)`
41-
- :strong:`synthetics.run.count`
42-
- Kai adds the following filter for this metric:
50+
.. * - :guilabel:`Total events (denominator)`
51+
.. - :strong:`synthetics.run.count`
52+
.. - Kai adds the following filter for this metric:
4353
44-
* :strong:`test = Emby check`
45-
- Kai uses the same metric name and the :strong:`test = Emby check` filter to track the same Synthetics Browser test. However, Kai doesn't include the :strong:`success = true` dimension filter in order to count the number of total requests for the Emby service on the Buttercup Games website.
54+
.. * :strong:`test = Emby check`
55+
.. - Kai uses the same metric name and the :strong:`test = Emby check` filter to track the same Synthetics Browser test. However, Kai doesn't include the :strong:`success = true` dimension filter in order to count the number of total requests for the Emby service on the Buttercup Games website.
4656
4757
#. Kai enters the following fields to define a target for their SLO:
4858

@@ -64,11 +74,6 @@ From the :guilabel:`Detectors & SLOs` page, Kai configures the SLI and sets up a
6474

6575
#. Kai subscribes to receive an alert whenever there is a breach event for the SLO target.
6676

67-
.. image:: /_images/images-slo/custom-metric-slo-scenario.png
68-
:width: 100%
69-
:alt: This image shows Kai's SLO configuration using the ``synthetics.run.count`` metric and appropriate filters.
70-
71-
7277
Summary
7378
=======================
7479

0 commit comments

Comments
 (0)