Get Sampling Targets

xray_get_sampling_targets

R Documentation

Requests a sampling quota for rules that the service is using to sample requests

Description

Requests a sampling quota for rules that the service is using to sample requests.

Usage

xray_get_sampling_targets(SamplingStatisticsDocuments,
  SamplingBoostStatisticsDocuments)

Arguments

SamplingStatisticsDocuments	[required] Information about rules that the service is using to sample requests.
SamplingBoostStatisticsDocuments	Information about rules that the service is using to boost sampling rate.

Value

A list with the following syntax:

list(
  SamplingTargetDocuments = list(
    list(
      RuleName = "string",
      FixedRate = 123.0,
      ReservoirQuota = 123,
      ReservoirQuotaTTL = as.POSIXct(
        "2015-01-01"
      ),
      Interval = 123,
      SamplingBoost = list(
        BoostRate = 123.0,
        BoostRateTTL = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  LastRuleModification = as.POSIXct(
    "2015-01-01"
  ),
  UnprocessedStatistics = list(
    list(
      RuleName = "string",
      ErrorCode = "string",
      Message = "string"
    )
  ),
  UnprocessedBoostStatistics = list(
    list(
      RuleName = "string",
      ErrorCode = "string",
      Message = "string"
    )
  )
)

Request syntax

svc$get_sampling_targets(
  SamplingStatisticsDocuments = list(
    list(
      RuleName = "string",
      ClientID = "string",
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      RequestCount = 123,
      SampledCount = 123,
      BorrowCount = 123
    )
  ),
  SamplingBoostStatisticsDocuments = list(
    list(
      RuleName = "string",
      ServiceName = "string",
      Timestamp = as.POSIXct(
        "2015-01-01"
      ),
      AnomalyCount = 123,
      TotalCount = 123,
      SampledAnomalyCount = 123
    )
  )
)