Class ObservabilityPipelineElasticsearchDestination

The elasticsearch destination writes logs or metrics to an Elasticsearch cluster.

Supported pipeline types: logs, metrics

Hierarchy

  • ObservabilityPipelineElasticsearchDestination

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

The Elasticsearch API version to use. Set to auto to auto-detect.

Authentication settings for the Elasticsearch destination. When strategy is basic, use username_key and password_key to reference credentials stored in environment variables or secrets.

Configuration for buffer settings on destination components.

bulkIndex?: string

The name of the index to write events to in Elasticsearch.

Compression configuration for the Elasticsearch destination.

Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.

endpointUrlKey?: string

Name of the environment variable or secret that holds the Elasticsearch endpoint URL.

id: string

The unique identifier for this component.

idKey?: string

The name of the field used as the document ID in Elasticsearch.

inputs: string[]

A list of component IDs whose output is used as the input for this component.

pipeline?: string

The name of an Elasticsearch ingest pipeline to apply to events before indexing.

requestRetryPartial?: boolean

When true, retries failed partial bulk requests when some events in a batch fail while others succeed.

Configuration for enabling TLS encryption between the pipeline component and external services.

The destination type. The value should always be elasticsearch.

Generated using TypeDoc