Elasticsearch Transport Client
OpenTelemetry Java agent instrumentation
This instrumentation enables database client spans and database client metrics for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
- Name:
elasticsearch-transport-6.0 - Scope:
io.opentelemetry.elasticsearch-transport-6.0 - Target versions:
org.elasticsearch.client:transport:[6.0.0,),org.elasticsearch:elasticsearch:[6.0.0,8.0.0) - Library: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
Telemetry
When default
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | db.operation (STRING), db.system (STRING), network.peer.address (STRING), network.peer.port (LONG), network.type (STRING) |
When otel.instrumentation.elasticsearch.experimental-span-attributes=true
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | db.operation (STRING), db.system (STRING), elasticsearch.action (STRING), elasticsearch.id (STRING), elasticsearch.request (STRING), elasticsearch.request.indices (STRING), elasticsearch.request.write.type (STRING), elasticsearch.request.write.version (LONG), elasticsearch.response.status (LONG), elasticsearch.shard.replication.failed (LONG), elasticsearch.shard.replication.successful (LONG), elasticsearch.shard.replication.total (LONG), elasticsearch.type (STRING), elasticsearch.version (LONG), network.peer.address (STRING), network.peer.port (LONG), network.type (STRING) |
When otel.semconv-stability.opt-in=database
Metrics
| Metric | Instrument | Type | Unit | Description |
|---|---|---|---|---|
db.client.operation.duration | histogram | HISTOGRAM | s | Duration of database client operations. |
| Metric | Attributes |
|---|---|
db.client.operation.duration | db.operation.name (STRING), db.system.name (STRING) |
Spans
| Span kind | Attributes |
|---|---|
| CLIENT | db.operation.name (STRING), db.system.name (STRING), error.type (STRING), network.peer.address (STRING), network.peer.port (LONG), server.address (STRING) |
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
otel.instrumentation.elasticsearch.experimental-span-attributes | boolean | false | Enable the capture of elasticsearch.action, elasticsearch.id, elasticsearch.request, elasticsearch.request.indices, elasticsearch.request.write.type, elasticsearch.request.write.version, elasticsearch.response.status, elasticsearch.shard.replication.failed, elasticsearch.shard.replication.successful, elasticsearch.shard.replication.total, elasticsearch.type, and elasticsearch.version experimental span attributes. |