ConfigClient

class oci.apm_config.ConfigClient(config, **kwargs)

Use the Application Performance Monitoring Configuration API to query and set Application Performance Monitoring configuration. For more information, see [Application Performance Monitoring](https://docs.oracle.com/iaas/application-performance-monitoring/index.html).

Methods

__init__(config, **kwargs) Creates a new service client
create_config(apm_domain_id, …) Creates a new configuration item.
delete_config(apm_domain_id, config_id, **kwargs) Deletes the configuration item identified by the OCID.
get_config(apm_domain_id, config_id, **kwargs) Gets the configuration item identified by the OCID.
list_configs(apm_domain_id, **kwargs) Returns all configuration items, which can optionally be filtered by configuration type.
retrieve_namespace_metrics(apm_domain_id, …) Returns all metrics associated with the specified namespace.
retrieve_namespaces(apm_domain_id, **kwargs) Returns all namespaces available in APM.
test(apm_domain_id, test_details, **kwargs) Tests a data processing operation on the provided input, returning the potentially modified input as output.
update_config(apm_domain_id, config_id, …) Updates the details of the configuration item identified by the OCID.
validate_span_filter_pattern(apm_domain_id, …) Validates the Span Filter pattern (filterText) for syntactic correctness.
__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.
create_config(apm_domain_id, create_config_details, **kwargs)

Creates a new configuration item.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • create_config_details (oci.apm_config.models.CreateConfigDetails) – (required) The configuration details of the new item.
  • 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.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_dry_run (str) – (optional) Indicates that the request is a dry run, if set to “true”. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
  • 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 Config
Return type:

Response
Example:

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

delete_config(apm_domain_id, config_id, **kwargs)

Deletes the configuration item identified by the OCID.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • config_id (str) –

    (required) The OCID of the configuration item.

  • 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) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the 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 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 None
Return type:

Response
Example:

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

get_config(apm_domain_id, config_id, **kwargs)

Gets the configuration item identified by the OCID.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • config_id (str) –

    (required) The OCID of the configuration item.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the 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 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 Config
Return type:

Response
Example:

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

list_configs(apm_domain_id, **kwargs)

Returns all configuration items, which can optionally be filtered by configuration type.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • config_type (str) – (optional) A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, and APDEX.
  • display_name (str) – (optional) A filter to return resources that match the given display name.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) –

    (optional) The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The displayName sort order is case-sensitive.

    Allowed values are: “ASC”, “DESC”

  • sort_by (str) –

    (optional) The field to sort by. You can provide one “sortBy” value. The default order for displayName, timeCreated and timeUpdated is ascending. The displayName sort by is case-sensitive.

    Allowed values are: “displayName”, “timeCreated”, “timeUpdated”

  • options_group (str) – (optional) A filter to return OPTIONS resources that match the given group.
  • defined_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a defined tag matching the value will be returned. Each item in the list has the format “{namespace}.{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.
  • freeform_tag_equals (list[str]) – (optional) A list of tag filters to apply. Only resources with a freeform tag matching the value will be returned. The key for each tag is “{tagName}.{value}”. All inputs are case-insensitive. Multiple values for the same tag name are interpreted as “OR”. Values for different tag names are interpreted as “AND”.
  • defined_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified defined tags exist will be returned. Each item in the list has the format “{namespace}.{tagName}.true” (for checking existence of a defined tag) or “{namespace}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for the same key (i.e. same namespace and tag name) are interpreted as “OR”. Values for different keys (i.e. different namespaces, different tag names, or both) are interpreted as “AND”.
  • freeform_tag_exists (list[str]) – (optional) A list of tag existence filters to apply. Only resources for which the specified freeform tags exist the value will be returned. The key for each tag is “{tagName}.true”. All inputs are case-insensitive. Currently, only existence (“true” at the end) is supported. Absence (“false” at the end) is not supported. Multiple values for different tag names are interpreted as “AND”.
  • 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 ConfigCollection
Return type:

Response
Example:

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

retrieve_namespace_metrics(apm_domain_id, retrieve_namespace_metrics_details, **kwargs)

Returns all metrics associated with the specified namespace.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • retrieve_namespace_metrics_details (oci.apm_config.models.RetrieveNamespaceMetricsDetails) – (required) The namespace to get the metrics for.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the 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 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 NamespaceMetricCollection
Return type:

Response
Example:

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

retrieve_namespaces(apm_domain_id, **kwargs)

Returns all namespaces available in APM.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the 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 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 NamespaceCollection
Return type:

Response
Example:

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

test(apm_domain_id, test_details, **kwargs)

Tests a data processing operation on the provided input, returning the potentially modified input as output. Returns 200 on success, 422 when the input can not be processed.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • test_details (oci.apm_config.models.TestDetails) – (required) The test input.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the 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 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 TestOutput
Return type:

Response
Example:

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

update_config(apm_domain_id, config_id, update_config_details, **kwargs)

Updates the details of the configuration item identified by the OCID.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • config_id (str) –

    (required) The OCID of the configuration item.

  • update_config_details (oci.apm_config.models.UpdateConfigDetails) – (required) The configuration details to be updated.
  • 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) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_dry_run (str) – (optional) Indicates that the request is a dry run, if set to “true”. A dry run request does not modify the configuration item details and is used only to perform validation on the submitted data.
  • 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 Config
Return type:

Response
Example:

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

validate_span_filter_pattern(apm_domain_id, validate_span_filter_pattern_details, **kwargs)

Validates the Span Filter pattern (filterText) for syntactic correctness. Returns 204 on success, 422 when validation fails.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain ID the request is intended for.
  • validate_span_filter_pattern_details (oci.apm_config.models.ValidateSpanFilterPatternDetails) – (required) The Span Filter pattern to validate.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the 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 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 None
Return type:

Response
Example:

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