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

Commit f73b667

Browse files
Merge pull request #2562 from splunk/trangl-o11ydocs-6385-muting-rules-react
Update screenshot, fields description, and time window selector for muting rules
2 parents 3999896 + c0627cf commit f73b667

File tree

4 files changed

+72
-47
lines changed

4 files changed

+72
-47
lines changed
112 KB
Loading
172 KB
Loading

alerts-detectors-notifications/alerts-and-detectors/mute-notifications.rst

Lines changed: 50 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Mute alert notifications
77
.. meta::
88
:description: Learn how to stop sending alert notifications based on conditions.
99

10-
Muting is helpful when you need to stop sending alert notifications during situations that are known to trigger alerts, such as maintenance windows or tests. Muting allows you to reduce noise and focus on what really matters.
10+
Muting is helpful when you need to stop sending alert notifications during situations known to trigger alerts, such as maintenance windows or tests. Muting lets you reduce noise and focus on what matters.
1111

1212
You can stop sending, or mute, alert notifications based on certain conditions you can specify. You can mute notifications for a specified period of time or indefinitely, although alerts and events are still generated, and appear in Splunk Observability Cloud.
1313

14-
To see your existing muting rules or create new ones, go to :guilabel:`Alerts`, then select the :guilabel:`Muting Rules` tab.
14+
To see your existing muting rules or create new ones, go to :guilabel:`Detectors & SLOs`, then select the :guilabel:`Muting rules` tab.
1515

1616
.. image:: /_images/alerts-detectors-notifications/muting-notifications/mutingtab.png
1717
:width: 99%
@@ -34,7 +34,7 @@ After the muting period ends, Splunk Observability Cloud restarts sending to sub
3434
Create muting rules
3535
=============================================================================
3636

37-
To create a muting rule, you can either:
37+
To create a muting rule, you can do one of the following:
3838

3939
- :ref:`Mute specific detectors or alerts <rule-from-alerts-page>`.
4040
- :ref:`Create muting rules based on group-by dimensions <rule-from-group-by>`.
@@ -49,7 +49,7 @@ Creating muting rules from existing detectors or alerts is the fastest way of mu
4949

5050
To mute a specific detector or alert:
5151

52-
#. Open the :guilabel:`Alerts` page, and locate the detector or active alert you want to mute.
52+
#. Open :guilabel:`Detectors & SLOs`, then select either the :guilabel:`Active alerts` or :guilabel:`Detectors` tab.
5353
#. Select the more icon (|more|) next to the detector or alert, and select :menuselection:`Create Muting Rule`.
5454
#. :ref:`Configure and save the muting rule <rule-configure>`.
5555

@@ -64,8 +64,8 @@ Muting rules automatically include dimensions specified in :guilabel:`Group By`,
6464

6565
To create muting rules based on group-by dimensions:
6666

67-
#. Open :guilabel:`Alerts`, then select either the :guilabel:`Active Alerts` or :guilabel:`Detectors` tab.
68-
#. Specify the grouping dimensions using the :guilabel:`Group By` buttons.
67+
#. Open :guilabel:`Detectors & SLOs`, then select either the :guilabel:`Active alerts` or :guilabel:`Detectors` tab.
68+
#. Specify the grouping dimensions by selecting the :guilabel:`Group By` button.
6969
#. Select the more button (|more|) next any grouped item, and select :menuselection:`Create Muting Rule`.
7070
#. :ref:`Configure and save the muting rule <rule-configure>`.
7171

@@ -76,11 +76,9 @@ To create muting rules based on group-by dimensions:
7676
Create muting rules from scratch
7777
--------------------------------------------------------------------------
7878

79-
Create or edit muting rules at any time from the :guilabel:`Muting Rules` tab in :guilabel:`Alerts`.
80-
8179
To create a new muting rule from scratch:
8280

83-
#. Open :guilabel:`Alerts`, then select the :guilabel:`Muting Rules` tab.
81+
#. Open :guilabel:`Detectors & SLOs`, then select the :guilabel:`Muting rules` tab.
8482
#. :ref:`Configure and save the muting rule <rule-configure>`.
8583

8684
.. _rule-configure:
@@ -94,15 +92,15 @@ The following screenshot shows the muting rule dialog box:
9492
:width: 90%
9593
:alt: Configure a muting rule
9694

97-
To create a new muting rule, follow these steps:
95+
To configure a new muting rule, follow these steps:
9896

