View muting rules
Use the Chronosphere Observability Platform or Chronoctl to view a list of muting rules. Observability Platform provides detailed information about muting rules, such as which alerts a muting rule affects.- Web
- Chronoctl
- API
To display a list of defined muting rules, in the navigation menu select
Alerts > Muting Rules.You can take the following actions:
- Use the Search muting rules box to find a specific rule by name.
- Filter the list of rules by choosing a rule status, which can be Active, Scheduled, or Expired.
-
Point to any muting rule to display additional actions:
- Copy muting rule: Available for rules that are Active, Scheduled, or Expired.
- Expire Muting Rule: Available for rules that are Active or Scheduled.
- Select any muting rule in the list to view an overview, which includes the monitor or time series that the muting rule matches, when the muting rule starts and ends, who created the muting rule, and the total monitors and time series affected.
- All alerts are a complete list of alerts muted during the selected time period.
- Active alerts are actively triggering, but are currently muted by the muting rule.
- Resolved alerts were previously triggered and muted by the muting rule, but are no longer triggering.
Create a muting rule
You can create a muting rule to mute an entire monitor or specific time series. If you have specific downtime window requirements, you can schedule muting rules.- Web
- Chronoctl
- API
You can add a muting rule from the navigation menu from the list of defined monitors
or directly from the list of muting rules.Adding a muting rule from an existing monitor pre-populates the matching criteria
without having to manually enter that information. As you define a muting rule, the
Preview Alerts section displays how your muting rule impacts related alerts.
Based on this preview, you can view and modify monitoring rule’s results before the
muting rule is active.To create a muting rule:
-
Choose whether to mute an existing rule or create a new one:
- To mute an existing rule:
- In the navigation menu select Alerts > Monitors and click the monitor you want to mute.
- If you want to mute specific time series only (and not the entire monitor), choose the time series from the list in the Series Legend.
- On the same line as the monitor’s title, click Mute.
- To create a new muting rule, in the navigation menu select Alerts > Muting Rules, and click Create muting rule.
- To mute an existing rule:
-
Define your muting rule:
- Name: Required, but doesn’t need to be unique. When creating a muting rule from a monitor, this field is prepopulated with that monitor’s name.
- What alerts should be muted?: Whether the muting rule should mute A Monitor or a Time Series, the Matcher which is the operator to match a value against a key, and the Key and Value to match on.
- When should it start?: Start muting Now or at a specific Start time.
-
For how long?: The Duration or defined End time of the muting rule.
Muting rules are based on the time zone of the creator, with working hours
defined as 9 AM to 5 PM Monday through Friday. Creating a rule that extends
outside these hours displays an informational message in the muting rule
interface.
Muting rules support regular expressions, which you can use to match key values against. Refer to the section about how to match on values using regular expressions.
- Click Save.
Match on values using regular expressions
When creating a muting rule, you can use regular expressions to include or exclude values. In Observability Platform, select one of these PromQL Matchers:- Exact match (
=) - Match regex (
=~)
-match-labels argument
followed by a PromQL query that includes regular expressions.
For example, you might want to match a time series with a label named
envoy_cluster_name and include any values that begin with cluster_span_rc. You
can use Observability Platform or Chronoctl to define a regular expression pattern
that matches based on values such as cluster_span_rc_shared__spanhandler_proxy_r-0.
- Web
- Chronoctl
When defining your muting rule in Observability Platform, specify the following
criteria:
- Select the match regex (
=~) matcher. - Enter
envoy_cluster_nameas the key. - Enter
cluster_span_rc.*as the value to match on.
Edit a muting rule
Edit a muting rule to change the name of the rule or update the rule’s duration.- On the Muting Rules page, click the muting rule whose duration you want to extend.
- On the Muting Rules Details page, click Edit.
Change the rule name
To change the rule’s name:- Update the Name field.
- Click Save.
Extend or shorten the duration
You can extend or reduce the duration of a muting rule to increase the length of time that the muting rule remains active. You can extend muting rules from Observability Platform only.- Edit the muting rule you want to change the duration of.
- Select Extend by to lengthen, or Shorten by to reduce the duration.
- In the Time period field, enter a number and then choose Hours, Minutes, or Days from the menu. The new scheduled time displays next to the duration boxes so you can confirm the setting before saving.
- Click Save.
Set a new end time
You can also set a specific new end time.- Select End time.
- Set a custom time.
- Click Save.
Stop a muting rule
Use Observability Platform or Chronoctl to stop a muting rule, which deactivates the rule and changes its status to Expired.- Web
- Chronoctl
When viewing an expired muting rule, a counter displays the number of muted alerts
and affected monitors while the rule was active.To stop a muting rule:
- On the Muting Rules page, take one of the following actions:
- Hold the pointer over the muting rule you want to mute and click Expire Muting Rule.
- Click a muting rule to open the Muting Rules Details page, and then click Expire Muting Rule.
- In the confirmation dialog, click Confirm (Expire).
Delete a muting rule
Select from the following methods to delete a muting rule.- Chronoctl
- API
To permanently delete a muting rule with Chronoctl, use this command:Replace
SLUG with the rule’s slug, such as 3021f691-a0bf-4bdd-a4c8-f8468e5b272a.