Get Trace Summaries

xray_get_trace_summaries

R Documentation

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter

Description

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to batch_get_traces.

A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

service("api.example.com")

This filter expression finds traces that have an annotation named account with the value 12345:

annotation.account = "12345"

For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.

Usage

xray_get_trace_summaries(StartTime, EndTime, TimeRangeType, Sampling,
  SamplingStrategy, FilterExpression, NextToken)

Arguments

StartTime

[required] The start of the time frame for which to retrieve traces.

EndTime

[required] The end of the time frame for which to retrieve traces.

TimeRangeType

A parameter to indicate whether to query trace summaries by TraceId, Event (trace update time), or Service (segment end time).

Sampling

Set to true to get summaries for only a subset of available traces.

SamplingStrategy

A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

FilterExpression

Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

NextToken

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

Value

A list with the following syntax:

list(
  TraceSummaries = list(
    list(
      Id = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      Duration = 123.0,
      ResponseTime = 123.0,
      HasFault = TRUE|FALSE,
      HasError = TRUE|FALSE,
      HasThrottle = TRUE|FALSE,
      IsPartial = TRUE|FALSE,
      Http = list(
        HttpURL = "string",
        HttpStatus = 123,
        HttpMethod = "string",
        UserAgent = "string",
        ClientIp = "string"
      ),
      Annotations = list(
        list(
          list(
            AnnotationValue = list(
              NumberValue = 123.0,
              BooleanValue = TRUE|FALSE,
              StringValue = "string"
            ),
            ServiceIds = list(
              list(
                Name = "string",
                Names = list(
                  "string"
                ),
                AccountId = "string",
                Type = "string"
              )
            )
          )
        )
      ),
      Users = list(
        list(
          UserName = "string",
          ServiceIds = list(
            list(
              Name = "string",
              Names = list(
                "string"
              ),
              AccountId = "string",
              Type = "string"
            )
          )
        )
      ),
      ServiceIds = list(
        list(
          Name = "string",
          Names = list(
            "string"
          ),
          AccountId = "string",
          Type = "string"
        )
      ),
      ResourceARNs = list(
        list(
          ARN = "string"
        )
      ),
      InstanceIds = list(
        list(
          Id = "string"
        )
      ),
      AvailabilityZones = list(
        list(
          Name = "string"
        )
      ),
      EntryPoint = list(
        Name = "string",
        Names = list(
          "string"
        ),
        AccountId = "string",
        Type = "string"
      ),
      FaultRootCauses = list(
        list(
          Services = list(
            list(
              Name = "string",
              Names = list(
                "string"
              ),
              Type = "string",
              AccountId = "string",
              EntityPath = list(
                list(
                  Name = "string",
                  Exceptions = list(
                    list(
                      Name = "string",
                      Message = "string"
                    )
                  ),
                  Remote = TRUE|FALSE
                )
              ),
              Inferred = TRUE|FALSE
            )
          ),
          ClientImpacting = TRUE|FALSE
        )
      ),
      ErrorRootCauses = list(
        list(
          Services = list(
            list(
              Name = "string",
              Names = list(
                "string"
              ),
              Type = "string",
              AccountId = "string",
              EntityPath = list(
                list(
                  Name = "string",
                  Exceptions = list(
                    list(
                      Name = "string",
                      Message = "string"
                    )
                  ),
                  Remote = TRUE|FALSE
                )
              ),
              Inferred = TRUE|FALSE
            )
          ),
          ClientImpacting = TRUE|FALSE
        )
      ),
      ResponseTimeRootCauses = list(
        list(
          Services = list(
            list(
              Name = "string",
              Names = list(
                "string"
              ),
              Type = "string",
              AccountId = "string",
              EntityPath = list(
                list(
                  Name = "string",
                  Coverage = 123.0,
                  Remote = TRUE|FALSE
                )
              ),
              Inferred = TRUE|FALSE
            )
          ),
          ClientImpacting = TRUE|FALSE
        )
      ),
      Revision = 123,
      MatchedEventTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  ApproximateTime = as.POSIXct(
    "2015-01-01"
  ),
  TracesProcessedCount = 123,
  NextToken = "string"
)

Request syntax

svc$get_trace_summaries(
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  TimeRangeType = "TraceId"|"Event"|"Service",
  Sampling = TRUE|FALSE,
  SamplingStrategy = list(
    Name = "PartialScan"|"FixedRate",
    Value = 123.0
  ),
  FilterExpression = "string",
  NextToken = "string"
)