Oracle Cloud Infrastructure Documentation
Try Free Tier

Application Performance Monitoring Traces Common Types

DBMS_CLOUD_OCI_APM_TRACES_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_SNAPSHOT_DETAIL_T Type

A generic key value pair object, which contains information such as the thread ID, thread name, and thread state.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_snapshot_detail_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  value json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_snapshot_detail_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_snapshot_detail_t (
    key varchar2,
    value json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(optional) Name of the property.

value

(optional) Value of the property.

DBMS_CLOUD_OCI_APM_TRACES_STACK_TRACE_ELEMENT_T Type

Stack trace element.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_stack_trace_element_t FORCE AUTHID CURRENT_USER IS OBJECT (
  method_name varchar2(32767),
  file_name varchar2(32767),
  line_number number,
  class_name varchar2(32767),
  weightage number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_stack_trace_element_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_stack_trace_element_t (
    method_name varchar2,
    file_name varchar2,
    line_number number,
    class_name varchar2,
    weightage number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

method_name

(optional) Name of the method containing the execution point.

file_name

(optional) Name of the source file containing the execution point.

line_number

(optional) Line number of the source line containing the execution point.

class_name

(optional) Name of the class containing the execution point.

weightage

(optional) The weight distribution that denotes the percentage occurrence of a method in the captured snapshots.

DBMS_CLOUD_OCI_APM_TRACES_AGGREGATED_STACK_TRACE_ABS_T

A branching tree with aggregated stack trace.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_t FORCE AUTHID CURRENT_USER IS OBJECT (
  stack_trace_element dbms_cloud_oci_apm_traces_stack_trace_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_t (
    stack_trace_element dbms_cloud_oci_apm_traces_stack_trace_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

stack_trace_element

(optional)

DBMS_CLOUD_OCI_APM_TRACES_AGGREGATED_STACK_TRACE_ABS_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_AGGREGATED_STACK_TRACE_T Type

A branching tree with aggregated stack trace.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_aggregated_stack_trace_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_t (
  children dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_aggregated_stack_trace_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_aggregated_stack_trace_t (
    stack_trace_element dbms_cloud_oci_apm_traces_stack_trace_element_t,
    children dbms_cloud_oci_apm_traces_aggregated_stack_trace_abs_tbl
  ) RETURN SELF AS RESULT
);

Fields

Field Description

children

(optional) List of child aggregated stack trace to represent branches.

DBMS_CLOUD_OCI_APM_TRACES_AGGREGATED_STACK_TRACE_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_aggregated_stack_trace_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_aggregated_stack_trace_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_aggregated_stack_trace_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_SNAPSHOT_DETAIL_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_snapshot_detail_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_snapshot_detail_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_snapshot_detail_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_AGGREGATED_SNAPSHOT_T Type

Aggregated snapshots of all spans.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_aggregated_snapshot_t FORCE AUTHID CURRENT_USER IS OBJECT (
  details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
  aggregated_stack_traces dbms_cloud_oci_apm_traces_aggregated_stack_trace_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_aggregated_snapshot_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_aggregated_snapshot_t (
    details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
    aggregated_stack_traces dbms_cloud_oci_apm_traces_aggregated_stack_trace_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

details

(required) Aggregated snapshot details.

aggregated_stack_traces

(required) List of aggregated stack trace.

DBMS_CLOUD_OCI_APM_TRACES_ERROR_T Type

Details of an error that occurred.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_DETAILS_T Type

Request object containing the query to be run against the trace data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  query_text varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_details_t (
    query_text varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

query_text

(optional) Application Performance Monitoring defined query string that filters and retrieves trace data results.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_ROW_TYPE_SUMMARY_ABS_T

Summary of the datatype, unit and related metadata of an individual row element of a query result row that is returned.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_t FORCE AUTHID CURRENT_USER IS OBJECT (
  data_type varchar2(32767),
  unit varchar2(32767),
  display_name varchar2(32767),
  expression varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_t (
    data_type varchar2,
    unit varchar2,
    display_name varchar2,
    expression varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

data_type

(optional) Datatype of the query result row element.

unit

(optional) Granular unit in which the query result row element's data is represented.

display_name

(optional) Alias name if an alias is used for the query result row element or an assigned display name from the query language in some default cases.

expression

(optional) Actual show expression in the user typed query that produced this column.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_ROW_TYPE_SUMMARY_ABS_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_ROW_TYPE_SUMMARY_T Type

Summary of the datatype, unit and related metadata of an individual row element of a query result row that is returned.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_row_type_summary_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_t (
  query_result_row_type_summaries dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_row_type_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_row_type_summary_t (
    data_type varchar2,
    unit varchar2,
    display_name varchar2,
    expression varchar2,
    query_result_row_type_summaries dbms_cloud_oci_apm_traces_query_result_row_type_summary_abs_tbl
  ) RETURN SELF AS RESULT
);

Fields

Field Description

query_result_row_type_summaries

(optional) A query result row type summary object that represents a nested table structure.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_ROW_TYPE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_query_result_row_type_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_row_type_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_query_result_row_type_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULTS_GROUPED_BY_SUMMARY_T Type

Summary of the attribute based on which the query results are grouped.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  query_results_grouped_by_column varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_t (
    query_results_grouped_by_column varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

query_results_grouped_by_column

(optional) Column or attribute in the query result, which is a group by value.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULTS_ORDERED_BY_SUMMARY_T Type

Summary of the sort and order by attribute based on which the query results are organized.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  query_results_ordered_by varchar2(32767),
  query_results_sort_order varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_t (
    query_results_ordered_by varchar2,
    query_results_sort_order varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

query_results_ordered_by

(optional) Attribute by which the query results are sorted.

query_results_sort_order

(optional) The sort order for the attribute, either 'ASC' or 'DESC'.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULTS_GROUPED_BY_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULTS_ORDERED_BY_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_METADATA_SUMMARY_T Type

Summary containing the metadata about the query result set.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_metadata_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  query_result_row_type_summaries dbms_cloud_oci_apm_traces_query_result_row_type_summary_tbl,
  source_name varchar2(32767),
  query_results_grouped_by dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_tbl,
  query_results_ordered_by dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_tbl,
  time_series_interval_in_mins number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_metadata_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_metadata_summary_t (
    query_result_row_type_summaries dbms_cloud_oci_apm_traces_query_result_row_type_summary_tbl,
    source_name varchar2,
    query_results_grouped_by dbms_cloud_oci_apm_traces_query_results_grouped_by_summary_tbl,
    query_results_ordered_by dbms_cloud_oci_apm_traces_query_results_ordered_by_summary_tbl,
    time_series_interval_in_mins number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

query_result_row_type_summaries

(optional) A collection of QueryResultRowTypeSummary objects that describe the type and properties of the individual row elements of the query rows being returned. The i-th element in this list contains the QueryResultRowTypeSummary of the i-th key-value pair in the QueryResultRowData map.

source_name

(optional) Source of the query result set (traces, spans, and so on).

query_results_grouped_by

(optional) Columns or attributes of the query rows which are group by values. This is a list of ResultsGroupedBy summary objects, and the list will contain as many elements as the attributes and aggregate functions in the group by clause in the select query.

query_results_ordered_by

(optional) Order by which the query results are organized. This is a list of queryResultsOrderedBy summary objects, and the list will contain more than one OrderedBy summary object, if the sort was multidimensional.

time_series_interval_in_mins

(optional) Interval for the time series function in minutes.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_ROW_T Type

Object that represents a single row of the query result. It contains the queryResultRowData object that contains the actual data represented by the elements of the query result row, and a queryResultRowMetadata object that contains the metadata about the data contained in the query result row.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_row_t FORCE AUTHID CURRENT_USER IS OBJECT (
  query_result_row_data json_element_t,
  query_result_row_metadata json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_row_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_row_t (
    query_result_row_data json_element_t,
    query_result_row_metadata json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

query_result_row_data

(required) A map containing the actual data represented by a single row of the query result. The key is the column name or attribute specified in the show clause, or an aggregate function in the show clause. The value is the actual value of that attribute or aggregate function of the corresponding single row of the query result set. If an alias name is specified for an attribute or an aggregate function, then the key will be the alias name specified in the show clause. If an alias name is not specified for the group by aggregate function in the show clause, then the corresponding key will be the appropriate aggregate_function_name_column_name (For example: count(traces) will be keyed as count_traces). The datatype of the value is presented in the queryResultRowTypeSummaries list in the queryResultMetadata structure, where the i-th queryResultRowTypeSummary object represents the datatype of the i-th value when this map is iterated in order.

query_result_row_metadata

(required) A map containing metadata or add-on data for the data presented in the queryResultRowData map. Data required to present drill down information from the queryResultRowData is presented as key-value pairs.

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_ROW_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_query_result_row_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_row_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_query_result_row_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_QUERY_RESULT_RESPONSE_T Type

A response containing a collection of query rows (selected attributes and aggregations) filtered, grouped and sorted by the specified criteria from the query that is run, and the associated summary describing the corresponding query result metadata.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_query_result_response_t FORCE AUTHID CURRENT_USER IS OBJECT (
  query_result_metadata_summary dbms_cloud_oci_apm_traces_query_result_metadata_summary_t,
  query_result_rows dbms_cloud_oci_apm_traces_query_result_row_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_response_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_query_result_response_t (
    query_result_metadata_summary dbms_cloud_oci_apm_traces_query_result_metadata_summary_t,
    query_result_rows dbms_cloud_oci_apm_traces_query_result_row_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

query_result_metadata_summary

(required)

query_result_rows

(required) A collection of objects with each object representing an individual row of the query result set. The total number of objects returned in this collection correspond to the total number of rows returned by the actual query that is run against the queried entity.

DBMS_CLOUD_OCI_APM_TRACES_QUICK_PICK_SUMMARY_T Type

Summary of the Quick Pick query objects.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_quick_pick_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  quick_pick_name varchar2(32767),
  quick_pick_query varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_quick_pick_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_quick_pick_summary_t (
    quick_pick_name varchar2,
    quick_pick_query varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

quick_pick_name

(required) Quick Pick name for the query.

quick_pick_query

(required) Query for the Quick Pick.

DBMS_CLOUD_OCI_APM_TRACES_TAG_T Type

Definition of a tag which is a key-value pair.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_tag_t FORCE AUTHID CURRENT_USER IS OBJECT (
  tag_name varchar2(32767),
  tag_value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_tag_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_tag_t (
    tag_name varchar2,
    tag_value varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

tag_name

(required) Key that specifies the tag name.

tag_value

(required) Value associated with the tag key.

DBMS_CLOUD_OCI_APM_TRACES_SPAN_LOG_T Type

Definition of a log which is a key-value pair of log data.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_log_t FORCE AUTHID CURRENT_USER IS OBJECT (
  log_key varchar2(32767),
  log_value varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_log_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_log_t (
    log_key varchar2,
    log_value varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

log_key

(required) Key that specifies the log name.

log_value

(required) Value associated with the log key.

DBMS_CLOUD_OCI_APM_TRACES_SPAN_LOG_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_span_log_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_log_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_span_log_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_SPAN_LOG_COLLECTION_T Type

Definition of span log collection object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_log_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_created timestamp with time zone,
  span_logs dbms_cloud_oci_apm_traces_span_log_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_log_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_log_collection_t (
    time_created timestamp with time zone,
    span_logs dbms_cloud_oci_apm_traces_span_log_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_created

(optional) Timestamp at which the log is created.

span_logs

(optional) List of logs associated with the span at the given timestamp.

DBMS_CLOUD_OCI_APM_TRACES_TAG_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_tag_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_tag_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_tag_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_SPAN_LOG_COLLECTION_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_span_log_collection_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_log_collection_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_span_log_collection_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_SPAN_T Type

Definition of a span object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  parent_span_key varchar2(32767),
  trace_key varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  duration_in_ms number,
  operation_name varchar2(32767),
  service_name varchar2(32767),
  kind varchar2(32767),
  tags dbms_cloud_oci_apm_traces_tag_tbl,
  logs dbms_cloud_oci_apm_traces_span_log_collection_tbl,
  is_error number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_t (
    key varchar2,
    parent_span_key varchar2,
    trace_key varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    duration_in_ms number,
    operation_name varchar2,
    service_name varchar2,
    kind varchar2,
    tags dbms_cloud_oci_apm_traces_tag_tbl,
    logs dbms_cloud_oci_apm_traces_span_log_collection_tbl,
    is_error number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(required) Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.

parent_span_key

(optional) Unique parent identifier for the span if one exists. For root spans this will be null.

trace_key

(required) Unique identifier for the trace.

time_started

(required) Span start time. Timestamp when the span was started.

time_ended

(required) Span end time. Timestamp when the span was completed.

duration_in_ms

(required) Total span duration in milliseconds.

operation_name

(required) Span name associated with the trace. This is usually the method or URI of the request.

service_name

(optional) Service name associated with the span.

kind

(optional) Kind associated with the span.

tags

(optional) List of tags associated with the span.

logs

(optional) List of logs associated with the span.

is_error

(required) Indicates if the span has an error.

DBMS_CLOUD_OCI_APM_TRACES_STACK_TRACE_ELEMENT_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_stack_trace_element_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_stack_trace_element_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_stack_trace_element_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_THREAD_SNAPSHOT_T Type

Thread snapshot.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_thread_snapshot_t FORCE AUTHID CURRENT_USER IS OBJECT (
  time_stamp timestamp with time zone,
  thread_snapshot_details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
  stack_trace dbms_cloud_oci_apm_traces_stack_trace_element_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_thread_snapshot_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_thread_snapshot_t (
    time_stamp timestamp with time zone,
    thread_snapshot_details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
    stack_trace dbms_cloud_oci_apm_traces_stack_trace_element_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

time_stamp

(optional) Snapshot time.

thread_snapshot_details

(optional) Snapshot details.

stack_trace

(optional) Stack trace.

DBMS_CLOUD_OCI_APM_TRACES_THREAD_SNAPSHOT_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_thread_snapshot_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_thread_snapshot_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_thread_snapshot_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_SPAN_SNAPSHOT_ABS_T

Definition of a span snapshot object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_snapshot_abs_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  span_name varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  span_snapshot_details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
  thread_snapshots dbms_cloud_oci_apm_traces_thread_snapshot_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_snapshot_abs_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_snapshot_abs_t (
    key varchar2,
    span_name varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    span_snapshot_details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
    thread_snapshots dbms_cloud_oci_apm_traces_thread_snapshot_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

key

(required) Unique identifier (spanId) for the trace span.

span_name

(optional) Span name associated with the trace.

time_started

(required) Start time of the span.

time_ended

(required) End time of the span.

span_snapshot_details

(optional) Span snapshots properties.

thread_snapshots

(optional) Thread snapshots.

DBMS_CLOUD_OCI_APM_TRACES_SPAN_SNAPSHOT_ABS_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_span_snapshot_abs_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_snapshot_abs_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_span_snapshot_abs_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_SPAN_SNAPSHOT_T Type

Definition of a span snapshot object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_snapshot_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_apm_traces_span_snapshot_abs_t (
  children dbms_cloud_oci_apm_traces_span_snapshot_abs_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_snapshot_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_span_snapshot_t (
    key varchar2,
    span_name varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    span_snapshot_details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
    thread_snapshots dbms_cloud_oci_apm_traces_thread_snapshot_tbl,
    children dbms_cloud_oci_apm_traces_span_snapshot_abs_tbl
  ) RETURN SELF AS RESULT
);

Fields

Field Description

children

(optional) An array of child span snapshots.

DBMS_CLOUD_OCI_APM_TRACES_SPAN_SNAPSHOT_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_span_snapshot_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_snapshot_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_span_snapshot_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_TRACE_SERVICE_SUMMARY_T Type

Summary of the spans in a trace by service.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_trace_service_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  span_service_name varchar2(32767),
  total_spans number,
  error_spans number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_service_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_service_summary_t (
    span_service_name varchar2,
    total_spans number,
    error_spans number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

span_service_name

(required) Name associated with the service.

total_spans

(required) Number of spans for serviceName in the trace.

error_spans

(required) Number of spans with errors for serviceName in the trace.

DBMS_CLOUD_OCI_APM_TRACES_TRACE_SERVICE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_trace_service_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_trace_service_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_trace_service_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_TRACE_SPAN_SUMMARY_T Type

Summary of the information pertaining to the spans in the trace window that is being queried.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_trace_span_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  root_span_operation_name varchar2(32767),
  time_earliest_span_started timestamp with time zone,
  time_latest_span_ended timestamp with time zone,
  span_count number,
  error_span_count number,
  root_span_service_name varchar2(32767),
  time_root_span_started timestamp with time zone,
  time_root_span_ended timestamp with time zone,
  root_span_duration_in_ms number,
  trace_duration_in_ms number,
  is_fault number,
  trace_status varchar2(32767),
  trace_error_type varchar2(32767),
  trace_error_code varchar2(32767),
  service_summaries dbms_cloud_oci_apm_traces_trace_service_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_span_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_span_summary_t (
    key varchar2,
    root_span_operation_name varchar2,
    time_earliest_span_started timestamp with time zone,
    time_latest_span_ended timestamp with time zone,
    span_count number,
    error_span_count number,
    root_span_service_name varchar2,
    time_root_span_started timestamp with time zone,
    time_root_span_ended timestamp with time zone,
    root_span_duration_in_ms number,
    trace_duration_in_ms number,
    is_fault number,
    trace_status varchar2,
    trace_error_type varchar2,
    trace_error_code varchar2,
    service_summaries dbms_cloud_oci_apm_traces_trace_service_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(required) Unique identifier (traceId) for the trace that represents the span set. Note that this field is defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance Monitoring.

root_span_operation_name

(optional) Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.

time_earliest_span_started

(required) Start time of the earliest span in the span collection.

time_latest_span_ended

(required) End time of the span that most recently ended in the span collection.

span_count

(required) The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.

error_span_count

(required) The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.

root_span_service_name

(optional) Service associated with the trace.

time_root_span_started

(optional) Start time of the root span for the span collection.

time_root_span_ended

(optional) End time of the root span for the span collection.

root_span_duration_in_ms

(optional) Time taken for the root span operation to complete in milliseconds.

trace_duration_in_ms

(required) Time between the start of the earliest span and the end of the most recent span in milliseconds.

is_fault

(required) Boolean flag that indicates whether the trace has an error.

trace_status

(required) The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

trace_error_type

(required) Error type of the trace.

trace_error_code

(required) Error code of the trace.

service_summaries

(optional) A summary of the spans by service.

DBMS_CLOUD_OCI_APM_TRACES_SPAN_TBL Type

Nested table type of dbms_cloud_oci_apm_traces_span_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_span_tbl FORCE IS TABLE OF (dbms_cloud_oci_apm_traces_span_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_APM_TRACES_TRACE_T Type

Definition of a trace object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_trace_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  root_span_operation_name varchar2(32767),
  time_earliest_span_started timestamp with time zone,
  time_latest_span_ended timestamp with time zone,
  span_count number,
  error_span_count number,
  root_span_service_name varchar2(32767),
  time_root_span_started timestamp with time zone,
  time_root_span_ended timestamp with time zone,
  root_span_duration_in_ms number,
  trace_duration_in_ms number,
  is_fault number,
  trace_status varchar2(32767),
  trace_error_type varchar2(32767),
  trace_error_code varchar2(32767),
  service_summaries dbms_cloud_oci_apm_traces_trace_service_summary_tbl,
  span_summary dbms_cloud_oci_apm_traces_trace_span_summary_t,
  spans dbms_cloud_oci_apm_traces_span_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_t (
    key varchar2,
    root_span_operation_name varchar2,
    time_earliest_span_started timestamp with time zone,
    time_latest_span_ended timestamp with time zone,
    span_count number,
    error_span_count number,
    root_span_service_name varchar2,
    time_root_span_started timestamp with time zone,
    time_root_span_ended timestamp with time zone,
    root_span_duration_in_ms number,
    trace_duration_in_ms number,
    is_fault number,
    trace_status varchar2,
    trace_error_type varchar2,
    trace_error_code varchar2,
    service_summaries dbms_cloud_oci_apm_traces_trace_service_summary_tbl,
    span_summary dbms_cloud_oci_apm_traces_trace_span_summary_t,
    spans dbms_cloud_oci_apm_traces_span_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(required) Unique identifier (traceId) for the trace that represents the span set. Note that this field is defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance Monitoring.

root_span_operation_name

(optional) Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.

time_earliest_span_started

(optional) Start time of the earliest span in the span collection.

time_latest_span_ended

(optional) End time of the span that most recently ended in the span collection.

span_count

(optional) The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.

error_span_count

(optional) The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.

root_span_service_name

(optional) Service associated with the trace.

time_root_span_started

(optional) Start time of the root span for the span collection.

time_root_span_ended

(optional) End time of the root span for the span collection.

root_span_duration_in_ms

(optional) Time taken for the root span operation to complete in milliseconds.

trace_duration_in_ms

(optional) Time between the start of the earliest span and the end of the most recent span in milliseconds.

is_fault

(optional) Boolean flag that indicates whether the trace has an error.

trace_status

(optional) The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.

trace_error_type

(optional) Error type of the trace.

trace_error_code

(optional) Error code of the trace.

service_summaries

(optional) A summary of the spans by service.

span_summary

(optional)

spans

(required) An array of spans in the trace.

DBMS_CLOUD_OCI_APM_TRACES_TRACE_SNAPSHOT_T Type

Definition of a trace snapshot object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_apm_traces_trace_snapshot_t FORCE AUTHID CURRENT_USER IS OBJECT (
  key varchar2(32767),
  time_started timestamp with time zone,
  time_ended timestamp with time zone,
  trace_snapshot_details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
  span_snapshots dbms_cloud_oci_apm_traces_span_snapshot_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_snapshot_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_apm_traces_trace_snapshot_t (
    key varchar2,
    time_started timestamp with time zone,
    time_ended timestamp with time zone,
    trace_snapshot_details dbms_cloud_oci_apm_traces_snapshot_detail_tbl,
    span_snapshots dbms_cloud_oci_apm_traces_span_snapshot_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

key

(required) Unique identifier (traceId) for the trace that represents the span set. Note that this field is defined as traceKey in the API and it maps to the traceId in the trace data in Application Performance Monitoring.

time_started

(optional) Start time of the trace.

time_ended

(optional) End time of the trace.

trace_snapshot_details

(optional) Trace snapshots properties.

span_snapshots

(required) List of spans.

Was this article helpful?