Class ObservabilityPipelineSampleProcessor

The sample processor allows probabilistic sampling of logs at a fixed rate.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineSampleProcessor

Constructors

Properties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any
displayName?: string

The display name for a component.

enabled: boolean

Indicates whether the processor is enabled.

groupBy?: string[]

Optional list of fields to group events by. Each group is sampled independently.

id: string

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

include: string

A Datadog search query used to determine which logs this processor targets.

percentage: number

The percentage of logs to sample.

The processor type. The value should always be sample.

Generated using TypeDoc