Merge pull request #2308 from splunk/trangl-o11ydocs-6195-slo-signalflow-editor

Update SLO custom metric creation flow with SignalFlow editor

Author: trangl-splunk

_images/images-slo/custom-metric-slo-scenario.png

@@ -19,7 +19,7 @@ Follow these steps to create an SLO.
 #. From the landing page of Splunk Observability Cloud, go to :strong:`Detectors & SLOs`.
 #. Select the :strong:`SLOs` tab.
 #. Select :guilabel:`Create SLO`.
-#. Configure the service level indicator (SLI) for your SLO.
+#. Configure the service level indicator (SLI) for your SLO. You can use a service or any metric of your choice as the system health indicator.
 
     To use a service as the system health indicator for your SLI configuration, follow these steps:
 
@@ -46,21 +46,22 @@ Follow these steps to create an SLO.
           * - :guilabel:`Filters`
             - Enter any additional dimension names and values you want to apply this SLO to. Alternatively, use the ``NOT`` filter, represented by an exclamation point ( ! ), to exclude any dimension values from this SLO configuration.
 
-    To use a custom metric as the system health indicator for your SLI configuration, follow these steps:
+    To use a metric of your choice as the system health indicator for your SLI configuration, follow these steps:
 
-        .. list-table::
-          :header-rows: 1
-          :widths: 40 60
-          :width: 100%
+        #. For the :guilabel:`Metric type` field, select :guilabel:`Custom metric` from the dropdown menu. The SignalFlow editor appears.
+        #. In the SignalFlow editor, you can see the following code sample:
 
-          * - :strong:`Field name`
-            - :strong:`Actions`
-          * - :guilabel:`Metric type`
-            - Select :guilabel:`Custom metric` from the dropdown menu
-          * - :guilabel:`Good events (numerator)`
-            - Search for the metric you want to use for the success request count
-          * - :guilabel:`Total events (denominator)`
-            - Search for the metric you want to use for the total request count
+              .. code-block:: python
+
+                  G = data('good.metric', filter=filter('sf_error', 'false'))
+                  T = data('total.metric')
+              
+              * Line 1 defines ``G`` as a data stream of ``good.metric`` metric time series (MTS). The SignalFlow ``filter()`` function queries for a collection of MTS with value ``false`` for the ``sf_error`` dimension. The filter distinguishes successful requests from total requests, making ``G`` the good events variable.
+              * Line 2 defines ``T`` as a data stream ``total.metric`` MTS. ``T`` is the total events variable.
+
+           Replace the code sample with your own SignalFlow program. You can define good events and total events variables using any metric and supported SignalFlow function. For more information, see :new-page:`Analyze data using SignalFlow <https://dev.splunk.com/observability/docs/signalflow>` in the Splunk Observability Cloud Developer Guide.
+        
+        #. Select appropriate variable names for the :guilabel:`Good events (numerator)` and :guilabel:`Total events (denominator)` dropdown menus.
 
         .. note:: Custom metric SLO works by calculating the percentage of successful requests over a given compliance period. This calculation works better for counter and histogram metrics than for gauge metrics. Gauge metrics are not suitable for custom metric SLO, so you might get confusing data when selecting gauge metrics in your configuration.
 

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

@@ -17,32 +17,22 @@ Use custom metric as service level indicator (SLI)
 
 From the :guilabel:`Detectors & SLOs` page, Kai configures the SLI and sets up a target for their SLO. Kai follows these steps: 
 
-#. Kai wants to use custom metrics as the system health indicators, so they select the :guilabel:`Custom metric` from the :guilabel:`Metric type` menu.
-#. Kai enters the custom metrics they want to measure in the following fields:
+#. 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.
+#. Kai enters following program into the SignalFlow editor:
 
-    .. list-table::
-        :header-rows: 1
-        :widths: 10 20 30 40
+      .. code-block:: python
 
-        * - Field
-          - Metric name
-          - Filters
-          - Description 
+          G = data('synthetics.run.count', filter=filter('test', 'Monitoring Services - Emby check') and filter('success', 'true'))
+          T = data('synthetics.run.count', filter=filter('test', 'Monitoring Services - Emby check'))
 
-        * - :guilabel:`Good events (numerator)`
-          - :strong:`synthetics.run.count`
-          - Kai adds the following filters for this metric:
-            
-              * :strong:`test = Emby check`
-              * :strong:`success = true`
-          - Kai uses the :strong:`success = true` filter to count the number of successful requests for the Emby service on the Buttercup Games website.
+   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. 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. In Kai's SignalFlow program, ``G`` is a data stream of good events and ``T`` is a data stream of total events.
 
-        * - :guilabel:`Total events (denominator)`
-          - :strong:`synthetics.run.count`
-          - Kai adds the following filter for this metric:
+      .. image:: /_images/images-slo/custom-metric-slo-scenario.png
+          :width: 100%
+          :alt: This image shows Kai's SLO configuration using the ``synthetics.run.count`` metric and appropriate filters.
 
-              * :strong:`test = Emby check`
-          - 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.
+
+#. Kai assigns ``G`` to the :guilabel:`Good events (numerator)` dropdown menu and ``T`` to the :guilabel:`Total events (denominator)` dropdown menu.
 
 #. Kai enters the following fields to define a target for their SLO:
 
@@ -64,11 +54,6 @@ From the :guilabel:`Detectors & SLOs` page, Kai configures the SLI and sets up a
 
 #. Kai subscribes to receive an alert whenever there is a breach event for the SLO target.
 
-.. image:: /_images/images-slo/custom-metric-slo-scenario.png
-    :width: 100%
-    :alt: This image shows Kai's SLO configuration using the ``synthetics.run.count`` metric and appropriate filters.
-
-
 Summary
 =======================
 
@@ -80,3 +65,5 @@ Learn more
 For more information about creating an SLO, see :ref:`create-slo`. 
 
 For more information about the Synthetics Browser test, see :ref:`browser-test`.
+
+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.