SamplingRule

import type { SamplingRule } from "https://aws-api.deno.dev/v0.4/services/xray.ts?docs=full";

A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

interface SamplingRule {

Attributes?: {

[key: string]: string | null | undefined;

} | null;

FixedRate: number;

Host: string;

HTTPMethod: string;

Priority: number;

ReservoirSize: number;

ResourceARN: string;

RuleARN?: string | null;

RuleName?: string | null;

ServiceName: string;

ServiceType: string;

URLPath: string;

Version: number;

}

§Properties

Attributes?: {

[key: string]: string | null | undefined;

} | null

[src]

Matches attributes derived from the request.

FixedRate: number

[src]

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

Host: string

[src]

Matches the hostname from a request URL.

HTTPMethod: string

[src]

Matches the HTTP method of a request.

Priority: number

[src]

The priority of the sampling rule.

ReservoirSize: number

[src]

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.

ResourceARN: string

[src]

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

RuleARN?: string | null

[src]

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

RuleName?: string | null

[src]

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

ServiceName: string

[src]

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