Skip to content

Dropwizard and Elasticsearch metadata updates #15108

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 1 commit into from
Oct 23, 2025
Merged

Dropwizard and Elasticsearch metadata updates #15108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 23 additions & 3 deletions docs/instrumentation-list.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3122,9 +3122,11 @@ libraries:
type: boolean
default: false
- name: dropwizard-views-0.7
description: This instrumentation enables the creation of spans for Dropwizard
views.
description: |
This instrumentation enables view spans for Dropwizard view template rendering (view spans are disabled by default).
library_link: https://www.dropwizard.io/en/latest/manual/views.html
features:
- VIEW_SPANS
source_path: instrumentation/dropwizard/dropwizard-views-0.7
scope:
name: io.opentelemetry.dropwizard-views-0.7
Expand All @@ -3144,7 +3146,7 @@ libraries:
elasticsearch:
- name: elasticsearch-api-client-7.16
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the supported libraries page lists this one with Elasticsearch Client Spans, but I didn't add it because this instrumentation doesn't technically generate those spans. Curious if others have thoughts about whether it should be included anyway?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would be best if we could update our instrumentation to conform with the semantic conventions

description: |
This instrumentation extends the elasticsearch-rest-7.0 instrumentation by adding additional `db.elasticsearch.path_parts.id` and `db.elasticsearch.path_parts.index` attributes to Elasticsearch database client spans. Versions 8.10 and later of the client have native support for OpenTelemetry.
This instrumentation enriches Elasticsearch database client spans generated by the elasticsearch-rest-7.0 instrumentation by adding `db.elasticsearch.path_parts.id` and `db.elasticsearch.path_parts.index` attributes. It does not emit any telemetry on its own. Versions 8.10 and later of the Elasticsearch Java client have native OpenTelemetry support.
library_link: https://www.elastic.co/docs/reference/elasticsearch/clients/java
source_path: instrumentation/elasticsearch/elasticsearch-api-client-7.16
scope:
Expand Down Expand Up @@ -3211,6 +3213,9 @@ libraries:
- name: elasticsearch-rest-5.0
description: This instrumentation enables database client spans and database client
metrics for Elasticsearch REST clients.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
source_path: instrumentation/elasticsearch/elasticsearch-rest-5.0
scope:
Expand Down Expand Up @@ -3274,6 +3279,9 @@ libraries:
- name: elasticsearch-rest-6.4
description: This instrumentation enables database client spans and database client
metrics for Elasticsearch REST clients.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
source_path: instrumentation/elasticsearch/elasticsearch-rest-6.4
scope:
Expand Down Expand Up @@ -3336,6 +3344,9 @@ libraries:
- name: elasticsearch-rest-7.0
description: This instrumentation enables database client spans and database client
metrics for Elasticsearch REST clients.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
source_path: instrumentation/elasticsearch/elasticsearch-rest-7.0
scope:
Expand Down Expand Up @@ -3400,6 +3411,9 @@ libraries:
- name: elasticsearch-transport-5.0
description: |
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.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.0
scope:
Expand Down Expand Up @@ -3493,6 +3507,9 @@ libraries:
- name: elasticsearch-transport-5.3
description: |
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.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
source_path: instrumentation/elasticsearch/elasticsearch-transport-5.3
scope:
Expand Down Expand Up @@ -3591,6 +3608,9 @@ libraries:
- name: elasticsearch-transport-6.0
description: |
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.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
source_path: instrumentation/elasticsearch/elasticsearch-transport-6.0
scope:
Expand Down
6 changes: 5 additions & 1 deletion instrumentation/dropwizard/dropwizard-views-0.7/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
description: This instrumentation enables the creation of spans for Dropwizard views.
description: >
This instrumentation enables view spans for Dropwizard view template rendering
(view spans are disabled by default).
features:
- VIEW_SPANS
library_link: https://www.dropwizard.io/en/latest/manual/views.html
configurations:
- name: otel.instrumentation.common.experimental.view-telemetry.enabled
Expand Down
8 changes: 4 additions & 4 deletions instrumentation/elasticsearch/elasticsearch-api-client-7.16/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
description: >
This instrumentation extends the elasticsearch-rest-7.0 instrumentation by adding
additional `db.elasticsearch.path_parts.id` and `db.elasticsearch.path_parts.index` attributes to
Elasticsearch database client spans. Versions 8.10 and later of the client have native support for
OpenTelemetry.
This instrumentation enriches Elasticsearch database client spans generated by the
elasticsearch-rest-7.0 instrumentation by adding `db.elasticsearch.path_parts.id` and
`db.elasticsearch.path_parts.index` attributes. It does not emit any telemetry on its own.
Versions 8.10 and later of the Elasticsearch Java client have native OpenTelemetry support.
library_link: https://www.elastic.co/docs/reference/elasticsearch/clients/java
3 changes: 3 additions & 0 deletions instrumentation/elasticsearch/elasticsearch-rest-5.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
configurations:
- name: otel.instrumentation.elasticsearch.capture-search-query
Expand Down
3 changes: 3 additions & 0 deletions instrumentation/elasticsearch/elasticsearch-rest-6.4/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
configurations:
- name: otel.instrumentation.elasticsearch.capture-search-query
Expand Down
3 changes: 3 additions & 0 deletions instrumentation/elasticsearch/elasticsearch-rest-7.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
description: This instrumentation enables database client spans and database client metrics for Elasticsearch REST clients.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-rest
configurations:
- name: otel.instrumentation.elasticsearch.capture-search-query
Expand Down
3 changes: 3 additions & 0 deletions instrumentation/elasticsearch/elasticsearch-transport-5.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ description: >
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.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
Expand Down
3 changes: 3 additions & 0 deletions instrumentation/elasticsearch/elasticsearch-transport-5.3/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ description: >
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.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
Expand Down
3 changes: 3 additions & 0 deletions instrumentation/elasticsearch/elasticsearch-transport-6.0/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ description: >
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.
semantic_conventions:
- DATABASE_CLIENT_SPANS
- DATABASE_CLIENT_METRICS
library_link: https://www.elastic.co/guide/en/elasticsearch/client/java-api/
configurations:
- name: otel.instrumentation.elasticsearch.experimental-span-attributes
Expand Down
Loading