QueryClient

class oci.apm_traces.QueryClient(config, **kwargs)

API for APM Trace service. Use this API to query the Traces and associated Spans.

Methods

__init__(config, **kwargs) Creates a new service client
list_quick_picks(apm_domain_id, **kwargs) Returns a list of predefined quick pick queries intended to assist the user to choose a query to run.
query(apm_domain_id, …) Given a query, constructed according to the APM Defined Query Syntax, retrieves the results - selected attributes, and aggregations of the queried entity.
query_old(apm_domain_id, …) THIS API ENDPOINT WILL BE DEPRECATED AND INSTEAD /queries/actions/runQuery as defined below WILL BE USED GOING FORWARD.
__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.

list_quick_picks(apm_domain_id, **kwargs)

Returns a list of predefined quick pick queries intended to assist the user to choose a query to run. There is no sorting applied on the results.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain Id the request is intended for.
  • 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.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous response.
  • 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 QuickPickSummary

Return type:

Response

Example:

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

query(apm_domain_id, time_span_started_greater_than_or_equal_to, time_span_started_less_than, query_details, **kwargs)

Given a query, constructed according to the APM Defined Query Syntax, retrieves the results - selected attributes, and aggregations of the queried entity. Query Results are filtered by the filter criteria specified in the where clause. Further query results are grouped by the attributes specified in the group by clause. Finally, ordering (asc/desc) is done by the specified attributes in the order by clause.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain Id the request is intended for.
  • time_span_started_greater_than_or_equal_to (datetime) – (required) Include spans that have a spanStartTime equal to or greater this value.
  • time_span_started_less_than (datetime) – (required) Include spans that have a `spanStartTime`less than this value.
  • query_details (oci.apm_traces.models.QueryDetails) – (required) Request body containing the query to be run against our repository.
  • 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.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous response.
  • 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 QueryResultResponse

Return type:

Response

Example:

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

query_old(apm_domain_id, time_span_started_greater_than_or_equal_to, time_span_started_less_than, query_details, **kwargs)

THIS API ENDPOINT WILL BE DEPRECATED AND INSTEAD /queries/actions/runQuery as defined below WILL BE USED GOING FORWARD. THIS EXISTS JUST AS A TEMPORARY PLACEHOLDER SO AS TO BE BACKWARDS COMPATIBLE WITH THE UI BETWEEN RELEASE CYCLES. Given a query, constructed according to the APM Defined Query Syntax, retrieves the results - selected attributes, and aggregations of the queried entity. Query Results are filtered by the filter criteria specified in the where clause. Further query results are grouped by the attributes specified in the group by clause. Finally, ordering (asc/desc) is done by the specified attributes in the order by clause.

Parameters:
  • apm_domain_id (str) – (required) The APM Domain Id the request is intended for.
  • time_span_started_greater_than_or_equal_to (datetime) – (required) Include spans that have a spanStartTime equal to or greater this value.
  • time_span_started_less_than (datetime) – (required) Include spans that have a `spanStartTime`less than this value.
  • query_details (oci.apm_traces.models.QueryDetails) – (required) Request body containing the query to be run against our repository.
  • 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.
  • limit (int) – (optional) The maximum number of items to return.
  • page (str) – (optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous response.
  • 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 QueryResultResponse

Return type:

Response

Example:

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