Skip to content
AWS for Query.Farm

aws.xray.get_sampling_rules

Example SQL Queries

SELECT * FROM
aws.xray.get_sampling_rules;

Description

Retrieves all sampling rules.

Table Definition

Column NameColumn Data Type
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
created_at

When the rule was created.

TIMESTAMP_S
modified_at

When the rule was last modified.

TIMESTAMP_S
sampling_rule

The sampling rule.

STRUCT(
    "rule_name" VARCHAR,
    "rule_arn" VARCHAR,
    "resource_arn" VARCHAR,
    "priority" BIGINT,
    "fixed_rate" DOUBLE,
    "reservoir_size" BIGINT,
    "service_name" VARCHAR,
    "service_type" VARCHAR,
    "host" VARCHAR,
    "http_method" VARCHAR,
    "url_path" VARCHAR,
    "version" BIGINT,
    "attributes" MAP(VARCHAR, VARCHAR)
)
Show child fields
sampling_rule.attributes

Matches attributes derived from the request.

sampling_rule.fixed_rate

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

sampling_rule.host

Matches the hostname from a request URL.

sampling_rule.http_method

Matches the HTTP method of a request.

sampling_rule.priority

The priority of the sampling rule.

sampling_rule.reservoir_size

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.

sampling_rule.resource_arn

Matches the ARN of the Amazon Web Services resource on which the service runs.

sampling_rule.rule_arn

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

sampling_rule.rule_name

The name of the sampling rule. Specify a rule by either name or ARN, but not both.

sampling_rule.service_name

Matches the name that the service uses to identify itself in segments.

sampling_rule.service_type

Matches the origin that the service uses to identify its type in segments.

sampling_rule.url_path

Matches the path from a request URL.

sampling_rule.version

The version of the sampling rule format (1).