99-
#. Use :guilabel:`Add property` to add or modify one or more properties for which you want to mute notifications. If using groups, you can also type :strong:`sf_tags` to find a list of tags. When you add more than one property, the muting rule interprets the properties using the AND logical operator.
100-
#. Include a :guilabel:`Reason` for the muting rule. The text you enter in this field is displayed when you hover over a rule in the :guilabel:`Muting Rules` tab, and can help others understand why alerts are being muted.
101-
#. Specify the :guilabel:`Schedule` during which notifications should be muted (muting period) using the predefined periods or by creating a custom period. You can also mute indefinitely.
102-
#. (Optional) If the rule follows a schedule, you can set a :guilabel:`Recurrence` period for the muting rule. When scheduling a muting rule, the rule repeats after a set number of days, starting with the start time of the original rule. The daily and weekly options set that number to ``1`` and ``7`` respectively. The :menuselection:`Custom` option lets you set the number of days or set a number of weeks.
97+
#. Include a :guilabel:`Description` for the muting rule. The text you enter in this field displays as the name of the muting rule in the :guilabel:`Muting rules` tab.
98+
#. Use :guilabel:`Select detectors` and :guilabel:`Select properties` to add one or more detectors and properties for which you want to mute notifications. If using groups, you can also type :strong:`sf_tags` to find a list of tags. When you add more than one detector or property, the muting rule interprets the detectors and properties using the AND logical operator.
99+
#. Specify the :guilabel:`Muting schedule` during which notifications are muted (muting period) using the predefined periods or by creating a custom period. You can also mute indefinitely.
100+
#. (Optional) If the rule follows a schedule, you can set a :guilabel:`Time window` and a :guilabel:`Recurrence` period for the muting rule. When scheduling a muting rule, the rule repeats after a set number of days, starting with the start time of the original rule. The daily and weekly options set that number to ``1`` and ``7`` respectively. The :menuselection:`Custom` option lets you set the number of days or set a number of weeks. To learn more about setting a time window, see :ref:`time-range-selector`.
103101
#. Select whether you want to clear any existing alerts that match the conditions you have set. If you're muting certain alerts to address a known problem, you might want to clear existing alerts so you are starting from a clean slate. Clearing these alerts also notifies downstream systems, such as Splunk On-Call, OpsGenie, and PagerDuty.
104102
#. Select whether you want to receive notifications for alerts that are still active when the muting period ends.
105-
#. Select :guilabel:`Next` to view a summary of the muting conditions. If you want to turn on the muting rule, select :guilabel:`Save`. It can take up to a minute before a new muting rule goes into effect.
103+
#. Select :guilabel:`Create` to activate the muting rule. It can take up to a minute before a new muting rule goes into effect.
106104

107105
.. note:: Splunk Observability Cloud allows a maximum of 9,500 muting rules.
108106

@@ -111,54 +109,77 @@ To create a new muting rule, follow these steps:
111109
Search and view muting rules
112110
=============================================================================
113111

114-
You can search existing muting rules and view their details at any time, as well as browse muted notifications.
112+
You can search muting rules and view their details at any time, as well as browse muted notifications.
115113

116-
Active and scheduled muting rules
114+
Muting rules
117115
-----------------------------------------------------------------------------
118116

119-
To find active or scheduled muting rules, use the search field in the :guilabel:`Muting Rules` tab on the :guilabel:`Alerts` page.
117+
To find muting rules, use the search field in the :guilabel:`Muting rules` tab on the :guilabel:`Detectors & SLOs` page.
120118

121-
You can also view information about active and scheduled muting rules from different places on the Alerts page.
119+
You can also view information about muting rules from different places on the :guilabel:`Detectors & SLOs` page.
122120

123121
.. _view-all-rules:
124122

125-
- On the :guilabel:`Muting Rules` tab, you can view a list of all active and scheduled muting rules.
123+
- On the :guilabel:`Muting rules` tab, by default, you can view a list of all active and scheduled muting rules.
124+
125+
- Use the :guilabel:`Status` filter to view different lists of muting rules. You can filter muting rules by :strong:`Active and Scheduled`, :strong:`Active`, :strong:`Scheduled`, :strong:`Expired`, or :strong:`Any`.
126+
- Select the arrow next to a muting rule name to expand the row and see more details about the muting rule.
127+
128+
- On the :guilabel:`Active alerts` tab, you can view a list of muted alerts by selecting the :guilabel:`All alerts` filter and changing it to :guilabel:`Only muted alerts`. Select the :strong:`Notifications muted` label next to the duration to view and edit muting rules for the associated alert.
126129

