Skip to content

Commit 560805a

Browse files
committed
Revert unneeded changes in scenarios files
1 parent 2608d8c commit 560805a

File tree

5 files changed

+407
-407
lines changed

5 files changed

+407
-407
lines changed
Lines changed: 69 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,69 @@
1-
.. _find-detectors:
2-
3-
*************************************************************
4-
Scenario: Kai finds active alerts to investigate a CPU issue
5-
*************************************************************
6-
7-
8-
9-
.. meta::
10-
:description: This Splunk alerts and detectors scenario describes how to find active alerts.
11-
12-
Kai, a site reliability engineer at Buttercup Games, has created a detector called "CPU Detector" that monitors Buttercup Games host machine's CPU usage for sudden changes. Kai has received many alerts from this detector, and wants to get a more detailed view of these alerts.
13-
14-
Using the :guilabel:`Alerts & Detectors` page in Splunk Observability Cloud, Kai can find and view these active alerts so they can easily troubleshoot the CPU changes.
15-
16-
Find active alerts using the search list
17-
====================================================
18-
19-
From the :guilabel:`Alerts & Detectors` page, Kai can find active alerts using the search list. Kai follows these steps:
20-
21-
#. Kai wants to find an active alert, so they select the :guilabel:`Active Alerts` tab.
22-
#. Kai enters filters so they can find their active alerts more easily. They enter desired values for the following fields:
23-
24-
.. list-table::
25-
:header-rows: 1
26-
:widths: 33 33 33
27-
28-
* - Field
29-
- Value
30-
- Description
31-
32-
* - :guilabel:`Group By`
33-
- :guilabel:`host.name`
34-
- Groups active alerts from the same host machine name into one category.
35-
36-
* - :guilabel:`Team`
37-
- :guilabel:`Buttercup Games`
38-
- Shows only active alerts from detectors created by the Buttercup Games team.
39-
40-
After applying filters, Kai finds a list of active alerts triggered by their detector:
41-
42-
.. image:: /_images/images-detectors-alerts/use-cases/active-alerts-list.png
43-
:width: 100%
44-
:alt: This screenshot shows a list of active alerts.
45-
46-
View details of active alerts
47-
===================================================
48-
49-
Now that Kai has found their active alerts in the search list, Kai wants to see which alerts are active for this detector.
50-
51-
Kai can now view a detailed report of each active alert associated with their detector by selecting the alert name.
52-
53-
.. image:: /_images/images-detectors-alerts/use-cases/detail-view-cpu.png
54-
:width: 100%
55-
:alt: This screenshot shows a detailed view of one of the alerts, displaying a spike in CPU value.
56-
57-
By viewing several of these alerts, Kai determines that one of their host machines experienced spikes in CPU utilization.
58-
59-
Summary
60-
=======================
61-
62-
Kai viewed a list of active alerts triggered by their detector. By finding and viewing the detailed reports of these active alerts, Kai discovered that one of their host machines experienced sudden increases in CPU usage, and they can now troubleshoot the problem more easily.
63-
64-
Learn more
65-
=======================
66-
67-
For more information about ways to view alerts, see :ref:`view-alerts`.
68-
69-
For more information about ways to view detectors, see :ref:`view-detectors`.
1+
.. _find-detectors:
2+
3+
*************************************************************
4+
Scenario: Kai finds active alerts to investigate a CPU issue
5+
*************************************************************
6+
7+
8+
9+
.. meta::
10+
:description: This Splunk alerts and detectors scenario describes how to find active alerts.
11+
12+
Kai, a site reliability engineer at Buttercup Games, has created a detector called "CPU Detector" that monitors Buttercup Games host machine's CPU usage for sudden changes. Kai has received many alerts from this detector, and wants to get a more detailed view of these alerts.
13+
14+
Using the :guilabel:`Alerts & Detectors` page in Splunk Observability Cloud, Kai can find and view these active alerts so they can easily troubleshoot the CPU changes.
15+
16+
Find active alerts using the search list
17+
====================================================
18+
19+
From the :guilabel:`Alerts & Detectors` page, Kai can find active alerts using the search list. Kai follows these steps:
20+
21+
#. Kai wants to find an active alert, so they select the :guilabel:`Active Alerts` tab.
22+
#. Kai enters filters so they can find their active alerts more easily. They enter desired values for the following fields:
23+
24+
.. list-table::
25+
:header-rows: 1
26+
:widths: 33 33 33
27+
28+
* - Field
29+
- Value
30+
- Description
31+
32+
* - :guilabel:`Group By`
33+
- :guilabel:`host.name`
34+
- Groups active alerts from the same host machine name into one category.
35+
36+
* - :guilabel:`Team`
37+
- :guilabel:`Buttercup Games`
38+
- Shows only active alerts from detectors created by the Buttercup Games team.
39+
40+
After applying filters, Kai finds a list of active alerts triggered by their detector:
41+
42+
.. image:: /_images/images-detectors-alerts/use-cases/active-alerts-list.png
43+
:width: 100%
44+
:alt: This screenshot shows a list of active alerts.
45+
46+
View details of active alerts
47+
===================================================
48+
49+
Now that Kai has found their active alerts in the search list, Kai wants to see which alerts are active for this detector.
50+
51+
Kai can now view a detailed report of each active alert associated with their detector by selecting the alert name.
52+
53+
.. image:: /_images/images-detectors-alerts/use-cases/detail-view-cpu.png
54+
:width: 100%
55+
:alt: This screenshot shows a detailed view of one of the alerts, displaying a spike in CPU value.
56+
57+
By viewing several of these alerts, Kai determines that one of their host machines experienced spikes in CPU utilization.
58+
59+
Summary
60+
=======================
61+
62+
Kai viewed a list of active alerts triggered by their detector. By finding and viewing the detailed reports of these active alerts, Kai discovered that one of their host machines experienced sudden increases in CPU usage, and they can now troubleshoot the problem more easily.
63+
64+
Learn more
65+
=======================
66+
67+
For more information about ways to view alerts, see :ref:`view-alerts`.
68+
69+
For more information about ways to view detectors, see :ref:`view-detectors`.
Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
1-
.. _monitor-autodetect:
2-
3-
****************************************************
4-
Scenario: Kai monitors system limits with AutoDetect
5-
****************************************************
6-
7-
8-
9-
.. meta::
10-
:description: This Splunk alerts and detectors scenario describes how to use AutoDetect to track system limits.
11-
12-
Kai, a site reliability engineer at Buttercup Games, wants to know when they are reaching their limit for the number of detectors they can create for Buttercup Games. This limit is automatically monitored through an AutoDetect detector, which Kai can view from the Alerts and Detectors page.
13-
14-
View AutoDetect alerts and detectors
15-
========================================
16-
17-
To use their AutoDetect detector, Kai must first find and view the details of the detector. The name of the detector is :guilabel:`Splunk Operational -- Number of detectors is expected to reach the maximum`.
18-
19-
Kai finds the detector by following these steps:
20-
21-
#. Kai opens the :guilabel:`All alerts` menu and unchecks :strong:`Standard` and :strong:`Customized AutoDetect` to filter for only AutoDetect detectors.
22-
#. Kai enters the name of the detector in the search bar.
23-
#. Kai selects the detector from the result list.
24-
25-
.. image:: /_images/images-detectors-alerts/use-cases/autodetect-search.png
26-
:width: 100%
27-
:alt: This screenshot shows the detectors search list with Kai's detector appearing as the first search result.
28-
29-
After Kai finds the AutoDetect detector that monitors the maximum number of detectors for Buttercup Games, they can set up alerts and add a preferred notification channel.
30-
31-
Subscribe to AutoDetect detectors
32-
=========================================
33-
34-
Kai wants to be alerted whenever their AutoDetect detector triggers an alert indicating that Buttercup Games has almost reached their maximum number of detectors. Kai can receive an alert from the system limits detector by subscribing to the detector.
35-
36-
To subscribe to an AutoDetect detector, Kai follows these steps:
37-
38-
#. Kai finds their AutoDetect detector from the search list or their integration.
39-
#. Kai selects :guilabel:`Add Recipients`.
40-
#. Kai sets up the notification channel of their choice.
41-
42-
Kai will receive a notification whenever their AutoDetect detector triggers an alert for maximum number of detectors created.
43-
44-
Disable AutoDetect detectors
45-
=========================================
46-
47-
Kai decides that they no longer want to use their AutoDetect detector, as Buttercup Games has not come close to reaching their system limit. In this case, Kai can disable the detector by following these steps:
48-
49-
#. Kai finds their detector from the search list.
50-
#. Kai selects :guilabel:`Disable Detector`. This stops the detector from reporting on data and Kai no longer receives notifications from the detector.
51-
52-
Customize AutoDetect detectors
53-
=================================
54-
55-
Kai's AutoDetect detector will trigger an alert when the number of detectors used is 90%, but Kai would like to be alerted when they are reaching 75% of the detectors used instead. To receive these alerts, Kai can customize the system limits AutoDetect detector.
56-
57-
To customize this detector, Kai follows these steps:
58-
59-
#. Kai selects the :guilabel:`Splunk Operational -- Number of detectors is expected to reach the maximum` detector.
60-
#. In the detector menu, Kai selects :guilabel:`Create a Customized Version`.
61-
#. Kai changes the :guilabel:`Trigger threshold` to :guilabel:`75%`.
62-
#. Kai selects :guilabel:`Activate`.
63-
64-
Kai has created a new AutoDetect detector that will alert them whenever the number of detectors used reaches 75%.
65-
66-
Summary
67-
=====================
68-
69-
In this scenario, Kai set up and subscribed to an AutoDetect detector that reported on system limits for Buttercup Games. Kai also learned how to find, disable, and customize the AutoDetect detector.
70-
71-
Learn more
72-
=========================================
73-
74-
For more information about AutoDetect detectors, see :ref:`autodetect`.
75-
76-
For information about AutoDetect integrations and types of AutoDetect detectors, see :ref:`autodetect-list`
1+
.. _monitor-autodetect:
2+
3+
****************************************************
4+
Scenario: Kai monitors system limits with AutoDetect
5+
****************************************************
6+
7+
8+
9+
.. meta::
10+
:description: This Splunk alerts and detectors scenario describes how to use AutoDetect to track system limits.
11+
12+
Kai, a site reliability engineer at Buttercup Games, wants to know when they are reaching their limit for the number of detectors they can create for Buttercup Games. This limit is automatically monitored through an AutoDetect detector, which Kai can view from the Alerts and Detectors page.
13+
14+
View AutoDetect alerts and detectors
15+
========================================
16+
17+
To use their AutoDetect detector, Kai must first find and view the details of the detector. The name of the detector is :guilabel:`Splunk Operational -- Number of detectors is expected to reach the maximum`.
18+
19+
Kai finds the detector by following these steps:
20+
21+
#. Kai opens the :guilabel:`All alerts` menu and unchecks :strong:`Standard` and :strong:`Customized AutoDetect` to filter for only AutoDetect detectors.
22+
#. Kai enters the name of the detector in the search bar.
23+
#. Kai selects the detector from the result list.
24+
25+
.. image:: /_images/images-detectors-alerts/use-cases/autodetect-search.png
26+
:width: 100%
27+
:alt: This screenshot shows the detectors search list with Kai's detector appearing as the first search result.
28+
29+
After Kai finds the AutoDetect detector that monitors the maximum number of detectors for Buttercup Games, they can set up alerts and add a preferred notification channel.
30+
31+
Subscribe to AutoDetect detectors
32+
=========================================
33+
34+
Kai wants to be alerted whenever their AutoDetect detector triggers an alert indicating that Buttercup Games has almost reached their maximum number of detectors. Kai can receive an alert from the system limits detector by subscribing to the detector.
35+
36+
To subscribe to an AutoDetect detector, Kai follows these steps:
37+
38+
#. Kai finds their AutoDetect detector from the search list or their integration.
39+
#. Kai selects :guilabel:`Add Recipients`.
40+
#. Kai sets up the notification channel of their choice.
41+
42+
Kai will receive a notification whenever their AutoDetect detector triggers an alert for maximum number of detectors created.
43+
44+
Disable AutoDetect detectors
45+
=========================================
46+
47+
Kai decides that they no longer want to use their AutoDetect detector, as Buttercup Games has not come close to reaching their system limit. In this case, Kai can disable the detector by following these steps:
48+
49+
#. Kai finds their detector from the search list.
50+
#. Kai selects :guilabel:`Disable Detector`. This stops the detector from reporting on data and Kai no longer receives notifications from the detector.
51+
52+
Customize AutoDetect detectors
53+
=================================
54+
55+
Kai's AutoDetect detector will trigger an alert when the number of detectors used is 90%, but Kai would like to be alerted when they are reaching 75% of the detectors used instead. To receive these alerts, Kai can customize the system limits AutoDetect detector.
56+
57+
To customize this detector, Kai follows these steps:
58+
59+
#. Kai selects the :guilabel:`Splunk Operational -- Number of detectors is expected to reach the maximum` detector.
60+
#. In the detector menu, Kai selects :guilabel:`Create a Customized Version`.
61+
#. Kai changes the :guilabel:`Trigger threshold` to :guilabel:`75%`.
62+
#. Kai selects :guilabel:`Activate`.
63+
64+
Kai has created a new AutoDetect detector that will alert them whenever the number of detectors used reaches 75%.
65+
66+
Summary
67+
=====================
68+
69+
In this scenario, Kai set up and subscribed to an AutoDetect detector that reported on system limits for Buttercup Games. Kai also learned how to find, disable, and customize the AutoDetect detector.
70+
71+
Learn more
72+
=========================================
73+
74+
For more information about AutoDetect detectors, see :ref:`autodetect`.
75+
76+
For information about AutoDetect integrations and types of AutoDetect detectors, see :ref:`autodetect-list`

0 commit comments

Comments
 (0)