MonitoringClient¶

class oci.monitoring.MonitoringClient(config, **kwargs)¶

Use the Monitoring API to manage metric queries and alarms for assessing the health, capacity, and performance of your cloud resources. Endpoints vary by operation. For PostMetricData, use the telemetry-ingestion endpoints; for all other operations, use the telemetry endpoints. For more information, see [the Monitoring documentation](/iaas/Content/Monitoring/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`change_alarm_compartment`(alarm_id, …)	Moves an alarm into a different compartment within the same tenancy.
`create_alarm`(create_alarm_details, **kwargs)	Creates a new alarm in the specified compartment.
`create_alarm_suppression`(…)	Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific).
`delete_alarm`(alarm_id, **kwargs)	Deletes the specified alarm.
`delete_alarm_suppression`(…)	Deletes the specified alarm suppression.
`get_alarm`(alarm_id, **kwargs)	Gets the specified alarm.
`get_alarm_history`(alarm_id, **kwargs)	Get the history of the specified alarm.
`get_alarm_suppression`(alarm_suppression_id, …)	Gets the specified alarm suppression.
`list_alarm_suppressions`(**kwargs)	Lists alarm suppressions for the specified alarm.
`list_alarms`(compartment_id, **kwargs)	Lists the alarms for the specified compartment.
`list_alarms_status`(compartment_id, **kwargs)	List the status of each alarm in the specified compartment.
`list_metrics`(compartment_id, …)	Returns metric definitions that match the criteria specified in the request.
`post_metric_data`(post_metric_data_details, …)	Publishes raw metric data points to the Monitoring service.
`remove_alarm_suppression`(alarm_id, **kwargs)	Removes any existing suppression for the specified alarm.
`retrieve_dimension_states`(alarm_id, **kwargs)	Lists the current alarm status of each metric stream, where status is derived from the metric stream’s last associated transition.
`summarize_alarm_suppression_history`(…)	Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions.
`summarize_metrics_data`(compartment_id, …)	Returns aggregated data that match the criteria specified in the request.
`update_alarm`(alarm_id, update_alarm_details, …)	Updates the specified alarm.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

change_alarm_compartment(alarm_id, change_alarm_compartment_details, **kwargs)¶

Moves an alarm into a different compartment within the same tenancy. For more information, see Moving an Alarm.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. change_alarm_compartment_details (oci.monitoring.models.ChangeAlarmCompartmentDetails) – (required) The configuration details for moving an alarm. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use change_alarm_compartment API.

create_alarm(create_alarm_details, **kwargs)¶

Creates a new alarm in the specified compartment. For more information, see Creating an Alarm. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	create_alarm_details (oci.monitoring.models.CreateAlarmDetails) – (required) Document for creating an alarm. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Alarm`
Return type:	`Response`
Example:

Click here to see an example of how to use create_alarm API.

create_alarm_suppression(create_alarm_suppression_details, **kwargs)¶

Creates a new alarm suppression at the specified level (alarm-wide or dimension-specific). For more information, see Adding an Alarm-wide Suppression and Adding a Dimension-Specific Alarm Suppression.

For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	create_alarm_suppression_details (oci.monitoring.models.CreateAlarmSuppressionDetails) – (required) The details of the alarm suppression to be created opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AlarmSuppression`
Return type:	`Response`
Example:

Click here to see an example of how to use create_alarm_suppression API.

delete_alarm(alarm_id, **kwargs)¶

Deletes the specified alarm. For more information, see Deleting an Alarm. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_alarm API.

delete_alarm_suppression(alarm_suppression_id, **kwargs)¶

Deletes the specified alarm suppression. For more information, see Removing an Alarm-wide Suppression and Removing a Dimension-Specific Alarm Suppression.

For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_suppression_id (str) – (required) The OCID of the alarm suppression. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_alarm_suppression API.

get_alarm(alarm_id, **kwargs)¶

Gets the specified alarm. For more information, see Getting an Alarm. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Alarm`
Return type:	`Response`
Example:

Click here to see an example of how to use get_alarm API.

get_alarm_history(alarm_id, **kwargs)¶

Get the history of the specified alarm. For more information, see Getting History of an Alarm. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. alarm_historytype (str) – (optional) The type of history entries to retrieve. State history (STATE_HISTORY), state transition history (STATE_TRANSITION_HISTORY), rule history (RULE_HISTORY) or rule transition history (RULE_TRANSITION_HISTORY). If not specified, entries of all types are retrieved. Example: STATE_HISTORY Allowed values are: “STATE_HISTORY”, “STATE_TRANSITION_HISTORY”, “RULE_HISTORY”, “RULE_TRANSITION_HISTORY” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500 timestamp_greater_than_or_equal_to (datetime) – (optional) A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339. Example: 2023-01-01T01:00:00.789Z timestamp_less_than (datetime) – (optional) A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339. Example: 2023-01-02T01:00:00.789Z retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AlarmHistoryCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use get_alarm_history API.

get_alarm_suppression(alarm_suppression_id, **kwargs)¶

Gets the specified alarm suppression. For more information, see Getting an Alarm-wide Suppression.

For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_suppression_id (str) – (required) The OCID of the alarm suppression. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AlarmSuppression`
Return type:	`Response`
Example:

Click here to see an example of how to use get_alarm_suppression API.

list_alarm_suppressions(**kwargs)¶

Lists alarm suppressions for the specified alarm. For more information, see Listing Alarm Suppressions.

For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. alarm_id (str) – (optional) The OCID of the alarm that is the target of the alarm suppression. display_name (str) – (optional) A filter to return only resources that match the given display name exactly. Use this filter to list an alarm suppression by name. Alternatively, when you know the alarm suppression OCID, use the GetAlarmSuppression operation. lifecycle_state (str) – (optional) A filter to return only resources that match the given lifecycle state exactly. When not specified, only resources in the ACTIVE lifecycle state are listed. Allowed values are: “ACTIVE”, “DELETED” level (str) – (optional) 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. Allowed values are: “ALARM”, “DIMENSION” compartment_id (str) – (optional) The OCID of the compartment for searching. Use the tenancy OCID to search in the root compartment. If targetType is not specified, searches all suppressions defined under the compartment. If targetType is COMPARTMENT, searches suppressions in the specified compartment only. Example: ocid1.compartment.oc1..exampleuniqueID compartment_id_in_subtree (bool) – (optional) When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false. target_type (str) – (optional) The target type to use when listing alarm suppressions. ALARM lists all suppression records for the specified alarm. COMPARTMENT lists all suppression records for the specified compartment or tenancy. Allowed values are: “ALARM”, “COMPARTMENT” is_all_suppressions (bool) – (optional) Setting this parameter to true requires the query to specify the alarm (alarmId). When true, lists all alarm suppressions that affect the specified alarm, including suppressions that target the corresponding compartment or tenancy. When false, lists only the alarm suppressions that target the specified alarm. Default is false. sort_by (str) – (optional) The field to use when sorting returned alarm suppressions. Only one sorting level is provided. Example: timeCreated Allowed values are: “displayName”, “timeCreated”, “timeSuppressFrom” sort_order (str) – (optional) The sort order to use when sorting returned alarm suppressions. Ascending (ASC) or descending (DESC). Example: ASC Allowed values are: “ASC”, “DESC” page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500 retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AlarmSuppressionCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_alarm_suppressions API.

list_alarms(compartment_id, **kwargs)¶

