Class ObservabilityPipelineConfig

Specifies the pipeline's configuration, including its sources, processors, and destinations.

Hierarchy

  • ObservabilityPipelineConfig

Constructors

constructor

Properties

additionalProperties? destinations pipelineType? processorGroups? processors? sources useLegacySearchSyntax?

Constructors

constructor

Properties

Optional additionalProperties

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

destinations

destinations: ObservabilityPipelineConfigDestinationItem[]

A list of destination components where processed logs are sent.

Optional pipelineType

pipelineType?: ObservabilityPipelineConfigPipelineType

The type of data being ingested. Defaults to logs if not specified.

Optional processorGroups

processorGroups?: ObservabilityPipelineConfigProcessorGroup[]

A list of processor groups that transform or enrich log data.

Optional processors

processors?: ObservabilityPipelineConfigProcessorGroup[]

A list of processor groups that transform or enrich log data.

Deprecated: This field is deprecated, you should now use the processor_groups field.

sources

sources: ObservabilityPipelineConfigSourceItem[]

A list of configured data sources for the pipeline.

Optional useLegacySearchSyntax

useLegacySearchSyntax?: boolean

Set to true to continue using the legacy search syntax while migrating filter queries. After migrating all queries to the new syntax, set to false. The legacy syntax is deprecated and will eventually be removed. Requires Observability Pipelines Worker 2.11 or later. See Upgrade Your Filter Queries to the New Search Syntax for more information.

Settings

Member Visibility

Theme

Generated using TypeDoc