Monitoring Common Types
DBMS_CLOUD_OCI_MONITORING_VARCHAR2_TBL Type
Nested table type of varchar2(32767).
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;DBMS_CLOUD_OCI_MONITORING_AGGREGATED_DATAPOINT_T Type
A timestamp-value pair returned for the specified request.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_aggregated_datapoint_t FORCE AUTHID CURRENT_USER IS OBJECT (
l_timestamp timestamp with time zone,
value number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_aggregated_datapoint_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_aggregated_datapoint_t (
l_timestamp timestamp with time zone,
value number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The date and time associated with the value of this data point. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z` |
|
|
(required) Numeric value of the metric. Example: `10.4` |
DBMS_CLOUD_OCI_MONITORING_SUPPRESSION_T Type
The configuration details for suppressing an alarm. For information about alarms, see Alarms Overview.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_suppression_t FORCE AUTHID CURRENT_USER IS OBJECT (
description varchar2(32767),
time_suppress_from timestamp with time zone,
time_suppress_until timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_suppression_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_suppression_t (
description varchar2,
time_suppress_from timestamp with time zone,
time_suppress_until timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) 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.` |
|
|
(required) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z` |
|
|
(required) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T02:02:29.600Z` |
DBMS_CLOUD_OCI_MONITORING_ALARM_T Type
The properties that define an alarm. For information about alarms, see Alarms Overview. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
metric_compartment_id varchar2(32767),
metric_compartment_id_in_subtree number,
namespace varchar2(32767),
resource_group varchar2(32767),
query varchar2(32767),
resolution varchar2(32767),
pending_duration varchar2(32767),
severity varchar2(32767),
body varchar2(32767),
is_notifications_per_metric_dimension_enabled number,
message_format varchar2(32767),
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
repeat_notification_duration varchar2(32767),
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2(32767),
time_created timestamp with time zone,
time_updated timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
metric_compartment_id varchar2,
metric_compartment_id_in_subtree number,
namespace varchar2,
resource_group varchar2,
query varchar2,
resolution varchar2,
pending_duration varchar2,
severity varchar2,
body varchar2,
is_notifications_per_metric_dimension_enabled number,
message_format varchar2,
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
repeat_notification_duration varchar2,
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2,
time_created timestamp with time zone,
time_updated timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the alarm. |
|
|
(required) 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` |
|
|
(required) The OCID of the compartment containing the alarm. |
|
|
(required) The OCID of the compartment containing the metric being evaluated by the alarm. |
|
|
(optional) 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` |
|
|
(required) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent` |
|
|
(optional) 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` |
|
|
(required) 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. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services. 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() ----- |
|
|
(optional) The time between calculated aggregation windows for the alarm. Supported value: `1m` |
|
|
(optional) 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` |
|
|
(required) The perceived type of response required when the alarm is in the \"FIRING\" state. Example: `CRITICAL` Allowed values are: 'CRITICAL', 'ERROR', 'WARNING', 'INFO' |
|
|
(optional) The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example: `High CPU usage alert. Follow runbook instructions for resolution.` |
|
|
(optional) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. |
|
|
(optional) 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. Allowed values are: 'RAW', 'PRETTY_JSON', 'ONS_OPTIMIZED' |
|
|
(required) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a |
|
|
(optional) 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` |
|
|
(optional) The configuration details for suppressing an alarm. |
|
|
(required) Whether the alarm is enabled. Example: `true` |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
|
|
(required) The current lifecycle state of the alarm. Example: `DELETED` Allowed values are: 'ACTIVE', 'DELETING', 'DELETED' |
|
|
(required) The date and time the alarm was created. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z` |
|
|
(required) The date and time the alarm was last updated. Format defined by RFC3339. Example: `2019-02-03T01:02:29.600Z` |
DBMS_CLOUD_OCI_MONITORING_ALARM_DIMENSION_STATES_ENTRY_T Type
A timestamped alarm state entry for a metric stream.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_dimension_states_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
dimensions json_element_t,
status varchar2(32767),
l_timestamp timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_dimension_states_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_dimension_states_entry_t (
dimensions json_element_t,
status varchar2,
l_timestamp timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Indicator of the metric stream associated with the alarm state entry. Includes one or more dimension key-value pairs. |
|
|
(required) Transition state (status value) associated with the alarm state entry. Example: `FIRING` Allowed values are: 'FIRING', 'OK' |
|
|
(required) Transition time associated with the alarm state entry. Format defined by RFC3339. Example: `2022-02-01T01:02:29.600Z` |
DBMS_CLOUD_OCI_MONITORING_ALARM_DIMENSION_STATES_ENTRY_TBL Type
Nested table type of dbms_cloud_oci_monitoring_alarm_dimension_states_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_dimension_states_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_monitoring_alarm_dimension_states_entry_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MONITORING_ALARM_DIMENSION_STATES_COLLECTION_T Type
The list of current alarm state entries for each metric stream that matches the filters.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_dimension_states_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
alarm_id varchar2(32767),
is_enabled number,
is_notifications_per_metric_dimension_enabled number,
items dbms_cloud_oci_monitoring_alarm_dimension_states_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_dimension_states_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_dimension_states_collection_t (
alarm_id varchar2,
is_enabled number,
is_notifications_per_metric_dimension_enabled number,
items dbms_cloud_oci_monitoring_alarm_dimension_states_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the alarm to retrieve alarm state entries for. |
|
|
(required) Whether the alarm is enabled. Example: `true` |
|
|
(required) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. |
|
|
(required) Array of alarm state entries. |
DBMS_CLOUD_OCI_MONITORING_ALARM_HISTORY_ENTRY_T Type
An alarm history entry indicating a description of the entry and the time that the entry occurred. If the entry corresponds to a state transition, such as OK to Firing, then the entry also includes a transition timestamp.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_history_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
summary varchar2(32767),
l_timestamp timestamp with time zone,
timestamp_triggered timestamp with time zone,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_history_entry_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_history_entry_t (
summary varchar2,
l_timestamp timestamp with time zone,
timestamp_triggered timestamp with time zone
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Description for this alarm history entry. Example 1 - alarm state history entry: `The alarm state is FIRING` Example 2 - alarm state transition history entry: `State transitioned from OK to Firing` |
|
|
(required) Timestamp for this alarm history entry. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z` |
|
|
(optional) Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2019-02-01T0:59:00.789Z` |
DBMS_CLOUD_OCI_MONITORING_ALARM_HISTORY_ENTRY_TBL Type
Nested table type of dbms_cloud_oci_monitoring_alarm_history_entry_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_history_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_monitoring_alarm_history_entry_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MONITORING_ALARM_HISTORY_COLLECTION_T Type
The configuration details for retrieving alarm history.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_history_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
alarm_id varchar2(32767),
is_enabled number,
entries dbms_cloud_oci_monitoring_alarm_history_entry_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_history_collection_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_history_collection_t (
alarm_id varchar2,
is_enabled number,
entries dbms_cloud_oci_monitoring_alarm_history_entry_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the alarm to retrieve history for. |
|
|
(required) Whether the alarm is enabled. Example: `true` |
|
|
(required) The set of history entries retrieved for the alarm. |
DBMS_CLOUD_OCI_MONITORING_ALARM_STATUS_SUMMARY_T Type
A summary of properties for the specified alarm and its current evaluation status. For information about alarms, see Alarms Overview. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_status_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
severity varchar2(32767),
timestamp_triggered timestamp with time zone,
status varchar2(32767),
suppression dbms_cloud_oci_monitoring_suppression_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_status_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_status_summary_t (
id varchar2,
display_name varchar2,
severity varchar2,
timestamp_triggered timestamp with time zone,
status varchar2,
suppression dbms_cloud_oci_monitoring_suppression_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the alarm. |
|
|
(required) The configured name of the alarm. Example: `High CPU Utilization` |
|
|
(required) The configured severity of the alarm. Example: `CRITICAL` Allowed values are: 'CRITICAL', 'ERROR', 'WARNING', 'INFO' |
|
|
(required) Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2019-02-01T01:02:29.600Z` |
|
|
(required) The status of this alarm. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use Allowed values are: 'FIRING', 'OK', 'SUSPENDED' |
|
|
(optional) The configuration details for suppressing an alarm. |
DBMS_CLOUD_OCI_MONITORING_ALARM_SUMMARY_T Type
A summary of properties for the specified alarm. For information about alarms, see Alarms Overview. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies. For information about endpoints and signing API requests, see About the API. For information about available SDKs and tools, see SDKS and Other Tools.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_alarm_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
id varchar2(32767),
display_name varchar2(32767),
compartment_id varchar2(32767),
metric_compartment_id varchar2(32767),
namespace varchar2(32767),
query varchar2(32767),
severity varchar2(32767),
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_summary_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_alarm_summary_t (
id varchar2,
display_name varchar2,
compartment_id varchar2,
metric_compartment_id varchar2,
namespace varchar2,
query varchar2,
severity varchar2,
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t,
lifecycle_state varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the alarm. |
|
|
(required) 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` |
|
|
(required) The OCID of the compartment containing the alarm. |
|
|
(required) The OCID of the compartment containing the metric being evaluated by the alarm. |
|
|
(required) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent` |
|
|
(required) 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. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services. 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() ----- |
|
|
(required) The perceived severity of the alarm with regard to the affected system. Example: `CRITICAL` Allowed values are: 'CRITICAL', 'ERROR', 'WARNING', 'INFO' |
|
|
(required) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a |
|
|
(optional) The configuration details for suppressing an alarm. |
|
|
(required) Whether the alarm is enabled. Example: `true` |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
|
|
(required) The current lifecycle state of the alarm. Example: `DELETED` |
DBMS_CLOUD_OCI_MONITORING_CHANGE_ALARM_COMPARTMENT_DETAILS_T Type
The configuration details for moving an alarm.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_change_alarm_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
compartment_id varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_change_alarm_compartment_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_change_alarm_compartment_details_t (
compartment_id varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The OCID of the compartment to move the alarm to. |
DBMS_CLOUD_OCI_MONITORING_CREATE_ALARM_DETAILS_T Type
The configuration details for creating an alarm.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_create_alarm_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
compartment_id varchar2(32767),
metric_compartment_id varchar2(32767),
metric_compartment_id_in_subtree number,
namespace varchar2(32767),
resource_group varchar2(32767),
query varchar2(32767),
resolution varchar2(32767),
pending_duration varchar2(32767),
severity varchar2(32767),
body varchar2(32767),
is_notifications_per_metric_dimension_enabled number,
message_format varchar2(32767),
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
repeat_notification_duration varchar2(32767),
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_create_alarm_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_create_alarm_details_t (
display_name varchar2,
compartment_id varchar2,
metric_compartment_id varchar2,
metric_compartment_id_in_subtree number,
namespace varchar2,
resource_group varchar2,
query varchar2,
resolution varchar2,
pending_duration varchar2,
severity varchar2,
body varchar2,
is_notifications_per_metric_dimension_enabled number,
message_format varchar2,
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
repeat_notification_duration varchar2,
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) 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` |
|
|
(required) The OCID of the compartment containing the alarm. |
|
|
(required) The OCID of the compartment containing the metric being evaluated by the alarm. |
|
|
(optional) 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` |
|
|
(required) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent` |
|
|
(optional) 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` |
|
|
(required) 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. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services. 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() ----- |
|
|
(optional) The time between calculated aggregation windows for the alarm. Supported value: `1m` |
|
|
(optional) 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` |
|
|
(required) The perceived type of response required when the alarm is in the \"FIRING\" state. Example: `CRITICAL` |
|
|
(optional) The human-readable content of the delivered alarm notification. 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.` |
|
|
(optional) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true` |
|
|
(optional) 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. Allowed values are: 'RAW', 'PRETTY_JSON', 'ONS_OPTIMIZED' |
|
|
(required) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a |
|
|
(optional) 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` |
|
|
(optional) The configuration details for suppressing an alarm. |
|
|
(required) Whether the alarm is enabled. Example: `true` |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |
DBMS_CLOUD_OCI_MONITORING_DATAPOINT_T Type
Metric value for a specific timestamp.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_datapoint_t FORCE AUTHID CURRENT_USER IS OBJECT (
l_timestamp timestamp with time zone,
value number,
l_count number,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_datapoint_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_datapoint_t (
l_timestamp timestamp with time zone,
value number,
l_count number
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) Timestamp for this metric value. Format defined by RFC3339. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future). Example: `2019-02-01T01:02:29.600Z` |
|
|
(required) Numeric value of the metric. Example: `10.23` |
|
|
(optional) The number of occurrences of the associated value in the set of data. Default is 1. Value must be greater than zero. |
DBMS_CLOUD_OCI_MONITORING_ERROR_T Type
An error has occurred.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
code varchar2(32767),
message varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_error_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_error_t (
code varchar2,
message varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A short error code that defines the error, meant for programmatic parsing. See API Errors. |
|
|
(required) A human-readable error string. |
DBMS_CLOUD_OCI_MONITORING_DATAPOINT_TBL Type
Nested table type of dbms_cloud_oci_monitoring_datapoint_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_datapoint_tbl FORCE IS TABLE OF (dbms_cloud_oci_monitoring_datapoint_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MONITORING_METRIC_DATA_DETAILS_T Type
A metric object containing raw metric data points to be posted to the Monitoring service.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_metric_data_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
namespace varchar2(32767),
resource_group varchar2(32767),
compartment_id varchar2(32767),
name varchar2(32767),
dimensions json_element_t,
metadata json_element_t,
datapoints dbms_cloud_oci_monitoring_datapoint_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_metric_data_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_metric_data_details_t (
namespace varchar2,
resource_group varchar2,
compartment_id varchar2,
name varchar2,
dimensions json_element_t,
metadata json_element_t,
datapoints dbms_cloud_oci_monitoring_datapoint_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The source service or application emitting the metric. A valid namespace value starts with an alphabetical character and includes only alphanumeric characters and underscores. The \"oci_\" prefix is reserved. Avoid entering confidential information. Example: `my_namespace` |
|
|
(optional) Resource group to assign to the metric. 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 ($). Avoid entering confidential information. Example: `frontend-fleet` |
|
|
(required) The OCID of the compartment to use for metrics. |
|
|
(required) The name of the metric. A valid name value starts with an alphabetical character and includes only alphanumeric characters, dots, underscores, hyphens, and dollar signs. The `oci_` prefix is reserved. Avoid entering confidential information. Example: `my_app.success_rate` |
|
|
(required) Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. A valid dimension key includes only printable ASCII, excluding spaces. The character limit for a dimension key is 256. A valid dimension value includes only Unicode characters. The character limit for a dimension value is 512. Empty strings are not allowed for keys or values. Avoid entering confidential information. Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"` |
|
|
(optional) Properties describing metrics. These are not part of the unique fields identifying the metric. Each metadata item takes the form of a key-value pair. The character limit for a metadata key is 256. The character limit for a metadata value is 256. Example: `\"unit\": \"bytes\"` |
|
|
(required) A list of metric values with timestamps. At least one data point is required per call. For a data point to be posted, its timestamp must be near current time (less than two hours in the past and less than 10 minutes in the future). |
DBMS_CLOUD_OCI_MONITORING_FAILED_METRIC_RECORD_T Type
The record of a single metric object that failed input validation and the reason for the failure.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_failed_metric_record_t FORCE AUTHID CURRENT_USER IS OBJECT (
message varchar2(32767),
metric_data dbms_cloud_oci_monitoring_metric_data_details_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_failed_metric_record_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_failed_metric_record_t (
message varchar2,
metric_data dbms_cloud_oci_monitoring_metric_data_details_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) An error message indicating the reason that the indicated metric object failed input validation. |
|
|
(required) Identifier of a metric object that failed input validation. |
DBMS_CLOUD_OCI_MONITORING_LIST_METRICS_DETAILS_T Type
The request details for retrieving metric definitions. Specify optional properties to filter the returned results. Use an asterisk (*) as a wildcard character, placed anywhere in the string. For example, to search for all metrics with names that begin with \"disk\", specify \"name\" as \"disk*\". If no properties are specified, then all metric definitions within the request scope are returned.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_list_metrics_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
namespace varchar2(32767),
resource_group varchar2(32767),
dimension_filters json_element_t,
group_by dbms_cloud_oci_monitoring_varchar2_tbl,
sort_by varchar2(32767),
sort_order varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_list_metrics_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_list_metrics_details_t (
name varchar2,
namespace varchar2,
resource_group varchar2,
dimension_filters json_element_t,
group_by dbms_cloud_oci_monitoring_varchar2_tbl,
sort_by varchar2,
sort_order varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The metric name to use when searching for metric definitions. Example: `CpuUtilization` |
|
|
(optional) The source service or application to use when searching for metric definitions. Example: `oci_computeagent` |
|
|
(optional) Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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` |
|
|
(optional) Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"` |
|
|
(optional) Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the \"namespace\" field. Supported fields: namespace, name, resourceGroup. If `groupBy` is used, then `dimensionFilters` is ignored. Example - group by namespace: `[ \"namespace\" ]` |
|
|
(optional) The field to use when sorting returned metric definitions. Only one sorting level is provided. Example: `NAMESPACE` Allowed values are: 'NAMESPACE', 'NAME', 'RESOURCEGROUP' |
|
|
(optional) The sort order to use when sorting returned metric definitions. Ascending (ASC) or descending (DESC). Example: `ASC` Allowed values are: 'ASC', 'DESC' |
DBMS_CLOUD_OCI_MONITORING_METRIC_T Type
The properties that define a metric. For information about metrics, see Metrics Overview.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_metric_t FORCE AUTHID CURRENT_USER IS OBJECT (
name varchar2(32767),
namespace varchar2(32767),
resource_group varchar2(32767),
compartment_id varchar2(32767),
dimensions json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_metric_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_metric_t (
name varchar2,
namespace varchar2,
resource_group varchar2,
compartment_id varchar2,
dimensions json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) The name of the metric. Example: `CpuUtilization` |
|
|
(optional) The source service or application emitting the metric. Example: `oci_computeagent` |
|
|
(optional) Resource group provided with the posted metric. 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` |
|
|
(optional) The OCID of the compartment containing the resources monitored by the metric. |
|
|
(optional) Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"` |
DBMS_CLOUD_OCI_MONITORING_AGGREGATED_DATAPOINT_TBL Type
Nested table type of dbms_cloud_oci_monitoring_aggregated_datapoint_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_aggregated_datapoint_tbl FORCE IS TABLE OF (dbms_cloud_oci_monitoring_aggregated_datapoint_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MONITORING_METRIC_DATA_T Type
The set of aggregated data returned for a metric. For information about metrics, see Metrics Overview. Limits information for returned data follows. * Data points: 100,000. * Metric streams* within data points: 2,000. * Time range returned for 1-day resolution: 90 days. * Time range returned for 1-hour resolution: 90 days. * Time range returned for 5-minute resolution: 30 days. * Time range returned for 1-minute resolution: 7 days. *A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. Metric streams cannot be aggregated across metric groups. A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. For more information about metric-related concepts, see Monitoring Concepts.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_metric_data_t FORCE AUTHID CURRENT_USER IS OBJECT (
namespace varchar2(32767),
resource_group varchar2(32767),
compartment_id varchar2(32767),
name varchar2(32767),
dimensions json_element_t,
metadata json_element_t,
resolution varchar2(32767),
aggregated_datapoints dbms_cloud_oci_monitoring_aggregated_datapoint_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_metric_data_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_metric_data_t (
namespace varchar2,
resource_group varchar2,
compartment_id varchar2,
name varchar2,
dimensions json_element_t,
metadata json_element_t,
resolution varchar2,
aggregated_datapoints dbms_cloud_oci_monitoring_aggregated_datapoint_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example: `oci_computeagent` |
|
|
(optional) Resource group provided with the posted metric. 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` |
|
|
(required) The OCID of the compartment containing the resources that the aggregated data was returned from. |
|
|
(required) The name of the metric. Example: `CpuUtilization` |
|
|
(required) Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"` |
|
|
(optional) The references provided in a metric definition to indicate extra information about the metric. Example: `\"unit\": \"bytes\"` |
|
|
(optional) The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. Example: `5m` |
|
|
(required) The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page. |
DBMS_CLOUD_OCI_MONITORING_METRIC_DATA_DETAILS_TBL Type
Nested table type of dbms_cloud_oci_monitoring_metric_data_details_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_metric_data_details_tbl FORCE IS TABLE OF (dbms_cloud_oci_monitoring_metric_data_details_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MONITORING_POST_METRIC_DATA_DETAILS_T Type
An array of metric objects containing raw metric data points to be posted to the Monitoring service.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_post_metric_data_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
metric_data dbms_cloud_oci_monitoring_metric_data_details_tbl,
batch_atomicity varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_post_metric_data_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_post_metric_data_details_t (
metric_data dbms_cloud_oci_monitoring_metric_data_details_tbl,
batch_atomicity varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) A metric object containing raw metric data points to be posted to the Monitoring service. |
|
|
(optional) Batch atomicity behavior. Requires either partial or full pass of input validation for metric objects in PostMetricData requests. The default value of NON_ATOMIC requires a partial pass: at least one metric object in the request must pass input validation, and any objects that failed validation are identified in the returned summary, along with their error messages. A value of ATOMIC requires a full pass: all metric objects in the request must pass input validation. Example: `NON_ATOMIC` Allowed values are: 'ATOMIC', 'NON_ATOMIC' |
DBMS_CLOUD_OCI_MONITORING_FAILED_METRIC_RECORD_TBL Type
Nested table type of dbms_cloud_oci_monitoring_failed_metric_record_t.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_failed_metric_record_tbl FORCE IS TABLE OF (dbms_cloud_oci_monitoring_failed_metric_record_t) NOT PERSISTABLE;DBMS_CLOUD_OCI_MONITORING_POST_METRIC_DATA_RESPONSE_DETAILS_T Type
The response object returned from a PostMetricData operation.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_post_metric_data_response_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
failed_metrics_count number,
failed_metrics dbms_cloud_oci_monitoring_failed_metric_record_tbl,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_post_metric_data_response_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_post_metric_data_response_details_t (
failed_metrics_count number,
failed_metrics dbms_cloud_oci_monitoring_failed_metric_record_tbl
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The number of metric objects that failed input validation. |
|
|
(optional) A list of records identifying metric objects that failed input validation and the reasons for the failures. |
DBMS_CLOUD_OCI_MONITORING_RETRIEVE_DIMENSION_STATES_DETAILS_T Type
The configuration details for retrieving the alarm state entries. Filter retrieved alarm state entries by status value and dimension key-value pairs.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_retrieve_dimension_states_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
dimension_filters json_element_t,
status varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_retrieve_dimension_states_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_retrieve_dimension_states_details_t (
dimension_filters json_element_t,
status varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) A filter to return only alarm state entries that match the exact set of specified dimension key-value pairs. If you specify `\"availabilityDomain\": \"phx-ad-1\"` but the alarm state entry corresponds to the set `\"availabilityDomain\": \"phx-ad-1\"` and `\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"`, then no results are returned. |
|
|
(optional) A filter to return only alarm state entries that match the status value. Example: `FIRING` |
DBMS_CLOUD_OCI_MONITORING_SUMMARIZE_METRICS_DATA_DETAILS_T Type
The request details for retrieving aggregated data. Use the query and optional properties to filter the returned results.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_summarize_metrics_data_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
namespace varchar2(32767),
resource_group varchar2(32767),
query varchar2(32767),
start_time timestamp with time zone,
end_time timestamp with time zone,
resolution varchar2(32767),
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_summarize_metrics_data_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_summarize_metrics_data_details_t (
namespace varchar2,
resource_group varchar2,
query varchar2,
start_time timestamp with time zone,
end_time timestamp with time zone,
resolution varchar2
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(required) The source service or application to use when searching for metric data points to aggregate. Example: `oci_computeagent` |
|
|
(optional) Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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` |
|
|
(required) The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. 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. Supported grouping functions: `grouping()`, `groupBy()`. Construct your query to avoid exceeding limits on returned data. See |
|
|
(optional) The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent. Example: `2019-02-01T01:02:29.600Z` |
|
|
(optional) The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent. Example: `2019-02-01T02:02:29.600Z` |
|
|
(optional) The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. Example: `5m` |
DBMS_CLOUD_OCI_MONITORING_UPDATE_ALARM_DETAILS_T Type
The configuration details for updating an alarm.
Syntax
CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_monitoring_update_alarm_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
display_name varchar2(32767),
compartment_id varchar2(32767),
metric_compartment_id varchar2(32767),
metric_compartment_id_in_subtree number,
namespace varchar2(32767),
resource_group varchar2(32767),
query varchar2(32767),
resolution varchar2(32767),
pending_duration varchar2(32767),
severity varchar2(32767),
body varchar2(32767),
is_notifications_per_metric_dimension_enabled number,
message_format varchar2(32767),
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
repeat_notification_duration varchar2(32767),
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_update_alarm_details_t
RETURN SELF AS RESULT,
CONSTRUCTOR FUNCTION dbms_cloud_oci_monitoring_update_alarm_details_t (
display_name varchar2,
compartment_id varchar2,
metric_compartment_id varchar2,
metric_compartment_id_in_subtree number,
namespace varchar2,
resource_group varchar2,
query varchar2,
resolution varchar2,
pending_duration varchar2,
severity varchar2,
body varchar2,
is_notifications_per_metric_dimension_enabled number,
message_format varchar2,
destinations dbms_cloud_oci_monitoring_varchar2_tbl,
repeat_notification_duration varchar2,
suppression dbms_cloud_oci_monitoring_suppression_t,
is_enabled number,
freeform_tags json_element_t,
defined_tags json_element_t
) RETURN SELF AS RESULT
) NOT PERSISTABLE;Fields
| Field | Description |
|---|---|
|
|
(optional) 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` |
|
|
(optional) The OCID of the compartment containing the alarm. |
|
|
(optional) The OCID of the compartment containing the metric being evaluated by the alarm. |
|
|
(optional) 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` |
|
|
(optional) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent` |
|
|
(optional) 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` |
|
|
(optional) 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. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see Editing the MQL Expression for a Query. For details about MQL, see Monitoring Query Language (MQL) Reference. For available dimensions, review the metric definition for the supported service. See Supported Services. 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() ----- |
|
|
(optional) The time between calculated aggregation windows for the alarm. Supported value: `1m` |
|
|
(optional) 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` |
|
|
(optional) The perceived severity of the alarm with regard to the affected system. Example: `CRITICAL` |
|
|
(optional) The human-readable content of the delivered alarm notification. 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.` |
|
|
(optional) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. |
|
|
(optional) 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. Allowed values are: 'RAW', 'PRETTY_JSON', 'ONS_OPTIMIZED' |
|
|
(optional) A list of destinations for alarm notifications. Each destination is represented by the OCID of a related resource, such as a |
|
|
(optional) 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` |
|
|
(optional) The configuration details for suppressing an alarm. |
|
|
(optional) Whether the alarm is enabled. Example: `true` |
|
|
(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"Department\": \"Finance\"}` |
|
|
(optional) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"Operations\": {\"CostCenter\": \"42\"}}` |