monitoring.oracle.com/v1beta1¶
APIVersion: monitoring.oracle.com/v1beta1
This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.
Packages¶
No customer-visible package currently exposes monitoring.oracle.com/v1beta1.
Resources¶
| Kind | Scope | Sample | Packages |
|---|---|---|---|
| Alarm | Namespaced | Sample | - |
| AlarmSuppression | Namespaced | Sample | - |
Alarm¶
Alarm is the Schema for the alarms API.
Plural:alarmsScope:NamespacedAPIVersion:monitoring.oracle.com/v1beta1Sample: Sample (config/samples/monitoring_v1beta1_alarm.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
AlarmSpec defines the desired state of Alarm.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alarmSummary |
Customizable alarm summary (alarmSummary alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to ListAlarmsStatus GetAlarmHistory and RetrieveDimensionStates. |
string |
No | - | - |
body |
The human-readable content of the delivered alarm notification. Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution. |
string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. | string |
Yes | - | - |
definedTags |
Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations": {"CostCenter": "42"}} |
map[string, map[string, string]] |
No | - | - |
destinations |
A list of destinations for alarm notifications. Each destination is represented by the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a related resource, such as a NotificationTopic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service. | list[string] |
Yes | - | - |
displayName |
A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information. This value determines the title of each alarm notification. Example: High CPU Utilization |
string |
Yes | - | - |
evaluationSlackDuration |
Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). |
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 | - | - |
isEnabled |
Whether the alarm is enabled. Example: true |
boolean |
Yes | - | - |
isNotificationsPerMetricDimensionEnabled |
When set to true, splits alarm notifications per metric stream. When set to false, groups alarm notifications across metric streams. Example: true |
boolean |
No | - | - |
messageFormat |
The format to use for alarm notifications. The formats are: * RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format. * PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only. * ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only. |
string |
No | - | - |
metricCompartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm. | string |
Yes | - | - |
metricCompartmentIdInSubtree |
When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true |
boolean |
No | - | - |
namespace |
The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent |
string |
Yes | - | - |
notificationTitle |
Customizable notification title (title alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The notification title appears as the subject line in a formatted email message and as the title in a Slack message. |
string |
No | - | - |
notificationVersion |
The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X. |
string |
No | - | - |
overrides |
A set of overrides that control evaluations of the alarm. Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position 0), and then evaluates the alarm's base values (ruleName value of BASE). |
list[object] |
No | - | - |
pendingDuration |
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING". The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. Example: PT5M |
string |
No | - | - |
query |
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See Supported Services (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- Example of absence alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() ----- Example of absence alarm with custom absence detection period of 20 hours: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- |
string |
Yes | - | - |
repeatNotificationDuration |
The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum: PT1M. Maximum: P30D. Default value: null (notifications are not re-submitted). Example: PT2H |
string |
No | - | - |
resolution |
The time between calculated aggregation windows for the alarm. Supported value: 1m |
string |
No | - | - |
resourceGroup |
Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information. Example: frontend-fleet |
string |
No | - | - |
ruleName |
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride. |
string |
No | - | - |
severity |
The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL |
string |
Yes | - | - |
suppression |
The configuration details for suppressing an alarm. | object |
No | - | - |
Spec.overrides[]¶
AlarmOverride defines nested fields for Alarm.Override.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
body |
The human-readable content of the delivered alarm notification. Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution. |
string |
No | - | - |
pendingDuration |
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING". The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. Example: PT5M |
string |
No | - | - |
query |
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See Supported Services (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- Example of absence alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() ----- Example of absence alarm with custom absence detection period of 20 hours: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- |
string |
No | - | - |
ruleName |
A user-friendly description for this alarm override. Must be unique across all ruleName values for the alarm. |
string |
No | - | - |
severity |
The perceived severity of the alarm with regard to the affected system. Example: CRITICAL |
string |
No | - | - |
Spec.suppression¶
The configuration details for suppressing an alarm.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Human-readable reason for suppressing alarm notifications. 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 | - | - |
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¶
AlarmStatus defines the observed state of Alarm.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alarmSummary |
Customizable alarm summary (alarmSummary alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to ListAlarmsStatus GetAlarmHistory and RetrieveDimensionStates. |
string |
No | - | - |
body |
The human-readable content of the delivered alarm notification. Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution. |
string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. | 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 | - | - |
destinations |
A list of destinations for alarm notifications. Each destination is represented by the OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a related resource, such as a NotificationTopic. Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service. | list[string] |
No | - | - |
displayName |
A user-friendly name for the alarm. It does not have to be unique, and it's changeable. This value determines the title of each alarm notification. Example: High CPU Utilization |
string |
No | - | - |
evaluationSlackDuration |
Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see About the Internal Reset Period (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset). |
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. | string |
No | - | - |
isEnabled |
Whether the alarm is enabled. Example: true |
boolean |
No | - | - |
isNotificationsPerMetricDimensionEnabled |
When set to true, splits alarm notifications per metric stream. When set to false, groups alarm notifications across metric streams. |
boolean |
No | - | - |
lifecycleState |
The current lifecycle state of the alarm. Example: DELETED |
string |
No | - | - |
messageFormat |
The format to use for alarm notifications. The formats are: * RAW - Raw JSON blob. Default value. When the destinations attribute specifies Streaming, all alarm notifications use this format. * PRETTY_JSON: JSON with new lines and indents. Available when the destinations attribute specifies Notifications only. * ONS_OPTIMIZED: Simplified, user-friendly layout. Available when the destinations attribute specifies Notifications only. Applies to Email subscription types only. |
string |
No | - | - |
metricCompartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm. | string |
No | - | - |
metricCompartmentIdInSubtree |
When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: true |
boolean |
No | - | - |
namespace |
The source service or application emitting the metric that is evaluated by the alarm. Example: oci_computeagent |
string |
No | - | - |
notificationTitle |
Customizable notification title (title alarm message parameter (https://docs.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The notification title appears as the subject line in a formatted email message and as the title in a Slack message. |
string |
No | - | - |
notificationVersion |
The version of the alarm notification to be delivered. Allowed value: 1.X The value must start with a number (up to four digits), followed by a period and an uppercase X. |
string |
No | - | - |
overrides |
A set of overrides that control evaluations of the alarm. Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position 0), and then evaluates the alarm's base values (ruleName value of BASE). |
list[object] |
No | - | - |
pendingDuration |
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING". The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. Example: PT5M |
string |
No | - | - |
query |
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See Supported Services (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- Example of absence alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() ----- Example of absence alarm with custom absence detection period of 20 hours: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- |
string |
No | - | - |
repeatNotificationDuration |
The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, PT4H indicates four hours. Minimum: PT1M. Maximum: P30D. Default value: null (notifications are not re-submitted). Example: PT2H |
string |
No | - | - |
resolution |
The time between calculated aggregation windows for the alarm. Supported value: 1m |
string |
No | - | - |
resourceGroup |
Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: frontend-fleet |
string |
No | - | - |
ruleName |
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is BASE. For information about alarm overrides, see AlarmOverride. |
string |
No | - | - |
severity |
The perceived type of response required when the alarm is in the "FIRING" state. Example: CRITICAL |
string |
No | - | - |
status |
- | object |
Yes | - | - |
suppression |
The configuration details for suppressing an alarm. | object |
No | - | - |
timeCreated |
The date and time the alarm was created. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z |
string |
No | - | - |
timeUpdated |
The date and time the alarm was last updated. Format defined by RFC3339. Example: 2023-02-03T01:02:29.600Z |
string |
No | - | - |
Status.overrides[]¶
AlarmOverride defines nested fields for Alarm.Override.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
body |
The human-readable content of the delivered alarm notification. Optionally include dynamic variables (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: High CPU usage alert. Follow runbook instructions for resolution. |
string |
No | - | - |
pendingDuration |
The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING". The duration is specified as a string in ISO 8601 format (PT10M for ten minutes or PT1H for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. Example: PT5M |
string |
No | - | - |
query |
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Also, you can customize the absence detection period (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). Supported grouping functions: grouping(), groupBy(). For information about writing MQL expressions, see Editing the MQL Expression for a Query (https://docs.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see Monitoring Query Language (MQL) Reference (https://docs.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See Supported Services (https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices). Example of threshold alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 ----- Example of absence alarm: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() ----- Example of absence alarm with custom absence detection period of 20 hours: ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- |
string |
No | - | - |
ruleName |
A user-friendly description for this alarm override. Must be unique across all ruleName values for the alarm. |
string |
No | - | - |
severity |
The perceived severity of the alarm with regard to the affected system. Example: CRITICAL |
string |
No | - | - |
Status.status¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.suppression¶
The configuration details for suppressing an alarm.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
description |
Human-readable reason for suppressing alarm notifications. 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 | - | - |
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 | - | - |
AlarmSuppression¶
AlarmSuppression is the Schema for the alarmsuppressions API.
Plural:alarmsuppressionsScope:NamespacedAPIVersion:monitoring.oracle.com/v1beta1Sample: Sample (config/samples/monitoring_v1beta1_alarmsuppression.yaml)Packages: Not currently exposed by a customer-visible package.
Spec¶
AlarmSuppressionSpec defines the desired state of AlarmSuppression.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
Spec.alarmSuppressionTarget¶
AlarmSuppressionTarget defines nested fields for AlarmSuppression.AlarmSuppressionTarget.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alarmId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment or tenancy that is the target of the alarm suppression. Example: ocid1.compartment.oc1..exampleuniqueID |
string |
No | - | - |
compartmentIdInSubtree |
When true, the alarm suppression targets all alarms under all compartments and subcompartments of the tenancy specified. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). When false, the alarm suppression targets only the alarms under the specified compartment. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
targetType |
- | string |
No | - | - |
Spec.suppressionConditions[]¶
AlarmSuppressionSuppressionCondition defines nested fields for AlarmSuppression.SuppressionCondition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
conditionType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
suppressionDuration |
Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: PT1M (1 minute). Maximum: PT24H (24 hours). |
string |
No | - | - |
suppressionRecurrence |
Frequency and start time of the recurring suppression. The format follows the iCalendar specification (RFC 5545, section 3.3.10) (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported rule parts: * FREQ: Frequency of the recurring suppression: WEEKLY or DAILY only. * BYDAY: Comma separated days. Use with weekly suppressions only. Supported values: MO, TU, WE, TH, FR, SA ,SU. * BYHOUR, BYMINUTE, BYSECOND: Start time in UTC, after timeSuppressFrom value. Default is 00:00:00 UTC after timeSuppressFrom. |
string |
No | - | - |
Status¶
AlarmSuppressionStatus defines the observed state of AlarmSuppression.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
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 | - | - |
Status.alarmSuppressionTarget¶
Back to AlarmSuppression status
AlarmSuppressionTarget defines nested fields for AlarmSuppression.AlarmSuppressionTarget.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
alarmId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm that is the target of the alarm suppression. | string |
No | - | - |
compartmentId |
The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment or tenancy that is the target of the alarm suppression. Example: ocid1.compartment.oc1..exampleuniqueID |
string |
No | - | - |
compartmentIdInSubtree |
When true, the alarm suppression targets all alarms under all compartments and subcompartments of the tenancy specified. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). When false, the alarm suppression targets only the alarms under the specified compartment. | boolean |
No | - | - |
jsonData |
- | string |
No | - | - |
targetType |
- | string |
No | - | - |
Status.status¶
Back to AlarmSuppression status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
async |
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. | object |
No | - | - |
conditions |
- | list[object] |
No | - | - |
createdAt |
- | string (date-time) |
No | - | - |
deletedAt |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
ocid |
- | string |
No | - | - |
opcRequestId |
OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. | string |
No | - | - |
reason |
- | string |
No | - | - |
requestedAt |
- | string (date-time) |
No | - | - |
updatedAt |
- | string (date-time) |
No | - | - |
Status.status.async¶
Back to AlarmSuppression status
Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
current |
- | object |
No | - | - |
Status.status.async.current¶
Back to AlarmSuppression status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
message |
- | string |
No | - | - |
normalizedClass |
- | string |
Yes | - | attention, canceled, failed, pending, succeeded, unknown |
percentComplete |
- | number |
No | - | - |
phase |
- | string |
Yes | - | create, delete, update |
rawOperationType |
- | string |
No | - | - |
rawStatus |
- | string |
No | - | - |
source |
- | string |
Yes | - | lifecycle, none, workrequest |
updatedAt |
- | string (date-time) |
Yes | - | - |
workRequestId |
- | string |
No | - | - |
Status.status.conditions[]¶
Back to AlarmSuppression status
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
lastTransitionTime |
- | string (date-time) |
No | - | - |
message |
- | string |
No | - | - |
reason |
- | string |
No | - | - |
status |
- | string |
Yes | - | - |
type |
- | string |
Yes | - | - |
Status.suppressionConditions[]¶
Back to AlarmSuppression status
AlarmSuppressionSuppressionCondition defines nested fields for AlarmSuppression.SuppressionCondition.
| Field | Description | Type | Required | Default | Enum |
|---|---|---|---|---|---|
conditionType |
- | string |
No | - | - |
jsonData |
- | string |
No | - | - |
suppressionDuration |
Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: PT1M (1 minute). Maximum: PT24H (24 hours). |
string |
No | - | - |
suppressionRecurrence |
Frequency and start time of the recurring suppression. The format follows the iCalendar specification (RFC 5545, section 3.3.10) (https://datatracker.ietf.org/doc/html/rfc5545#section-3.3.10). Supported rule parts: * FREQ: Frequency of the recurring suppression: WEEKLY or DAILY only. * BYDAY: Comma separated days. Use with weekly suppressions only. Supported values: MO, TU, WE, TH, FR, SA ,SU. * BYHOUR, BYMINUTE, BYSECOND: Start time in UTC, after timeSuppressFrom value. Default is 00:00:00 UTC after timeSuppressFrom. |
string |
No | - | - |