LISTRETRIEVEDTRACES()`¶

About ListRetrievedTraces¶

Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces.

This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken.

When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see BatchGetTraces.

Method Signature¶

METHODS /AWS1/IF_XRA~LISTRETRIEVEDTRACES
  IMPORTING
    !IV_RETRIEVALTOKEN TYPE /AWS1/XRARETRIEVALTOKEN OPTIONAL
    !IV_TRACEFORMAT TYPE /AWS1/XRATRACEFORMATTYPE OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/XRASTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_xralstretrievedtrac01
  RAISING
    /AWS1/CX_XRAINVALIDREQUESTEX
    /AWS1/CX_XRARESOURCENOTFOUNDEX
    /AWS1/CX_XRATHROTTLEDEXCEPTION
    /AWS1/CX_XRACLIENTEXC
    /AWS1/CX_XRASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_retrievaltoken` `TYPE /AWS1/XRARETRIEVALTOKEN` `/AWS1/XRARETRIEVALTOKEN`¶

Retrieval token.

Optional arguments:¶

`iv_traceformat` `TYPE /AWS1/XRATRACEFORMATTYPE` `/AWS1/XRATRACEFORMATTYPE`¶

Format of the requested traces.

`iv_nexttoken` `TYPE /AWS1/XRASTRING` `/AWS1/XRASTRING`¶

Specify the pagination token returned by a previous request to retrieve the next page of indexes.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_xralstretrievedtrac01` `/AWS1/CL_XRALSTRETRIEVEDTRAC01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listretrievedtraces(
  iv_nexttoken = |string|
  iv_retrievaltoken = |string|
  iv_traceformat = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_retrievalstatus = lo_result->get_retrievalstatus( ).
  lv_traceformattype = lo_result->get_traceformat( ).
  LOOP AT lo_result->get_traces( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_traceid = lo_row_1->get_id( ).
      lv_nullabledouble = lo_row_1->get_duration( ).
      LOOP AT lo_row_1->get_spans( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_spanid = lo_row_3->get_id( ).
          lv_spandocument = lo_row_3->get_document( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_XRA=>LISTRETRIEVEDTRACES()¶