Skip to content

Elasticsearch instrumentation metadata #14164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 14, 2025
Merged

Elasticsearch instrumentation metadata #14164

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
780b3d8
elasticsearch metadata
jaydeluca Jun 28, 2025
fd6cab3
elasticsearch metadata
jaydeluca Jun 30, 2025
6be6753
new descriptions
jaydeluca Jul 1, 2025
34e53ac
refactor
jaydeluca Jul 10, 2025
afea74f
fix
jaydeluca Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
273 changes: 273 additions & 0 deletions docs/instrumentation-list.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1100,6 +1100,9 @@ libraries:
default: false
elasticsearch:
- name: elasticsearch-api-client-7.16
description: This instrumentation provides client spans for Elasticsearch API
client requests for version 7 of the client. Versions 8.10 and later have native
support for OpenTelemetry.
source_path: instrumentation/elasticsearch/elasticsearch-api-client-7.16
scope:
name: io.opentelemetry.elasticsearch-api-client-7.16
Expand All @@ -1108,6 +1111,7 @@ libraries:
- co.elastic.clients:elasticsearch-java:[7.16,7.17.20)
- co.elastic.clients:elasticsearch-java:[8.0.0,8.10)
- name: elasticsearch-rest-5.0
description: This instrumentation provides tracing for Elasticsearch REST clients.
source_path: instrumentation/elasticsearch/elasticsearch-rest-5.0
scope:
name: io.opentelemetry.elasticsearch-rest-5.0
Expand All @@ -1122,7 +1126,23 @@ libraries:
may contain personal or sensitive information.
type: boolean
default: false
telemetry:
- when: default
spans:
- span_kind: CLIENT
attributes:
- name: db.system
type: STRING
- name: http.request.method
type: STRING
- name: server.address
type: STRING
- name: server.port
type: LONG
- name: url.full
type: STRING
- name: elasticsearch-rest-6.4
description: This instrumentation provides tracing for Elasticsearch REST clients.
source_path: instrumentation/elasticsearch/elasticsearch-rest-6.4
scope:
name: io.opentelemetry.elasticsearch-rest-6.4
Expand All @@ -1135,7 +1155,23 @@ libraries:
Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information.
type: boolean
default: false
telemetry:
- when: default
spans:
- span_kind: CLIENT
attributes:
- name: db.system
type: STRING
- name: http.request.method
type: STRING
- name: server.address
type: STRING
- name: server.port
type: LONG
- name: url.full
type: STRING
- name: elasticsearch-rest-7.0
description: This instrumentation provides tracing for Elasticsearch REST clients.
source_path: instrumentation/elasticsearch/elasticsearch-rest-7.0
scope:
name: io.opentelemetry.elasticsearch-rest-7.0
Expand All @@ -1150,30 +1186,267 @@ libraries:
Enable the capture of search query bodies. It is important to note that Elasticsearch queries may contain personal or sensitive information.
type: boolean
default: false
telemetry:
- when: default
spans:
- span_kind: CLIENT
attributes:
- name: db.system
type: STRING
- name: http.request.method
type: STRING
- name: server.address
type: STRING
- name: server.port
type: LONG
- name: url.full
type: STRING
- name: elasticsearch-transport-5.0
description: |
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.0
scope:
name: io.opentelemetry.elasticsearch-transport-5.0
target_versions:
javaagent:
- org.elasticsearch.client:transport:[5.0.0,5.3.0)
- org.elasticsearch:elasticsearch:[5.0.0,5.3.0)
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
description: Enable the capture of experimental span attributes.
type: boolean
default: false
telemetry:
- when: default
spans:
- span_kind: CLIENT
attributes:
- name: db.operation
type: STRING
- name: db.system
type: STRING
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- when: otel.instrumentation.elasticsearch.experimental-span-attributes=true
spans:
- span_kind: CLIENT
attributes:
- name: db.operation
type: STRING
- name: db.system
type: STRING
- name: elasticsearch.action
type: STRING
- name: elasticsearch.id
type: STRING
- name: elasticsearch.request
type: STRING
- name: elasticsearch.request.indices
type: STRING
- name: elasticsearch.request.write.type
type: STRING
- name: elasticsearch.response.status
type: LONG
- name: elasticsearch.shard.replication.failed
type: LONG
- name: elasticsearch.shard.replication.successful
type: LONG
- name: elasticsearch.shard.replication.total
type: LONG
- name: elasticsearch.type
type: STRING
- name: elasticsearch.version
type: LONG
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- when: otel.semconv-stability.opt-in=database
spans:
- span_kind: CLIENT
attributes:
- name: db.operation.name
type: STRING
- name: db.system.name
type: STRING
- name: error.type
type: STRING
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- name: elasticsearch-transport-5.3
description: |
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.3
scope:
name: io.opentelemetry.elasticsearch-transport-5.3
target_versions:
javaagent:
- org.elasticsearch.client:transport:[5.3.0,6.0.0)
- org.elasticsearch:elasticsearch:[5.3.0,6.0.0)
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
description: Enable the capture of experimental span attributes.
type: boolean
default: false
telemetry:
- when: default
spans:
- span_kind: CLIENT
attributes:
- name: db.operation
type: STRING
- name: db.system
type: STRING
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- when: otel.instrumentation.elasticsearch.experimental-span-attributes=true
spans:
- span_kind: CLIENT
attributes:
- name: db.operation
type: STRING
- name: db.system
type: STRING
- name: elasticsearch.action
type: STRING
- name: elasticsearch.id
type: STRING
- name: elasticsearch.request
type: STRING
- name: elasticsearch.request.indices
type: STRING
- name: elasticsearch.request.search.types
type: STRING
- name: elasticsearch.request.write.type
type: STRING
- name: elasticsearch.request.write.version
type: LONG
- name: elasticsearch.response.status
type: LONG
- name: elasticsearch.shard.broadcast.failed
type: LONG
- name: elasticsearch.shard.broadcast.successful
type: LONG
- name: elasticsearch.shard.broadcast.total
type: LONG
- name: elasticsearch.shard.replication.failed
type: LONG
- name: elasticsearch.shard.replication.successful
type: LONG
- name: elasticsearch.shard.replication.total
type: LONG
- name: elasticsearch.type
type: STRING
- name: elasticsearch.version
type: LONG
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- when: otel.semconv-stability.opt-in=database
spans:
- span_kind: CLIENT
attributes:
- name: db.operation.name
type: STRING
- name: db.system.name
type: STRING
- name: error.type
type: STRING
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- name: elasticsearch-transport-6.0
description: |
This instrumentation provides client spans for Elasticsearch transport client requests. Each call produces a span named after the Elasticsearch action, enriched with transport-specific attributes.
source_path: instrumentation/elasticsearch/elasticsearch-transport-6.0
scope:
name: io.opentelemetry.elasticsearch-transport-6.0
target_versions:
javaagent:
- org.elasticsearch:elasticsearch:[6.0.0,8.0.0)
- org.elasticsearch.client:transport:[6.0.0,)
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
description: Enable the capture of experimental span attributes.
type: boolean
default: false
telemetry:
- when: default
spans:
- span_kind: CLIENT
attributes:
- name: db.operation
type: STRING
- name: db.system
type: STRING
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- name: network.type
type: STRING
- when: otel.instrumentation.elasticsearch.experimental-span-attributes=true
spans:
- span_kind: CLIENT
attributes:
- name: db.operation
type: STRING
- name: db.system
type: STRING
- name: elasticsearch.action
type: STRING
- name: elasticsearch.id
type: STRING
- name: elasticsearch.request
type: STRING
- name: elasticsearch.request.indices
type: STRING
- name: elasticsearch.request.write.type
type: STRING
- name: elasticsearch.request.write.version
type: LONG
- name: elasticsearch.response.status
type: LONG
- name: elasticsearch.shard.replication.failed
type: LONG
- name: elasticsearch.shard.replication.successful
type: LONG
- name: elasticsearch.shard.replication.total
type: LONG
- name: elasticsearch.type
type: STRING
- name: elasticsearch.version
type: LONG
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- name: network.type
type: STRING
- when: otel.semconv-stability.opt-in=database
spans:
- span_kind: CLIENT
attributes:
- name: db.operation.name
type: STRING
- name: db.system.name
type: STRING
- name: error.type
type: STRING
- name: network.peer.address
type: STRING
- name: network.peer.port
type: LONG
- name: network.type
type: STRING
executors:
- name: executors
description: |
Expand Down
Loading
Loading