Class ObservabilityPipelineQuotaProcessor

The quota processor measures logging traffic for logs that match a specified filter. When the configured daily quota is met, the processor can drop or alert.

Supported pipeline types: logs

Hierarchy

  • ObservabilityPipelineQuotaProcessor

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.

dropEvents?: boolean

If set to true, logs that match the quota filter and are sent after the quota is exceeded are dropped. Logs that do not match the filter continue through the pipeline. Note: You can set either drop_events or overflow_action, but not both.

enabled: boolean

Indicates whether the processor is enabled.

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).

ignoreWhenMissingPartitions?: boolean

If true, the processor skips quota checks when partition fields are missing from the logs.

include: string

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

The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.

name: string

Name of the quota.

The action to take when the quota or bucket limit is exceeded. Options:

  • drop: Drop the event.
  • no_action: Let the event pass through.
  • overflow_routing: Route to an overflow destination.

A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.

partitionFields?: string[]

A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.

The action to take when the quota or bucket limit is exceeded. Options:

  • drop: Drop the event.
  • no_action: Let the event pass through.
  • overflow_routing: Route to an overflow destination.

The processor type. The value should always be quota.

Generated using TypeDoc