Class CustomDestinationForwardDestinationElasticsearch

The Elasticsearch destination.

Hierarchy

  • CustomDestinationForwardDestinationElasticsearch

Constructors

constructor

Properties

additionalProperties? auth endpoint indexName indexRotation? type

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

auth

auth: CustomDestinationElasticsearchDestinationAuth

Basic access authentication.

endpoint

endpoint: string

The destination for which logs will be forwarded to. Must have HTTPS scheme and forwarding back to Datadog is not allowed.

indexName

indexName: string

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

Optional indexRotation

indexRotation?: string

Date pattern with US locale and UTC timezone to be appended to the index name after adding - (that is, ${index_name}-${indexPattern}). You can customize the index rotation naming pattern by choosing one of these options:

  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)

If this field is missing or is blank, it means that the index name will always be the same (that is, no rotation).

type

type: CustomDestinationForwardDestinationElasticsearchType

Type of the Elasticsearch destination.

Settings

Member Visibility

Theme

Generated using TypeDoc