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

Commit 4008b06

Browse files
committed
Elaborate on the SignalFlow program example in the scenario doc
1 parent 4809621 commit 4008b06

File tree

1 file changed

+9
-23
lines changed

1 file changed

+9
-23
lines changed

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

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,42 +17,26 @@ Use custom metric as service level indicator (SLI)
1717

1818
From the :guilabel:`Detectors & SLOs` page, Kai configures the SLI and sets up a target for their SLO. Kai follows these steps:
1919

20-
#. Kai wants to use custom metrics as the system health indicators, so they select the :guilabel:`Custom metric` from the :guilabel:`Metric type` menu.
20+
#. Kai wants to use a Synthetics metric as the system health indicators, so they select the :guilabel:`Custom metric` from the :guilabel:`Metric type` menu.
2121
#. Kai enters following into the SignalFlow editor:
2222

2323
.. code-block:: python
2424
2525
G = data('synthetics.run.count', filter=filter('test', 'Monitoring Services - Emby check') and filter('success', 'true'))
2626
T = data('synthetics.run.count', filter=filter('test', 'Monitoring Services - Emby check'))
2727
28-
While Kai uses the same metric name for both the ``G`` and ``T`` variables, they use the ``success`` dimension to count the number of successful requests for the Emby service on the Buttercup Games website.
28+
Kai defines variables ``G`` and ``T`` as two streams of ``synthetics.run.count`` metric time series (MTS) measuring the health of requests sent to the Emby service.
29+
30+
To distinguish between the two data streams, Kai applies an additional filter on the ``success`` dimension in the definition for ``G``. This filter queries for a specific collection of MTS that track successful requests for the Emby service.
31+
32+
In Kai's SignalFlow program, ``G`` is a data stream of good events and ``T`` is a data stream of total events.
2933

3034
.. image:: /_images/images-slo/custom-metric-slo-scenario.png
3135
:width: 100%
3236
:alt: This image shows Kai's SLO configuration using the ``synthetics.run.count`` metric and appropriate filters.
3337

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:
45-
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.
4938

50-
.. * - :guilabel:`Total events (denominator)`
51-
.. - :strong:`synthetics.run.count`
52-
.. - Kai adds the following filter for this metric:
53-
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.
39+
#. Kai assigns ``G`` to the :guilabel:`Good events (numerator)` dropdown menu, and ``T`` to the :guilabel:`Total events (denominator)` dropdown menu.
5640

5741
#. Kai enters the following fields to define a target for their SLO:
5842

@@ -85,3 +69,5 @@ Learn more
8569
For more information about creating an SLO, see :ref:`create-slo`.
8670

8771
For more information about the Synthetics Browser test, see :ref:`browser-test`.
72+
73+
For more information on SignalFlow, see :new-page:`Analyze data using SignalFlow <https://dev.splunk.com/observability/docs/signalflow>` in the Splunk Observability Cloud Developer Guide.

0 commit comments

Comments
 (0)