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 PostMetric, use the telemetry-ingestion endpoints; for all other operations, use the telemetry endpoints. For information about monitoring, see [Monitoring Overview](/iaas/Content/Monitoring/Concepts/monitoringoverview.htm).

__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 is that the client never times out. 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.

change_alarm_compartment(alarm_id, change_alarm_compartment_details, **kwargs)

Moves an alarm into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources Between Compartments.

Parameters:
  • alarm_id (str) --

    (required) The OCID of an alarm.

  • change_alarm_compartment_details (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

create_alarm(create_alarm_details, **kwargs)

Creates a new alarm in the specified compartment.

Creates a new alarm in the specified compartment. 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Alarm

Return type:

Response

delete_alarm(alarm_id, **kwargs)

Deletes an alarm.

Deletes the specified 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

get_alarm(alarm_id, **kwargs)

Gets the specified 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Alarm

Return type:

Response

get_alarm_history(alarm_id, **kwargs)

Get the history of the specified 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) or state transition history (STATE_TRANSITION_HISTORY). If not specified, entries of both types are retrieved.

    Example: STATE_HISTORY

    Allowed values are: "STATE_HISTORY", "STATE_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: 2019-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: 2019-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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AlarmHistoryCollection

Return type:

Response

list_alarms(compartment_id, **kwargs)

Lists the alarms for the specified compartment. 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AlarmSummary

Return type:

Response

list_alarms_status(compartment_id, **kwargs)

List the status of each alarm in the specified compartment. 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"

  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of AlarmStatusSummary

Return type:

Response

list_metrics(compartment_id, list_metrics_details, **kwargs)

List metrics based on matching criteria. Returns metric definitions that match the criteria specified in the request. Compartment OCID required. 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Metric

Return type:

Response

post_metric_data(post_metric_data_details, **kwargs)

Publishes raw metric data points to the Monitoring service.

Publishes raw metric data points to the Monitoring service. For more information about publishing metrics, see Publishing Custom Metrics. 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, typically specific to a resource. For more information about metric-related concepts, see Monitoring Concepts.

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 (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.
  • 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PostMetricDataResponseDetails

Return type:

Response

remove_alarm_suppression(alarm_id, **kwargs)

Removes any existing suppression for the specified alarm.

Removes any existing suppression for the specified 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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

summarize_metrics_data(compartment_id, summarize_metrics_data_details, **kwargs)

Summarizes and returns metrics data filtered using the provided query expression and compartmentId. Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For information on metric queries, see Building Metric Queries. 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of MetricData

Return type:

Response

update_alarm(alarm_id, update_alarm_details, **kwargs)

Updates an alarm.

Updates the specified 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 (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. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Alarm

Return type:

Response