Get Time Series Service Statistics

xray_get_time_series_service_statistics

R Documentation

Get an aggregation of service statistics defined by a specific time range

Description

Get an aggregation of service statistics defined by a specific time range.

Usage

xray_get_time_series_service_statistics(StartTime, EndTime, GroupName,
  GroupARN, EntitySelectorExpression, Period, ForecastStatistics,
  NextToken)

Arguments

StartTime

[required] The start of the time frame for which to aggregate statistics.

EndTime

[required] The end of the time frame for which to aggregate statistics.

GroupName

The case-sensitive name of the group for which to pull statistics from.

GroupARN

The Amazon Resource Name (ARN) of the group for which to pull statistics from.

EntitySelectorExpression

A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

Period

Aggregation period in seconds.

ForecastStatistics

The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.

NextToken

Pagination token.

Value

A list with the following syntax:

list(
  TimeSeriesServiceStatistics = list(
    list(
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      EdgeSummaryStatistics = list(
        OkCount = 123,
        ErrorStatistics = list(
          ThrottleCount = 123,
          OtherCount = 123,
          TotalCount = 123
        ),
        FaultStatistics = list(
          OtherCount = 123,
          TotalCount = 123
        ),
        TotalCount = 123,
        TotalResponseTime = 123.0
      ),
      ServiceSummaryStatistics = list(
        OkCount = 123,
        ErrorStatistics = list(
          ThrottleCount = 123,
          OtherCount = 123,
          TotalCount = 123
        ),
        FaultStatistics = list(
          OtherCount = 123,
          TotalCount = 123
        ),
        TotalCount = 123,
        TotalResponseTime = 123.0
      ),
      ServiceForecastStatistics = list(
        FaultCountHigh = 123,
        FaultCountLow = 123
      ),
      ResponseTimeHistogram = list(
        list(
          Value = 123.0,
          Count = 123
        )
      )
    )
  ),
  ContainsOldGroupVersions = TRUE|FALSE,
  NextToken = "string"
)

Request syntax

svc$get_time_series_service_statistics(
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  GroupName = "string",
  GroupARN = "string",
  EntitySelectorExpression = "string",
  Period = 123,
  ForecastStatistics = TRUE|FALSE,
  NextToken = "string"
)