Class: Aws::XRay::Types::SamplingStatisticsDocument

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb

Overview

Note:

When making an API call, you may pass SamplingStatisticsDocument data as a hash:

{
  rule_name: "RuleName", # required
  client_id: "ClientID", # required
  timestamp: Time.now, # required
  request_count: 1, # required
  sampled_count: 1, # required
  borrow_count: 1,
}

Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#borrow_countInteger

The number of requests recorded with borrowed reservoir quota.

Returns:

  • (Integer)


1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1867

class SamplingStatisticsDocument < Struct.new(
  :rule_name,
  :client_id,
  :timestamp,
  :request_count,
  :sampled_count,
  :borrow_count)
  SENSITIVE = []
  include Aws::Structure
end

#client_idString

A unique identifier for the service in hexadecimal.

Returns:

  • (String)


1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1867

class SamplingStatisticsDocument < Struct.new(
  :rule_name,
  :client_id,
  :timestamp,
  :request_count,
  :sampled_count,
  :borrow_count)
  SENSITIVE = []
  include Aws::Structure
end

#request_countInteger

The number of requests that matched the rule.

Returns:

  • (Integer)


1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1867

class SamplingStatisticsDocument < Struct.new(
  :rule_name,
  :client_id,
  :timestamp,
  :request_count,
  :sampled_count,
  :borrow_count)
  SENSITIVE = []
  include Aws::Structure
end

#rule_nameString

The name of the sampling rule.

Returns:

  • (String)


1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1867

class SamplingStatisticsDocument < Struct.new(
  :rule_name,
  :client_id,
  :timestamp,
  :request_count,
  :sampled_count,
  :borrow_count)
  SENSITIVE = []
  include Aws::Structure
end

#sampled_countInteger

The number of requests recorded.

Returns:

  • (Integer)


1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1867

class SamplingStatisticsDocument < Struct.new(
  :rule_name,
  :client_id,
  :timestamp,
  :request_count,
  :sampled_count,
  :borrow_count)
  SENSITIVE = []
  include Aws::Structure
end

#timestampTime

The current time.

Returns:

  • (Time)


1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 1867

class SamplingStatisticsDocument < Struct.new(
  :rule_name,
  :client_id,
  :timestamp,
  :request_count,
  :sampled_count,
  :borrow_count)
  SENSITIVE = []
  include Aws::Structure
end