Monitoring: AlarmSuppression¶
Manage OCI Monitoring resources from Kubernetes. This page is generated from checked-in package metadata, CRD schemas, and sample manifests.
Resource Snapshot¶
| Field | Value |
|---|---|
| Service | monitoring |
| Resource | AlarmSuppression |
| API Version | monitoring.oracle.com/v1beta1 |
| Package | Monitoring |
| Support Status | Preview |
| Latest Released Version | v2.1.0-alpha |
| Install Namespace | oci-service-operator-monitoring-system |
Quick Links¶
- Resource Guide Index
- Setup Guide
- Package Page
- API Reference
- Spec Reference
- Status Reference
- Rendered Sample (
config/samples/monitoring_v1beta1_alarmsuppression.yaml)
Spec Fields¶
This summary shows the top-level spec fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
alarmSuppressionTarget |
AlarmSuppressionTarget defines nested fields for AlarmSuppression.AlarmSuppressionTarget. | object |
Yes |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
description |
Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. Oracle recommends including tracking information for the event or associated work, such as a ticket number. Example: Planned outage due to change IT-1234. |
string |
No |
dimensions |
A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "ocid1.instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression. This is required only when the value of level is DIMENSION. If required, the value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message. |
map[string, string] |
No |
displayName |
A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
Yes |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"} |
map[string, string] |
No |
level |
The level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions. Defaut: DIMENSION |
string |
No |
suppressionConditions |
Array of all preconditions for alarm suppression. Example: [{ conditionType: "RECURRENCE", suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", suppressionDuration: "PT1H" }] |
list[object] |
No |
timeSuppressFrom |
The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z |
string |
Yes |
timeSuppressUntil |
The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z |
string |
Yes |
Status Fields¶
This summary shows the top-level status fields. Use the full API reference for nested fields, defaults, and enum values.
| Field | Description | Type | Required |
|---|---|---|---|
alarmSuppressionTarget |
AlarmSuppressionTarget defines nested fields for AlarmSuppression.AlarmSuppressionTarget. | object |
No |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm suppression. | string |
No |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No |
description |
Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. Oracle recommends including tracking information for the event or associated work, such as a ticket number. Example: Planned outage due to change IT-1234. |
string |
No |
dimensions |
Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"} |
map[string, string] |
No |
displayName |
A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information. | string |
No |
freeformTags |
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"} |
map[string, string] |
No |
id |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm suppression. | string |
No |
level |
The level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions. |
string |
No |
lifecycleState |
The current lifecycle state of the alarm suppression. Example: DELETED |
string |
No |
status |
- | object |
Yes |
suppressionConditions |
Array of all preconditions for alarm suppression. Example: [{ conditionType: "RECURRENCE", suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", suppressionDuration: "PT1H" }] |
list[object] |
No |
timeCreated |
The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z |
string |
No |
timeSuppressFrom |
The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z |
string |
No |
timeSuppressUntil |
The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z |
string |
No |
timeUpdated |
The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z |
string |
No |
Sample Manifest¶
This example is generated from the checked-in sample manifest at config/samples/monitoring_v1beta1_alarmsuppression.yaml. Replace placeholder values before applying it.
#
# Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
# Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
#
apiVersion: monitoring.oracle.com/v1beta1
kind: AlarmSuppression
metadata:
name: alarmsuppression-sample
spec: {}