Skip to content

/AWS1/CL_XRASAMPLINGTARGETDOC

Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_rulename TYPE /AWS1/XRASTRING /AWS1/XRASTRING

The name of the sampling rule.

iv_fixedrate TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING

The percentage of matching requests to instrument, after the reservoir is exhausted.

iv_reservoirquota TYPE /AWS1/XRANULLABLEINTEGER /AWS1/XRANULLABLEINTEGER

The number of requests per second that X-Ray allocated for this service.

iv_reservoirquotattl TYPE /AWS1/XRATIMESTAMP /AWS1/XRATIMESTAMP

When the reservoir quota expires.

iv_interval TYPE /AWS1/XRANULLABLEINTEGER /AWS1/XRANULLABLEINTEGER

The number of seconds for the service to wait before getting sampling targets again.

io_samplingboost TYPE REF TO /AWS1/CL_XRASAMPLINGBOOST /AWS1/CL_XRASAMPLINGBOOST

The sampling boost that X-Ray allocated for this service.


Queryable Attributes

RuleName

The name of the sampling rule.

Accessible with the following methods

Method Description
GET_RULENAME() Getter for RULENAME, with configurable default
ASK_RULENAME() Getter for RULENAME w/ exceptions if field has no value
HAS_RULENAME() Determine if RULENAME has a value

FixedRate

The percentage of matching requests to instrument, after the reservoir is exhausted.

Accessible with the following methods

Method Description
GET_FIXEDRATE() Getter for FIXEDRATE
ASK_FIXEDRATE() Getter for FIXEDRATE w/ exceptions if field has no value
STR_FIXEDRATE() String format for FIXEDRATE

ReservoirQuota

The number of requests per second that X-Ray allocated for this service.

Accessible with the following methods

Method Description
GET_RESERVOIRQUOTA() Getter for RESERVOIRQUOTA, with configurable default
ASK_RESERVOIRQUOTA() Getter for RESERVOIRQUOTA w/ exceptions if field has no valu
HAS_RESERVOIRQUOTA() Determine if RESERVOIRQUOTA has a value

ReservoirQuotaTTL

When the reservoir quota expires.

Accessible with the following methods

Method Description
GET_RESERVOIRQUOTATTL() Getter for RESERVOIRQUOTATTL, with configurable default
ASK_RESERVOIRQUOTATTL() Getter for RESERVOIRQUOTATTL w/ exceptions if field has no v
HAS_RESERVOIRQUOTATTL() Determine if RESERVOIRQUOTATTL has a value

Interval

The number of seconds for the service to wait before getting sampling targets again.

Accessible with the following methods

Method Description
GET_INTERVAL() Getter for INTERVAL, with configurable default
ASK_INTERVAL() Getter for INTERVAL w/ exceptions if field has no value
HAS_INTERVAL() Determine if INTERVAL has a value

SamplingBoost

The sampling boost that X-Ray allocated for this service.

Accessible with the following methods

Method Description
GET_SAMPLINGBOOST() Getter for SAMPLINGBOOST

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_SAMPLINGTARGETDOCUMENTLIST

TYPES TT_SAMPLINGTARGETDOCUMENTLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_XRASAMPLINGTARGETDOC WITH DEFAULT KEY
.