Lists the alarms for the specified compartment. For more information, see Listing Alarms. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500 display_name (str) – (optional) A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation. lifecycle_state (str) – (optional) A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed. Allowed values are: “ACTIVE”, “DELETING”, “DELETED” sort_by (str) – (optional) The field to use when sorting returned alarm definitions. Only one sorting level is provided. Example: severity Allowed values are: “displayName”, “severity” sort_order (str) – (optional) The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC). Example: ASC Allowed values are: “ASC”, “DESC” compartment_id_in_subtree (bool) – (optional) When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `AlarmSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_alarms API.

list_alarms_status(compartment_id, **kwargs)¶

List the status of each alarm in the specified compartment. Status is collective, across all metric streams in the alarm. To list alarm status for each metric stream, use retrieve_dimension_states(). Optionally filter by resource or status value.

For more information, see Listing Alarm Statuses. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. compartment_id_in_subtree (bool) – (optional) When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500 display_name (str) – (optional) A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation. sort_by (str) – (optional) The field to use when sorting returned alarm definitions. Only one sorting level is provided. Example: severity Allowed values are: “displayName”, “severity” sort_order (str) – (optional) The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC). Example: ASC Allowed values are: “ASC”, “DESC” resource_id (str) – (optional) A filter to return only the resource with the specified OCID. The resource must be monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID service_name (str) – (optional) A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics entity_id (str) – (optional) A filter to return only resources that match the given entity OCID exactly. The resource (entity) must be monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID status (str) – (optional) A filter to return only metric streams that match the specified status. For example, the value “FIRING” returns only firing metric streams. Example: FIRING Allowed values are: “FIRING”, “OK” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `AlarmStatusSummary`
Return type:	`Response`
Example:

Click here to see an example of how to use list_alarms_status API.

list_metrics(compartment_id, list_metrics_details, **kwargs)¶

Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For more information, see Listing Metric Definitions. For information about metrics, see Metrics Overview. For important limits information, see Limits on Monitoring.

Transactions Per Second (TPS) per-tenancy limit for this operation: 10.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID list_metrics_details (oci.monitoring.models.ListMetricsDetails) – (required) The dimensions used to filter metrics. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500 compartment_id_in_subtree (bool) – (optional) When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `Metric`
Return type:	`Response`
Example:

Click here to see an example of how to use list_metrics API.

post_metric_data(post_metric_data_details, **kwargs)¶

Publishes raw metric data points to the Monitoring service. 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).

For more information about publishing metrics, see Publishing Custom Metrics and Custom Metrics Walkthrough. For information about developing a metric-posting client, see Developer Guide. For an example client, see MonitoringMetricPostExample.java. For important limits information, see Limits on Monitoring.

Per-call limits information follows.

Dimensions per metric group*. Maximum: 20. Minimum: 1.
Unique metric streams*. Maximum: 50.
Transactions Per Second (TPS) per-tenancy limit for this operation: 50.

*A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits. A dimension is a qualifier provided in a metric definition. A metric stream is an individual set of aggregated data for a metric with zero or more dimension values. For more information about metric-related concepts, see Monitoring Concepts.

Note: The endpoints for this operation differ from other Monitoring operations. Replace the string telemetry with telemetry-ingestion in the endpoint, as in the following example:

https://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com

Parameters:	post_metric_data_details (oci.monitoring.models.PostMetricDataDetails) – (required) An array of metric objects containing raw metric data points to be posted to the Monitoring service. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. content_encoding (str) – (optional) The optional Content-Encoding header that defines the content encodings that were applied to the payload. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PostMetricDataResponseDetails`
Return type:	`Response`
Example:

Click here to see an example of how to use post_metric_data API.

remove_alarm_suppression(alarm_id, **kwargs)¶

Removes any existing suppression for the specified alarm. For more information, see Removing Suppression from an Alarm. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use remove_alarm_suppression API.

retrieve_dimension_states(alarm_id, **kwargs)¶

Lists the current alarm status of each metric stream, where status is derived from the metric stream’s last associated transition. Optionally filter by status value and one or more dimension key-value pairs.

For more information, see Listing Metric Stream Status in an Alarm.

For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500 retrieve_dimension_states_details (oci.monitoring.models.RetrieveDimensionStatesDetails) – (optional) The configuration details for retrieving the current alarm status of each metric stream. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AlarmDimensionStatesCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use retrieve_dimension_states API.

summarize_alarm_suppression_history(alarm_id, **kwargs)¶

Returns history of suppressions for the specified alarm, including both dimension-specific and and alarm-wide suppressions. For more information, see Getting Suppression History for an Alarm.

For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. page (str) – (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination. limit (int) – (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination. Default: 1000 Example: 500 summarize_alarm_suppression_history_details (oci.monitoring.models.SummarizeAlarmSuppressionHistoryDetails) – (optional) summarize history details retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AlarmSuppressionHistoryItemCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use summarize_alarm_suppression_history API.

summarize_metrics_data(compartment_id, summarize_metrics_data_details, **kwargs)¶

Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For more information, see Querying Metric Data and Creating a Query. For important limits information, see Limits on Monitoring.

Transactions Per Second (TPS) per-tenancy limit for this operation: 10.

Parameters:	compartment_id (str) – (required) The OCID of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: ocid1.compartment.oc1..exampleuniqueID summarize_metrics_data_details (oci.monitoring.models.SummarizeMetricsDataDetails) – (required) The dimensions used to filter for metrics. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. compartment_id_in_subtree (bool) – (optional) When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId 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, returns resources from only the compartment specified in compartmentId. Default is false. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type list of `MetricData`
Return type:	`Response`
Example:

Click here to see an example of how to use summarize_metrics_data API.

update_alarm(alarm_id, update_alarm_details, **kwargs)¶

Updates the specified alarm. For more information, see Updating an Alarm. For important limits information, see Limits on Monitoring.

This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

Parameters:	alarm_id (str) – (required) The OCID of an alarm. update_alarm_details (oci.monitoring.models.UpdateAlarmDetails) – (required) Document for updating an alarm. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation will not retry by default, users can also use the convenient `DEFAULT_RETRY_STRATEGY` provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Alarm`
Return type:	`Response`
Example:

Click here to see an example of how to use update_alarm API.