Oracle Cloud Infrastructure Documentation

Suppressing a Single Alarm

Temporarily stop notifications from an alarm by applying a suppression. For example, use a suppression to suspend alarm notifications during system maintenance.

Note

Dimension-specific suppressions are available for alarms that are configured for split messages only. See Scenario: Split Messages by Metric Stream. A dimension-specific suppression can't be added to multiple alarms at the same time.

When you create an alarm suppression using the SDK, CLI, or API, you can also add tags. For more information about tagging, see Resource Tags. you can also update its tags. For more information about tagging, see Resource Tags.

See also Suppressing Multiple Alarms.

  • Tagging alarm suppressions isn't available in the Console. To tag a new alarm suppression, use the SDK, CLI, or API.
    1. On the Alarm Definitions list page, select the alarm that you want to work with. If you need help finding the list page or the alarm, see Listing Alarms.
    2. On the alarm's details page, select Edit alarm suppression.
    3. In the Edit alarm suppression panel, provide the following values:
      • Start time: The date and time to start the suppression. The default is the current time. The value must be within 90 days of the current time. If you're editing an existing suppression, the field shows the start time of that suppression.
      • End time: The date and time to end the suppression. The default is one hour from the current time. The value must be within 90 days of the current time. If you're editing an existing suppression, the field shows the end time of that suppression.
      • Suppression description: Optional description of the suppression.
    4. To specify dimensions for the suppression (alarm must be configured for split messages), select Suppress per Dimension, and then provide the following values:
      • Display name (dimension-specific suppression only): User-friendly name for the suppression. Avoid entering confidential information.
      • Suppress per Dimension: Select this option for a dimension-specific suppression of the alarm.
      • Dimension name: Select the name of the dimension that you want to suppress notifications for. For example, select resourceId.
      • Dimension value: Select the value that you want to suppress notifications for. For example, the OCID for a compute instance. (Only one value can be specified.)
      • To add another dimension-specific suppression, select Additional dimension.
    5. Select Add suppressions.

  • Use the oci monitoring alarm-suppression create command and required parameters to create an alarm suppression:

    oci monitoring alarm-suppression create [OPTIONS]
    Note

    You can alternatively use the oci monitoring alarm update command. Dimensions can't be specified with this command.

    For a complete list of parameters and values for CLI commands, see the Command Line Reference for Monitoring.

  • Run the CreateAlarmSuppression operation to create a dimension-specific alarm suppression.

    Note

    You can alternatively use the UpdateAlarm operation. Dimensions can't be specified with this operation.