127-
- On the :guilabel:`Detectors` and the :guilabel:`Active Alerts` tabs, running or scheduled muting rules are indicated by :guilabel:`NOTIFICATIONS MUTED` labels next to the muted detector. You can select the label to view muting rules for the associated detector.
130+
- On the :guilabel:`Detectors` tab, you can view a list of muted detectors by selecting the :guilabel:`All detectors` filter and changing it to :guilabel:`Only muted detectors`. Select the :strong:`Muted` label next to the detector name to view and edit muting rules for the associated detector.
128131

129-
.. note:: If you select :guilabel:`NOTIFICATIONS MUTED` and the :strong:`Muting Rules` tab displays an empty page, then the muting rule was created based on properties instead of created for a detector.
132+
.. note:: If you select :guilabel:`Muted` or :strong:`Notifications muted` and the :strong:`Muting rules` tab displays an empty page, then the muting rule was created based on properties instead of created for a detector.
130133

131134
.. _muted-notifications:
132135

133136
Muted notifications
134137
-------------------------------------------------------------------
135138

136-
If a notification was muted, an indicator is displayed wherever the event might send the notification, such as on the :guilabel:`Active Alerts` tab or in an event feed.
139+
If a notification is muted, an indicator is displayed wherever the event might send the notification, such as on the :guilabel:`Active alerts` tab or in an event feed.
137140

138141
To see events related to past muting rules, you can use the :ref:`Events sidebar <events-sidebar>` or the :ref:`Event overlay<dashboard-event-overlay>`. Events are generated when the rule becomes active (notifications stop) and when the rule becomes inactive (notifications resume).
139142

140143
- To find muting events in the Events sidebar, search for :guilabel:`sf_eventType:alertMuting`.
141144

142145
- To overlay muting events on a dashboard, search for :guilabel:`alertMuting` in the Event Overlay search box.
143146

147+
148+
.. _edit-muting-rules:
149+
150+
Edit muting rules
151+
=============================================================
152+
153+
You can only edit active and scheduled muting rules. Expired muting rules are read-only.
154+
155+
To edit a muting rule:
156+
157+
#. Open :guilabel:`Detectors & SLOs`, then select the :guilabel:`Muting rules` tab.
158+
#. Select the more icon (|more|), then select :menuselection:`Edit`.
159+
#. Make any edits you want to your muting rule.
160+
161+
.. note:: For active muting rules, you can't change the detector and property filters as well as the muting start date.
162+
163+
#. Select :guilabel:`Save`.
164+
144165
.. _cancel-muting-rules:
145166

146167
Cancel or delete muting rules
147168
=============================================================================
148169

149170
Canceling an active muting rule and resuming notifications for an alert or detector are the same thing. A canceled muting rules is deleted from Splunk Observability Cloud before it expires. Scheduled muting rules that are not yet active can also be deleted before they start.
150171

151-
To cancel an active muting rule or delete a scheduled muting rule from :guilabel:`Alerts`:
172+
To cancel an active muting rule or delete a scheduled muting rule from :guilabel:`Detectors & SLOs`:
152173

153-
- Select the :guilabel:`Muting Rules` tab, and locate the muting rule you want to cancel or delete.
174+
- Select the :guilabel:`Muting rules` tab, and locate the muting rule you want to cancel or delete.
154175

155-
- Select the more icon (|more|) next to the muting rule and select :menuselection:`Resume Notifications` or :menuselection:`Delete`.
176+
- Select the more icon (|more|) next to the muting rule and select :menuselection:`Resume notifications` or :menuselection:`Delete`.
156177

157178
You can also cancel muting rules from a muted alert or detector:
158179

159-
- On the :guilabel:`Active Alerts` or the :guilabel:`Detectors` tab, select the :guilabel:`muted` or the :guilabel:`notifications muted` label.
180+
- On the :guilabel:`Active alerts` or the :guilabel:`Detectors` tab, select the :guilabel:`Muted` or the :guilabel:`Notifications muted` label.
160181

161-
- For a detector, select the muting rule, then select :menuselection:`Resume Notifications`.
162-
- For an active alert, select the more icon (|more|), then select :menuselection:`Resume Notifications`.
182+
- For a detector, select the muting rule, then select :menuselection:`Resume notifications`.
183+
- For an active alert, select the more icon (|more|), then select :menuselection:`Resume notifications`.
163184

164185
If there are multiple rules, select the rule for which you want to resume notifications. In each case, you can confirm that you want to resume sending notifications.

0 commit comments

Comments
 (0)