Oracle Cloud Infrastructure Documentation
Try Free Tier

Application Performance Monitoring Traces Query Functions

Package: DBMS_CLOUD_OCI_ATR_QUERY

LIST_QUICK_PICKS Function

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.

Syntax

FUNCTION list_quick_picks (
  apm_domain_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_atr_query_list_quick_picks_response_t;

Parameters

Parameter Description

apm_domain_id

(required) The APM Domain ID the request is intended for.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous response.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://apm-trace.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

QUERY Function

Retrieves the results (selected attributes and aggregations) of a query constructed according to the Application Performance Monitoring Defined Query Syntax. 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.

Syntax

FUNCTION query (
  apm_domain_id varchar2,
  time_span_started_greater_than_or_equal_to timestamp with time zone,
  time_span_started_less_than timestamp with time zone,
  query_details dbms_cloud_oci_apm_traces_query_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_atr_query_query_response_t;

Parameters

Parameter Description

apm_domain_id

(required) The APM Domain ID the request is intended for.

time_span_started_greater_than_or_equal_to

(required) Include spans that have a `spanStartTime` equal to or greater than this value.

time_span_started_less_than

(required) Include spans that have a `spanStartTime`less than this value.

query_details

(required) Request body containing the query to be run against the trace data and to filter and retrieve trace data results.

opc_request_id

(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous response.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://apm-trace.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

Was this article helpful?