Oracle Cloud Infrastructure Documentation
Try Free Tier

Application Performance Monitoring Traces Functions

Package: DBMS_CLOUD_OCI_ATR_TRACE

GET_AGGREGATED_SNAPSHOT Function

Gets the aggregated snapshot identified by trace ID.

Syntax

FUNCTION get_aggregated_snapshot (
  apm_domain_id varchar2,
  trace_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_atr_trace_get_aggregated_snapshot_response_t;

Parameters

Parameter Description

apm_domain_id

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

trace_key

(required) Unique Application Performance Monitoring trace identifier (traceId).

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.

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.

GET_SPAN Function

Gets the span details identified by spanId.

Syntax

FUNCTION get_span (
  apm_domain_id varchar2,
  span_key varchar2,
  trace_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_atr_trace_get_span_response_t;

Parameters

Parameter Description

apm_domain_id

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

span_key

(required) Unique Application Performance Monitoring span identifier (spanId).

trace_key

(required) Unique Application Performance Monitoring trace identifier (traceId).

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.

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.

GET_TRACE Function

Gets the trace details identified by traceId.

Syntax

FUNCTION get_trace (
  apm_domain_id varchar2,
  trace_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_atr_trace_get_trace_response_t;

Parameters

Parameter Description

apm_domain_id

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

trace_key

(required) Unique Application Performance Monitoring trace identifier (traceId).

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.

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.

GET_TRACE_SNAPSHOT Function

Gets the trace snapshots data identified by trace ID.

Syntax

FUNCTION get_trace_snapshot (
  apm_domain_id varchar2,
  trace_key varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  is_summarized number DEFAULT NULL,
  thread_id varchar2 DEFAULT NULL,
  snapshot_time varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_atr_trace_get_trace_snapshot_response_t;

Parameters

Parameter Description

apm_domain_id

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

trace_key

(required) Unique Application Performance Monitoring trace identifier (traceId).

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.

is_summarized

(optional) If enabled, then only span level details will be sent.

thread_id

(optional) Thread id for which snapshots needs to be retrieved. This is an identifier of a thread, and is a positive long number generated when when a thread is created.

snapshot_time

(optional) Epoch time of snapshot.

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?