Skip to content

Commit 0ff3a32

Browse files
authored
Merge pull request #2512 from splunk/adasplunk-DOCGUILD-27806
[DOCGUILD-27806] Add instructions for sending an alert when …
2 parents 2c6c8f7 + 5b32bb2 commit 0ff3a32

File tree

2 files changed

+44
-8
lines changed

2 files changed

+44
-8
lines changed
145 KB
Loading

synthetics/test-config/synth-alerts.rst

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,68 @@ In Splunk Observability Cloud, detectors monitor your tests and metrics for anom
1111

1212
To learn more about advanced alerts and detectors in Splunk Observability Cloud, see :ref:`get-started-detectoralert`. Read on to learn about creating static threshold detectors specific to Synthetics.
1313

14-
Use cases for detectors in Synthetics
14+
Types of detectors in Synthetics
1515
=======================================
1616

17-
You can use detectors to alert on metrics at the test level, or at the page level or synthetic transaction level for Browser tests. The following table provides example use cases for detectors at each of these levels:
17+
In Synthetics, there are detectors to alert on metrics at the test level, at the page level, or at the synthetic transaction level for browser tests. The following table explains each of these detector types:
1818

1919
.. list-table::
2020
:header-rows: 1
2121
:widths: 25 75
2222

2323
* - :strong:`Detector type`
24-
- :strong:`Use case`
24+
- :strong:`Description`
2525

2626
* - Test-level detectors
27-
- | Create test-level detectors to trigger alerts on metrics that correspond to the entire test.
27+
- | Test-level detectors send alerts on metrics that correspond to an entire test.
2828
|
29-
| For example, alert when the count of failed runs, % Uptime, or duration of the entire test exceeds a given threshold.
29+
| Examples: Send an alert when the count of failed runs, % uptime, or duration of the entire test exceeds a given threshold.
3030
3131
* - Page-level detectors
32-
- | In Browser tests, create page-level detectors to trigger alerts on metrics corresponding to a single page within a test. For example, alert when the DOM load time, largest contentful paint (LCP), or total image size on a given page exceeds a given threshold.
32+
- | Page-level detectors send alerts on metrics that correspond to a single page within a browser test.
33+
|
34+
| Examples: Send an alert when the DOM load time, largest contentful paint (LCP), or total image size on a given page exceeds a given threshold.
3335
|
3436
| If you don't scope your alerts to the page level for page-level metrics, the detector monitors the average metric value across pages. See :ref:`page-level-detector` to learn more.
3537
3638
* - Transaction-level detectors
37-
- | In Browser tests, create synthetic transaction-level detectors to trigger alerts on metrics based on a synthetic transaction within a test.
39+
- | Synthetic transaction-level detectors send alerts on metrics that correspond to a synthetic transaction within a browser test.
3840
|
39-
| You can alert on the three transaction-level metrics that Splunk Synthetic Monitoring captures: Duration, Requests, and Size. See :ref:`transaction-level-detector` to learn more.
41+
| Examples: Send an alert on the three transaction-level metrics that Splunk Synthetic Monitoring captures (duration, requests, and size). See :ref:`transaction-level-detector` to learn more.
42+
43+
44+
Best practices for sending an alert when a synthetic test fails
45+
===============================================================
46+
47+
You can set up a detector while initially creating or editing a test, or from the results view for a particular test. A detector can track one or more synthetic tests.
48+
49+
To set up a detector, do one of the following:
50+
51+
* When creating or editing a test, select :guilabel:`Create detector` to open the detector dialog box.
52+
* From the :guilabel:`Test results` page for a particular test, select :guilabel:`Create detector` to open the detector dialog box.
53+
54+
In the detector dialog box, enter the following fields:
55+
56+
#. In the test name list, select the tests you want to include in your detector. Best practice is to select tests that have a similar run length.
57+
#. In the metric list, select :strong:`Uptime`. The uptime metric is 0 when the test fails.
58+
#. In :strong:`+ Add filters` don't add filters for :guilabel:`failed` or :guilabel:`success`. Omit these filters to ensure that the detector sees all datapoints for the test run.
59+
60+
#. In the :guilabel:`Alert details` section, enter the following:
61+
62+
* :guilabel:`Trigger threshold`: The threshold to trigger the alert.
63+
* :guilabel:`Orientation`: Whether the metric must fall below or exceed the threshold to trigger the alert.
64+
* :guilabel:`Violates threshold`: How many times the metric must violate the threshold to trigger the alert.
65+
* :guilabel:`Split by location`: Whether to split the detector by test location. If you don't split by location, the detector monitors the average value across all locations.
66+
67+
#. Use the severity selector to set the severity of the alert.
68+
#. Add recipients.
69+
#. Select :guilabel:`Activate`.
70+
71+
.. image:: /_images/synthetics/detector-one.png
72+
:width: 100%
73+
:alt: Setting up a detector for failed tests.
74+
75+
Your detector is now set up to check for failed test runs every minute and to send an alert based on your settings in :guilabel:`Alert details`.
4076

4177
.. _synth-detector-setup:
4278

0 commit comments

Comments
 (0)