AttributesClient¶

class oci.apm_traces.AttributesClient(config, **kwargs)¶

Use the Application Performance Monitoring Trace Explorer API to query traces and associated spans in Trace Explorer. 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
`bulk_activate_attribute`(apm_domain_id, …)	Activates a set of attributes for the given APM Domain.
`bulk_de_activate_attribute`(apm_domain_id, …)	Deactivates a set of attributes for the given APM Domain.
`bulk_pin_attribute`(apm_domain_id, …)	Pin a set of attributes in the APM Domain.
`bulk_unpin_attribute`(apm_domain_id, …)	Unpin a set of attributes in the APM Domain.
`bulk_update_attribute`(apm_domain_id, …)	Update a set of attribute properties in the APM Domain.
`bulk_update_attribute_notes`(apm_domain_id, …)	Add or edit notes to a set of attributes in the APM Domain.
`get_status_auto_activate`(apm_domain_id, …)	Get autoactivation status for a private data key or public data key in the APM Domain.
`put_toggle_auto_activate`(apm_domain_id, …)	Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.

__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.

bulk_activate_attribute(apm_domain_id, bulk_activate_attribute_details, **kwargs)¶

Activates a set of attributes for the given APM Domain. The API is not case-sensitive. Any duplicates present in the bulk activation request are deduplicated and only unique attributes are activated. A maximum number of 700 string attributes and 100 numeric attributes can be activated in an APM Domain subject to the available string and numeric slots. Once an attribute has been activated, it may take sometime for it to be appear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk activation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are activated. Attributes that are activated are unpinned by default if they are pinned.

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. bulk_activate_attribute_details (oci.apm_traces.models.BulkActivateAttributeDetails) – (required) Request body containing the details about the set of attributes to be activated. opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `BulkActivationStatus`
Return type:	`Response`
Example:

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

bulk_de_activate_attribute(apm_domain_id, bulk_de_activate_attribute_details, **kwargs)¶

Deactivates a set of attributes for the given APM Domain. The API is case in-sensitive. Any duplicates present in the bulk deactivation request are deduplicated and only unique attributes are deactivated. A maximum number of 700 string attributes and 100 numeric attributes can be deactivated in an APM Domain subject to the available string and numeric slots. Out of box attributes (Trace and Span) cannot be deactivated, and will result in a processing error. Once an attribute has been deactivated, it may take sometime for it to disappear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed. The bulk deactivation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success status back. If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request are deactivated.

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. bulk_de_activate_attribute_details (oci.apm_traces.models.BulkDeActivateAttributeDetails) – (required) Request body containing the details about the set of attributes to be deactivated. opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `BulkDeActivationStatus`
Return type:	`Response`
Example:

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

bulk_pin_attribute(apm_domain_id, bulk_pin_attribute_details, **kwargs)¶

Pin a set of attributes in the APM Domain. Attributes that are marked pinned are not autoactivated by ingest. Attributes that are deactivated are pinned by default.

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. bulk_pin_attribute_details (oci.apm_traces.models.BulkPinAttributeDetails) – (required) Request body containing the details about the set of attributes to be pinned. opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `BulkPinStatus`
Return type:	`Response`
Example:

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

bulk_unpin_attribute(apm_domain_id, bulk_unpin_attribute_details, **kwargs)¶

Unpin a set of attributes in the APM Domain.

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. bulk_unpin_attribute_details (oci.apm_traces.models.BulkUnpinAttributeDetails) – (required) Request body containing the details about the set of attributes to be unpinned. opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `BulkUnpinStatus`
Return type:	`Response`
Example:

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

bulk_update_attribute(apm_domain_id, bulk_update_attribute_details, **kwargs)¶

Update a set of attribute properties in the APM Domain.

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. bulk_update_attribute_details (oci.apm_traces.models.BulkUpdateAttributeDetails) – (required) Request body containing the details about the set of attributes for which properties are to be updated. opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `BulkUpdateAttributeStatus`
Return type:	`Response`
Example:

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

bulk_update_attribute_notes(apm_domain_id, bulk_update_attribute_notes_details, **kwargs)¶

Add or edit notes to a set of attributes in the APM Domain. Notes can be added to either an active or an inactive attribute. The notes will be preserved even if the attribute changes state (when an active attribute is deactivated or when an inactive attribute is activated).

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. bulk_update_attribute_notes_details (oci.apm_traces.models.BulkUpdateAttributeNotesDetails) – (required) Request body containing the details about the set of attributes for which notes are to be updated. opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `BulkUpdateNotesStatus`
Return type:	`Response`
Example:

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

get_status_auto_activate(apm_domain_id, data_key_type, **kwargs)¶

Get autoactivation status for a private data key or public data key in the APM Domain.

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. data_key_type (str) – (required) Data key type for which auto-activate needs to be turned on or off. Allowed values are: “PRIVATE_DATA_KEY”, “PUBLIC_DATA_KEY” opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `AutoActivateStatus`
Return type:	`Response`
Example:

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

put_toggle_auto_activate(apm_domain_id, is_auto_activate_on, data_key_type, **kwargs)¶

Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.

Parameters:	apm_domain_id (str) – (required) The APM Domain ID for the intended request. is_auto_activate_on (bool) – (required) Autoactivate toggle switch. Set to true to turn on auto-activate. Set to false to turn off auto-activate. data_key_type (str) – (required) Data key type for which auto-activate needs to be turned on or off. Allowed values are: “PRIVATE_DATA_KEY”, “PUBLIC_DATA_KEY” opc_request_id (str) – (optional) Unique Oracle-assigned 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 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 `AutoActivateToggleStatus`
Return type:	`Response`
Example:

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