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/elasticsearch-rest-6.4.md.

Elasticsearch REST Client

OpenTelemetry Java agent instrumentation

This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.

  • Name: elasticsearch-rest-6.4
  • Scope: io.opentelemetry.elasticsearch-rest-6.4
  • Target versions: org.elasticsearch.client:elasticsearch-rest-client:[6.4,7.0)
  • Library: https://www.elastic.co/guide/en/elasticsearch/client/java-rest

Telemetry

  • Metrics: db.client.operation.duration
  • Span attributes: db.system, http.request.method, server.address, server.port, url.full, db.system.name

Configuration

OptionTypeDefaultDescription
otel.instrumentation.http.known-methodslistCONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACEConfigures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as _OTHER.
otel.instrumentation.elasticsearch.capture-search-querybooleanfalseEnable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information.

Data

  • JSON: /data/javaagent/instrumentations/elasticsearch-rest-6.4/elasticsearch-rest-6.4-488b3b447393.json
  • Explore: /java-agent/instrumentation/elasticsearch-rest-6.4