> ## Documentation Index > Fetch the complete documentation index at: https://docs.chronosphere.io/llms.txt > Use this file to discover all available pages before exploring further. # Setting monitor muting rules Use muting rules to mute notifications for an entire monitor, a signal from a monitor, an SLO, or any stored time series. You can use this capability when you're fixing a known issue and don't want to keep receiving alerts, during scheduled maintenance windows, or when deploying new services. ## View muting rules Select from the following methods to view a list of muting rules and review which monitors and time series they affect. To display a list of defined muting rules, in the navigation menu select ** Alerting > 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. When viewing an active muting rule, select a time period to display the alerts the rule muted during that period. For example, show all muted alerts for the past hour to determine whether the muting rule is effectively muting the intended alerts. The **Muted Alerts** section displays the following muting rule statuses. You can change the time period to see which alerts the muting rule affects: * **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. Click the name of the alert to display the [Monitor actions](/investigate/alerts/monitors/monitor-actions) page for the muted monitor. To fetch the defined muting rules with [Chronoctl](/tooling/chronoctl), use this command: ```shell theme={null} chronoctl muting-rules list ``` This command returns a list of YAML documents with the following data structure for each muting rule: ```yaml theme={null} api_version: v1/config kind: MutingRule spec: slug: my-rule name: My Rule label_matchers: - type: EXACT name: environment value: staging starts_at: "2023-12-12T18:54:46.000Z" ends_at: "2023-12-12T19:54:46.000Z" comment: mute staging alerts ``` To complete this action with the Chronosphere API, use the [`ListMutingRules`](/tooling/api-info/definition/operations/ListMutingRules) endpoint. Because the Chronosphere API requires authentication, include an API token with your `curl` request, as shown in the following example. For more details, see [Create an API token](/tooling/api-info#create-an-api-token). ```shell /"TOKEN"/ /INSTANCE/ /METHOD/ /ENDPOINT_PATH/ theme={null} export CHRONOSPHERE_API_TOKEN="TOKEN" export CHRONOSPHERE_DOMAIN="INSTANCE.chronosphere.io" curl -H "API-Token: ${CHRONOSPHERE_API_TOKEN}" \ -X METHOD "https://${CHRONOSPHERE_DOMAIN}/ENDPOINT_PATH" ``` Replace the following: * *`TOKEN`*: Your API token. * *`INSTANCE`*: The subdomain name for your organization's Observability Platform instance. * *`METHOD`*: The HTTP method to use with the request, such as `GET` or `POST`. * *`ENDPOINT_PATH`*: The specific endpoint you want to access. ### View per-series muting status on a monitor When you open a [monitor](/investigate/alerts/monitors) in Observability Platform, the **Series Legend** displays an **Alert status** for each time series in the chart. When an active muting rule's label matchers match a specific series, the legend shows **Muted** for that series. Other series in the same monitor can display different statuses at the same time. For example, if a muting rule matches `environment=staging`, only series with that label indicate **Muted**. Series with `environment=production` continue to indicate their actual alert status, such as **Critical** or **Warning**. **Muted** appears as a link to the alert page when the series has an active alert, or as plain text when the series has no active alert but its labels match a muting rule. Open any monitor to display the **Alert status** column in the **Series Legend**. ## 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](/investigate/alerts/monitors/data-model#schedule) muting rules. 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 shows which alerts match the rule and would be muted. Based on this preview, you can review and adjust the rule before it's active. To create a muting rule: 1. Choose whether to mute an existing rule or create a new one: * To mute an existing rule: 1. In the navigation menu select ** Alerting > Monitors** and click the monitor you want to mute. 2. 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**. 3. On the same line as the monitor's title, click ** Mute**. * To create a new muting rule, in the navigation menu select ** Alerting > Muting Rules**, and click **Create muting rule**. 2. 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](/investigate/alerts/muting-rules#match-on-values-using-regular-expressions). 3. Click **Save**. After you create a muting rule in Observability Platform, select it from the list of muting rules and click **Show JSON** to view the complete JSON request for your muting rule. You can copy this JSON snippet and use it in a script with the [Chronosphere API](/tooling/api-info). ```json theme={null} { "slug": "lifecycle-match-envoy_cluster_name", "name": "Muting Rule", "matchers": [ { "type": "REGEXP_MATCHER_TYPE", "name": "envoy_cluster_name", "value": "cluster_span_rc.*" } ], ... } ``` To create a muting rule with [Chronoctl](/tooling/chronoctl), use this command: ```shell /START_TIME/ /END_TIME/ /RULE_NAME/ /COMMENT/ /LABEL_QUERY/ theme={null} chronoctl muting-rules create --starts-at "START_TIME" --ends-at "END_TIME" --name "RULE_NAME" --comment "COMMENT" --match-labels 'LABEL_QUERY' ``` Replace these values: * `COMMENT`: A summary of the muting rule, as a string. * `END_TIME`: When to end the muting rule, as an RFC3339 timestamp or a relative time, such as `-15m`, `-1h30m`, or `-1d5h15m`. * `LABEL_QUERY`: The labels and values to match for the muting rule, as a PromQL query, which can include regular expressions. * `RULE_NAME`: The name of the muting rule, as a string. * `START_TIME`: When to start the muting rule, as an RFC3339 timestamp or a relative time, such as `-15m`, `-1h30m`, or `-1d5h15m`. To mute a specific monitor, use the `alertname` command: ```shell theme={null} chronoctl muting-rules create ... --match-labels '{alertname=""}' ``` To mute a specific monitor when the monitor name isn't unique, use the `slug` command: ```shell theme={null} chronoctl muting-rules create ... --match-labels '{__chrono_monitor_slug=""}' ``` For example, this command creates a muting rule that runs for three hours on September 7, 2021, starts at 11:49 AM, and matches the label named `instance`, for the value `localhost:3030`: ```shell theme={null} chronoctl muting-rules create --starts-at "2021-09-07T11:49:35Z" --ends-at "2021-09-07T14:49:35Z" --name "infra rule" --comment "Local requests" --match-labels '{instance="localhost:3030"}' ``` To complete this action with the Chronosphere API, use the [`CreateMutingRule`](/tooling/api-info/definition/operations/CreateMutingRule) endpoint. Because the Chronosphere API requires authentication, include an API token with your `curl` request, as shown in the following example. For more details, see [Create an API token](/tooling/api-info#create-an-api-token). ```shell /"TOKEN"/ /INSTANCE/ /METHOD/ /ENDPOINT_PATH/ theme={null} export CHRONOSPHERE_API_TOKEN="TOKEN" export CHRONOSPHERE_DOMAIN="INSTANCE.chronosphere.io" curl -H "API-Token: ${CHRONOSPHERE_API_TOKEN}" \ -X METHOD "https://${CHRONOSPHERE_DOMAIN}/ENDPOINT_PATH" ``` Replace the following: * *`TOKEN`*: Your API token. * *`INSTANCE`*: The subdomain name for your organization's Observability Platform instance. * *`METHOD`*: The HTTP method to use with the request, such as `GET` or `POST`. * *`ENDPOINT_PATH`*: The specific endpoint you want to access. ### 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 (`=~`) Then, define regular expressions for the values you want to match on. If you're creating a muting rule using Chronoctl, pass the `-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`. When defining your muting rule in Observability Platform, specify the following criteria: * Select the **match regex** (`=~`) matcher. * Enter `envoy_cluster_name` as the key. * Enter `cluster_span_rc.*` as the value to match on. To create a muting rule with the defined regular expression with [Chronoctl](/tooling/chronoctl), use this command: ```shell theme={null} chronoctl muting-rules create --name "envoy mute" --match-labels '{envoy_cluster_name=~"cluster_span_rc.*"}' --ends-at +1h ``` ## Edit a muting rule Edit a muting rule to change the name of the rule or update the rule's duration. 1. On the **Muting Rules** page, click the muting rule whose duration you want to extend. 2. On the **Muting Rules Details** page, click ** Edit**. The **Edit Muting Rule** drawer opens and displays a message stating when the selected muting rule duration ends. ### Change the rule name To change the rule's name: 1. Update the **Name** field. 2. 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. 1. [Edit the muting rule](#edit-a-muting-rule) you want to change the duration of. 2. Select **Extend by** to lengthen, or **Shorten by** to reduce the duration. 3. 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. 4. Click **Save**. ### Set a new end time You can also set a specific new end time. 1. Select **End time**. 2. Set a [custom time](/navigate/time-ranges#select-an-absolute-time-and-date-range). 3. 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**. To stop a muting rule: 1. On the **Muting Rules** page, take one of the following actions: * Hold the pointer over the muting rule you want to expire and click ** Expire Muting Rule**. * Click a muting rule to open the **Muting Rules Details** page, and then click ** Expire Muting Rule**. 2. In the confirmation dialog, click **Confirm (Expire)**. When viewing an expired muting rule, a counter displays the number of muted alerts and affected monitors while the rule was active. To expire a muting rule with [Chronoctl](/tooling/chronoctl), use this command: ```shell /SLUG/ theme={null} chronoctl muting-rules expire-rule --slug SLUG ``` Replace *`SLUG`* with the rule's slug, such as `3021f691-a0bf-4bdd-a4c8-f8468e5b272a`. ## Delete a muting rule Select from the following methods to delete a muting rule. To permanently delete a muting rule with [Chronoctl](/tooling/chronoctl), use this command: ```shell /SLUG/ theme={null} chronoctl muting-rules delete SLUG ``` Replace *`SLUG`* with the rule's slug, such as `3021f691-a0bf-4bdd-a4c8-f8468e5b272a`. To complete this action with the Chronosphere API, use the [`DeleteMutingRule`](/tooling/api-info/definition/operations/DeleteMutingRule) endpoint. Because the Chronosphere API requires authentication, include an API token with your `curl` request, as shown in the following example. For more details, see [Create an API token](/tooling/api-info#create-an-api-token). ```shell /"TOKEN"/ /INSTANCE/ /METHOD/ /ENDPOINT_PATH/ theme={null} export CHRONOSPHERE_API_TOKEN="TOKEN" export CHRONOSPHERE_DOMAIN="INSTANCE.chronosphere.io" curl -H "API-Token: ${CHRONOSPHERE_API_TOKEN}" \ -X METHOD "https://${CHRONOSPHERE_DOMAIN}/ENDPOINT_PATH" ``` Replace the following: * *`TOKEN`*: Your API token. * *`INSTANCE`*: The subdomain name for your organization's Observability Platform instance. * *`METHOD`*: The HTTP method to use with the request, such as `GET` or `POST`. * *`ENDPOINT_PATH`*: The specific endpoint you want to access.