Get Retrieved Traces Graph

xray_get_retrieved_traces_graph

R Documentation

Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search

Description

Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute start_trace_retrieval to obtain the required RetrievalToken.

The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases.

The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph.

When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.

For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see get_trace_graph.

Usage

xray_get_retrieved_traces_graph(RetrievalToken, NextToken)

Arguments

RetrievalToken

[required] Retrieval token.

NextToken

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

Value

A list with the following syntax:

list(
  RetrievalStatus = "SCHEDULED"|"RUNNING"|"COMPLETE"|"FAILED"|"CANCELLED"|"TIMEOUT",
  Services = list(
    list(
      Service = list(
        ReferenceId = 123,
        Name = "string",
        Names = list(
          "string"
        ),
        Root = TRUE|FALSE,
        AccountId = "string",
        Type = "string",
        State = "string",
        StartTime = as.POSIXct(
          "2015-01-01"
        ),
        EndTime = as.POSIXct(
          "2015-01-01"
        ),
        Edges = list(
          list(
            ReferenceId = 123,
            StartTime = as.POSIXct(
              "2015-01-01"
            ),
            EndTime = as.POSIXct(
              "2015-01-01"
            ),
            SummaryStatistics = list(
              OkCount = 123,
              ErrorStatistics = list(
                ThrottleCount = 123,
                OtherCount = 123,
                TotalCount = 123
              ),
              FaultStatistics = list(
                OtherCount = 123,
                TotalCount = 123
              ),
              TotalCount = 123,
              TotalResponseTime = 123.0
            ),
            ResponseTimeHistogram = list(
              list(
                Value = 123.0,
                Count = 123
              )
            ),
            Aliases = list(
              list(
                Name = "string",
                Names = list(
                  "string"
                ),
                Type = "string"
              )
            ),
            EdgeType = "string",
            ReceivedEventAgeHistogram = list(
              list(
                Value = 123.0,
                Count = 123
              )
            )
          )
        ),
        SummaryStatistics = list(
          OkCount = 123,
          ErrorStatistics = list(
            ThrottleCount = 123,
            OtherCount = 123,
            TotalCount = 123
          ),
          FaultStatistics = list(
            OtherCount = 123,
            TotalCount = 123
          ),
          TotalCount = 123,
          TotalResponseTime = 123.0
        ),
        DurationHistogram = list(
          list(
            Value = 123.0,
            Count = 123
          )
        ),
        ResponseTimeHistogram = list(
          list(
            Value = 123.0,
            Count = 123
          )
        )
      ),
      Links = list(
        list(
          ReferenceType = "string",
          SourceTraceId = "string",
          DestinationTraceIds = list(
            "string"
          )
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_retrieved_traces_graph(
  RetrievalToken = "string",
  NextToken = "string"
)