# Elasticsearch REST Client

<!-- llms-txt-link: /llms.txt -->

> OpenTelemetry Java agent instrumentation

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

- **Name**: `elasticsearch-rest-5.0`
- **Scope**: `io.opentelemetry.elasticsearch-rest-5.0`
- **Target versions**: `org.elasticsearch.client:elasticsearch-rest-client:[5.0,6.4)`, `org.elasticsearch.client:rest:[5.0,6.4)`
- **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

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `otel.instrumentation.http.known-methods` | list | CONNECT,DELETE,GET,HEAD,OPTIONS,PATCH,POST,PUT,TRACE | Configures the instrumentation to recognize an alternative set of HTTP request methods. All other methods will be treated as `_OTHER`. |
| `otel.instrumentation.elasticsearch.capture-search-query` | boolean | false | Enable 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-5.0/elasticsearch-rest-5.0-9a5214d30b72.json](/data/javaagent/instrumentations/elasticsearch-rest-5.0/elasticsearch-rest-5.0-9a5214d30b72.json)
- **Explore**: [/java-agent/instrumentation/elasticsearch-rest-5.0](/java-agent/instrumentation/elasticsearch-rest-5.0)