This documentation has an index for AI agents at /llms.txt. A Markdown version of this page is available at https://explorer.opentelemetry.io/java-agent/instrumentation/opensearch-java-3.0.md.

OpenSearch Java Client

OpenTelemetry Java agent instrumentation

This instrumentation enables database client spans and database client metrics for the OpenSearch Java client.

  • Name: opensearch-java-3.0
  • Scope: io.opentelemetry.opensearch-java-3.0
  • Target versions: org.opensearch.client:opensearch-java:[3.0,)
  • Library: https://docs.opensearch.org/latest/clients/java/

Telemetry

  • Metrics: db.client.operation.duration
  • Span attributes: db.operation, db.statement, db.system, db.operation.name, db.query.text, db.system.name

Configuration

OptionTypeDefaultDescription
otel.instrumentation.opensearch.capture-search-querybooleantrueEnable the capture of sanitized search query bodies. Search queries may contain personal or sensitive information.

Data

  • JSON: /data/javaagent/instrumentations/opensearch-java-3.0/opensearch-java-3.0-1df26a9b41e7.json
  • Explore: /java-agent/instrumentation/opensearch-java-3.0