XRay / Client / create_sampling_rule

create_sampling_rule#

XRay.Client.create_sampling_rule(**kwargs)#

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Request Syntax

response = client.create_sampling_rule(
    SamplingRule={
        'RuleName': 'string',
        'RuleARN': 'string',
        'ResourceARN': 'string',
        'Priority': 123,
        'FixedRate': 123.0,
        'ReservoirSize': 123,
        'ServiceName': 'string',
        'ServiceType': 'string',
        'Host': 'string',
        'HTTPMethod': 'string',
        'URLPath': 'string',
        'Version': 123,
        'Attributes': {
            'string': 'string'
        }
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

SamplingRule (dict) –
[REQUIRED]

The rule definition.
- RuleName (string) –
  
  The name of the sampling rule. Specify a rule by either name or ARN, but not both.
- RuleARN (string) –
  
  The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
- ResourceARN (string) – [REQUIRED]
  
  Matches the ARN of the Amazon Web Services resource on which the service runs.
- Priority (integer) – [REQUIRED]
  
  The priority of the sampling rule.
- FixedRate (float) – [REQUIRED]
  
  The percentage of matching requests to instrument, after the reservoir is exhausted.
- ReservoirSize (integer) – [REQUIRED]
  
  A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
- ServiceName (string) – [REQUIRED]
  
  Matches the name that the service uses to identify itself in segments.
- ServiceType (string) – [REQUIRED]
  
  Matches the origin that the service uses to identify its type in segments.
- Host (string) – [REQUIRED]
  
  Matches the hostname from a request URL.
- HTTPMethod (string) – [REQUIRED]
  
  Matches the HTTP method of a request.
- URLPath (string) – [REQUIRED]
  
  Matches the path from a request URL.
- Version (integer) – [REQUIRED]
  
  The version of the sampling rule format ( 1).
- Attributes (dict) –
  
  Matches attributes derived from the request.
  - (string) –
    - (string) –
Tags (list) –
A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:
- Maximum number of user-applied tags per resource: 50
- Maximum tag key length: 128 Unicode characters
- Maximum tag value length: 256 Unicode characters
- Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
- Tag keys and values are case sensitive.
- Don’t use aws: as a prefix for keys; it’s reserved for Amazon Web Services use.
- (dict) –
  
  A map that contains tag keys and tag values to attach to an Amazon Web Services X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.
  
  The following restrictions apply to tags:
  - Maximum number of user-applied tags per resource: 50
  - Tag keys and values are case sensitive.
  - Don’t use aws: as a prefix for keys; it’s reserved for Amazon Web Services use. You cannot edit or delete system tags.
  - Key (string) – [REQUIRED]
    
    A tag key, such as Stage or Name. A tag key cannot be empty. The key can be a maximum of 128 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
  - Value (string) – [REQUIRED]
    
    An optional tag value, such as Production or test-only. The value can be a maximum of 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

Return type:

dict

Returns:

Response Syntax

{
    'SamplingRuleRecord': {
        'SamplingRule': {
            'RuleName': 'string',
            'RuleARN': 'string',
            'ResourceARN': 'string',
            'Priority': 123,
            'FixedRate': 123.0,
            'ReservoirSize': 123,
            'ServiceName': 'string',
            'ServiceType': 'string',
            'Host': 'string',
            'HTTPMethod': 'string',
            'URLPath': 'string',
            'Version': 123,
            'Attributes': {
                'string': 'string'
            }
        },
        'CreatedAt': datetime(2015, 1, 1),
        'ModifiedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- SamplingRuleRecord (dict) –
  
  The saved rule definition and metadata.
  - SamplingRule (dict) –
    
    The sampling rule.
    - RuleName (string) –
      
      The name of the sampling rule. Specify a rule by either name or ARN, but not both.
    - RuleARN (string) –
      
      The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
    - ResourceARN (string) –
      
      Matches the ARN of the Amazon Web Services resource on which the service runs.
    - Priority (integer) –
      
      The priority of the sampling rule.
    - FixedRate (float) –
      
      The percentage of matching requests to instrument, after the reservoir is exhausted.
    - ReservoirSize (integer) –
      
      A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
    - ServiceName (string) –
      
      Matches the name that the service uses to identify itself in segments.
    - ServiceType (string) –
      
      Matches the origin that the service uses to identify its type in segments.
    - Host (string) –
      
      Matches the hostname from a request URL.
    - HTTPMethod (string) –
      
      Matches the HTTP method of a request.
    - URLPath (string) –
      
      Matches the path from a request URL.
    - Version (integer) –
      
      The version of the sampling rule format ( 1).
    - Attributes (dict) –
      
      Matches attributes derived from the request.
      - (string) –
        
        (string) –
  - CreatedAt (datetime) –
    
    When the rule was created.
  - ModifiedAt (datetime) –
    
    When the rule was last modified.

Exceptions

XRay.Client.exceptions.InvalidRequestException
XRay.Client.exceptions.ThrottledException
XRay.Client.exceptions.RuleLimitExceededException