OpenSearch Exporter

Status
Stability	unmaintained: traces, logs
Distributions	contrib
Issues
Code Owners	@Aneurysm9
Emeritus	@MitchellGale, @MaxKsyunz, @YANG-DB

OpenSearch exporter supports sending OpenTelemetry signals as documents to OpenSearch.

The documents are sent using observability catalog schema.

Configuration options

Indexing Options

The Observability indices would follow the recommended pattern for immutable data stream ingestion using the data_stream concepts. Index pattern will follow the next naming template ss4o_{type}-{dataset}-{namespace}

• dataset (default=default) a user-provided label to classify source of telemetry. It is used to construct the name of the destination index or data stream.
• namespace (default=namespace) a user-provided label to group telemetry. It is used to construct the name of the destination index or data stream.

LogsIndex configures the index, index alias, or data stream name logs should be indexed in.

• logs_index a user-provided label to specify name of the destination index or data stream.

HTTP Connection Options

OpenSearch export supports standard HTTP client settings.

• http.endpoint (required) <url>:<port> of OpenSearch node to send data to.

TLS settings

Supports standard TLS settings as part of HTTP settings. See TLS Configuration/Client Settings.

Retry Options

• retry_on_failure: See retry_on_failure

Sending Queue Options

• sending_queue: See sending_queue

Timeout Options

• timeout : See timeout

Bulk Indexer Options

• bulk_action (optional): the action for ingesting data. Only create and index are allowed here.

Example

extensions:
  basicauth/client:
  client_auth:
    username: username
    password: password
    
exporters:
  opensearch/trace:
    http:
      endpoint: https://opensearch.example.com:9200
      auth:
        authenticator: basicauth/client
# ······
service:
  pipelines:
    traces:
      receivers: [otlp]
      exporters: [opensearch/trace]
      processors: [batch]