Skip to content
AWS for Query.Farm

aws.xray.get_sampling_targets

Example SQL Queries

SELECT * FROM
aws.xray.get_sampling_targets
WHERE
"sampling_statistics_documents" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
sampling_statistics_documents Required Input Column

Information about rules that the service is using to sample requests.

STRUCT(
    "rule_name" VARCHAR,
    "client_id" VARCHAR,
    "timestamp" TIMESTAMP_S,
    "request_count" BIGINT,
    "sampled_count" BIGINT,
    "borrow_count" BIGINT
)[]
Show child fields
sampling_statistics_documents[]
Show child fields
sampling_statistics_documents[].borrow_count

The number of requests recorded with borrowed reservoir quota.

sampling_statistics_documents[].client_id

A unique identifier for the service in hexadecimal.

sampling_statistics_documents[].request_count

The number of requests that matched the rule.

sampling_statistics_documents[].rule_name

The name of the sampling rule.

sampling_statistics_documents[].sampled_count

The number of requests recorded.

sampling_statistics_documents[].timestamp

The current time.

_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
last_rule_modification

The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.

TIMESTAMP_S
sampling_target_documents

Updated rules that the service should use to sample requests.

STRUCT(
    "rule_name" VARCHAR,
    "fixed_rate" DOUBLE,
    "reservoir_quota" BIGINT,
    "reservoir_quota_ttl" TIMESTAMP_S,
    "interval" BIGINT
)[]
Show child fields
sampling_target_documents[]
Show child fields
sampling_target_documents[].fixed_rate

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

sampling_target_documents[].interval

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

sampling_target_documents[].reservoir_quota

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

sampling_target_documents[].reservoir_quota_ttl

When the reservoir quota expires.

sampling_target_documents[].rule_name

The name of the sampling rule.

unprocessed_statistics

Information about SamplingStatisticsDocument that X-Ray could not process.

STRUCT(
    "rule_name" VARCHAR,
    "error_code" VARCHAR,
    "message" VARCHAR
)[]
Show child fields
unprocessed_statistics[]
Show child fields
unprocessed_statistics[].error_code

The error code.

unprocessed_statistics[].message

The error message.

unprocessed_statistics[].rule_name

The name of the sampling rule.