From 542aabb0843c256282438005cd9219f21845e029 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Mon, 27 Oct 2025 16:41:48 -0400 Subject: [PATCH 1/2] Metadata updates for hibernate and hikari --- docs/instrumentation-list.yaml | 41 ++++++++----------- .../hibernate/hibernate-3.3/metadata.yaml | 10 ++--- .../hibernate/hibernate-4.0/metadata.yaml | 10 ++--- .../hibernate/hibernate-6.0/metadata.yaml | 10 ++--- .../metadata.yaml | 8 ++-- .../hibernate-reactive-1.0/metadata.yaml | 6 ++- instrumentation/hikaricp-3.0/metadata.yaml | 7 +--- 7 files changed, 40 insertions(+), 52 deletions(-) diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index 0592e3c028de..ffcc2d342384 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -4627,9 +4627,8 @@ libraries: type: STRING hibernate: - name: hibernate-3.3 - description: | - This instrumentation enables the generation of spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. - library_link: https://github.com/hibernate/hibernate-orm + description: This instrumentation enables spans for Hibernate ORM operations. + library_link: https://hibernate.org/ source_path: instrumentation/hibernate/hibernate-3.3 scope: name: io.opentelemetry.hibernate-3.3 @@ -4638,8 +4637,7 @@ libraries: - org.hibernate:hibernate-core:[3.3.0.GA,4.0.0.Final) configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes - description: Enables the addition of the experimental `hibernate.session_id` - span attribute. + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean default: false telemetry: @@ -4654,9 +4652,8 @@ libraries: - name: hibernate.session_id type: STRING - name: hibernate-4.0 - description: | - This instrumentation enables the generation of spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. - library_link: https://github.com/hibernate/hibernate-orm + description: This instrumentation enables spans for Hibernate ORM operations. + library_link: https://hibernate.org/ source_path: instrumentation/hibernate/hibernate-4.0 scope: name: io.opentelemetry.hibernate-4.0 @@ -4665,8 +4662,7 @@ libraries: - org.hibernate:hibernate-core:[4.0.0.Final,6) configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes - description: Enables the addition of the experimental `hibernate.session_id` - span attribute. + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean default: false telemetry: @@ -4681,9 +4677,8 @@ libraries: - name: hibernate.session_id type: STRING - name: hibernate-6.0 - description: | - This instrumentation enables the generation of spans for Hibernate operations, including session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. - library_link: https://github.com/hibernate/hibernate-orm + description: This instrumentation enables spans for Hibernate ORM operations. + library_link: https://hibernate.org/ source_path: instrumentation/hibernate/hibernate-6.0 minimum_java_version: 11 scope: @@ -4693,8 +4688,7 @@ libraries: - org.hibernate:hibernate-core:[6.0.0.Final,) configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes - description: Enables the addition of the experimental `hibernate.session_id` - span attribute. + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean default: false telemetry: @@ -4709,9 +4703,9 @@ libraries: - name: hibernate.session_id type: STRING - name: hibernate-procedure-call-4.3 - description: This instrumentation enables the generation of spans for Hibernate - stored procedure calls. - library_link: https://github.com/hibernate/hibernate-orm + description: This instrumentation enables spans for Hibernate stored procedure + calls. + library_link: https://hibernate.org/ source_path: instrumentation/hibernate/hibernate-procedure-call-4.3 scope: name: io.opentelemetry.hibernate-procedure-call-4.3 @@ -4720,8 +4714,7 @@ libraries: - org.hibernate:hibernate-core:[4.3.0.Final,) configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes - description: Enables the addition of the experimental `hibernate.session_id` - span attribute. + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean default: false telemetry: @@ -4737,8 +4730,10 @@ libraries: type: STRING - name: hibernate-reactive-1.0 description: | - This instrumentation does not emit any telemetry on its own. Instead, it enables context propagation for Hibernate Reactive asynchronous operations. + This instrumentation provides context propagation for Hibernate Reactive, it does not emit any telemetry on its own. library_link: https://hibernate.org/reactive/ + features: + - CONTEXT_PROPAGATION source_path: instrumentation/hibernate/hibernate-reactive-1.0 scope: name: io.opentelemetry.hibernate-reactive-1.0 @@ -4748,8 +4743,8 @@ libraries: hikaricp: - name: hikaricp-3.0 display_name: HikariCP - description: | - This instrumentation generates database client metrics for HikariCP connection pools. It reports metrics like connection timeouts, creation time, wait time, and usage time, along with connection pool statistics such as the number of active, idle, and pending connections. + description: This instrumentation generates database connection pool metrics for + HikariCP. semantic_conventions: - DATABASE_POOL_METRICS library_link: https://github.com/brettwooldridge/HikariCP diff --git a/instrumentation/hibernate/hibernate-3.3/metadata.yaml b/instrumentation/hibernate/hibernate-3.3/metadata.yaml index f52782d6060d..de90936d4e8d 100644 --- a/instrumentation/hibernate/hibernate-3.3/metadata.yaml +++ b/instrumentation/hibernate/hibernate-3.3/metadata.yaml @@ -1,9 +1,7 @@ -description: > - This instrumentation enables the generation of spans for Hibernate operations, including - session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. -library_link: https://github.com/hibernate/hibernate-orm +description: This instrumentation enables spans for Hibernate ORM operations. +library_link: https://hibernate.org/ configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean - description: Enables the addition of the experimental `hibernate.session_id` span attribute. - default: false + default: false \ No newline at end of file diff --git a/instrumentation/hibernate/hibernate-4.0/metadata.yaml b/instrumentation/hibernate/hibernate-4.0/metadata.yaml index f52782d6060d..de90936d4e8d 100644 --- a/instrumentation/hibernate/hibernate-4.0/metadata.yaml +++ b/instrumentation/hibernate/hibernate-4.0/metadata.yaml @@ -1,9 +1,7 @@ -description: > - This instrumentation enables the generation of spans for Hibernate operations, including - session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. -library_link: https://github.com/hibernate/hibernate-orm +description: This instrumentation enables spans for Hibernate ORM operations. +library_link: https://hibernate.org/ configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean - description: Enables the addition of the experimental `hibernate.session_id` span attribute. - default: false + default: false \ No newline at end of file diff --git a/instrumentation/hibernate/hibernate-6.0/metadata.yaml b/instrumentation/hibernate/hibernate-6.0/metadata.yaml index f52782d6060d..de90936d4e8d 100644 --- a/instrumentation/hibernate/hibernate-6.0/metadata.yaml +++ b/instrumentation/hibernate/hibernate-6.0/metadata.yaml @@ -1,9 +1,7 @@ -description: > - This instrumentation enables the generation of spans for Hibernate operations, including - session methods (e.g., `save`, `update`, `delete`), transaction commits, and query executions. -library_link: https://github.com/hibernate/hibernate-orm +description: This instrumentation enables spans for Hibernate ORM operations. +library_link: https://hibernate.org/ configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean - description: Enables the addition of the experimental `hibernate.session_id` span attribute. - default: false + default: false \ No newline at end of file diff --git a/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml b/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml index c8a44865f60a..57db87979b9d 100644 --- a/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml +++ b/instrumentation/hibernate/hibernate-procedure-call-4.3/metadata.yaml @@ -1,7 +1,7 @@ -description: This instrumentation enables the generation of spans for Hibernate stored procedure calls. -library_link: https://github.com/hibernate/hibernate-orm +description: This instrumentation enables spans for Hibernate stored procedure calls. +library_link: https://hibernate.org/ configurations: - name: otel.instrumentation.hibernate.experimental-span-attributes + description: Enables the experimental `hibernate.session_id` span attribute. type: boolean - description: Enables the addition of the experimental `hibernate.session_id` span attribute. - default: false + default: false \ No newline at end of file diff --git a/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml b/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml index f385670c021e..e9d51fd28441 100644 --- a/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml +++ b/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml @@ -1,4 +1,6 @@ description: > - This instrumentation does not emit any telemetry on its own. Instead, it enables context - propagation for Hibernate Reactive asynchronous operations. + This instrumentation provides context propagation for Hibernate Reactive, it does not emit any + telemetry on its own. library_link: https://hibernate.org/reactive/ +features: + - CONTEXT_PROPAGATION \ No newline at end of file diff --git a/instrumentation/hikaricp-3.0/metadata.yaml b/instrumentation/hikaricp-3.0/metadata.yaml index 18242ef4fea3..fdf315c870b8 100644 --- a/instrumentation/hikaricp-3.0/metadata.yaml +++ b/instrumentation/hikaricp-3.0/metadata.yaml @@ -1,8 +1,5 @@ display_name: HikariCP -description: > - This instrumentation generates database client metrics for HikariCP connection pools. It - reports metrics like connection timeouts, creation time, wait time, and usage time, along with - connection pool statistics such as the number of active, idle, and pending connections. +description: This instrumentation generates database connection pool metrics for HikariCP. library_link: https://github.com/brettwooldridge/HikariCP semantic_conventions: - - DATABASE_POOL_METRICS + - DATABASE_POOL_METRICS \ No newline at end of file From 171541417f01ec632930e2ec08511f01330cd2c7 Mon Sep 17 00:00:00 2001 From: Jay DeLuca Date: Tue, 28 Oct 2025 05:50:04 -0400 Subject: [PATCH 2/2] be consistent with enables vs generates --- docs/instrumentation-list.yaml | 4 ++-- .../hibernate/hibernate-reactive-1.0/metadata.yaml | 4 ++-- instrumentation/hikaricp-3.0/metadata.yaml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/instrumentation-list.yaml b/docs/instrumentation-list.yaml index ffcc2d342384..5a38e8c34237 100644 --- a/docs/instrumentation-list.yaml +++ b/docs/instrumentation-list.yaml @@ -4730,7 +4730,7 @@ libraries: type: STRING - name: hibernate-reactive-1.0 description: | - This instrumentation provides context propagation for Hibernate Reactive, it does not emit any telemetry on its own. + This instrumentation enables context propagation for Hibernate Reactive, it does not emit any telemetry on its own. library_link: https://hibernate.org/reactive/ features: - CONTEXT_PROPAGATION @@ -4743,7 +4743,7 @@ libraries: hikaricp: - name: hikaricp-3.0 display_name: HikariCP - description: This instrumentation generates database connection pool metrics for + description: This instrumentation enables database connection pool metrics for HikariCP. semantic_conventions: - DATABASE_POOL_METRICS diff --git a/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml b/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml index e9d51fd28441..2f250d365aaa 100644 --- a/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml +++ b/instrumentation/hibernate/hibernate-reactive-1.0/metadata.yaml @@ -1,6 +1,6 @@ description: > - This instrumentation provides context propagation for Hibernate Reactive, it does not emit any + This instrumentation enables context propagation for Hibernate Reactive, it does not emit any telemetry on its own. library_link: https://hibernate.org/reactive/ features: - - CONTEXT_PROPAGATION \ No newline at end of file + - CONTEXT_PROPAGATION diff --git a/instrumentation/hikaricp-3.0/metadata.yaml b/instrumentation/hikaricp-3.0/metadata.yaml index fdf315c870b8..21415cfabed0 100644 --- a/instrumentation/hikaricp-3.0/metadata.yaml +++ b/instrumentation/hikaricp-3.0/metadata.yaml @@ -1,5 +1,5 @@ display_name: HikariCP -description: This instrumentation generates database connection pool metrics for HikariCP. +description: This instrumentation enables database connection pool metrics for HikariCP. library_link: https://github.com/brettwooldridge/HikariCP semantic_conventions: - - DATABASE_POOL_METRICS \ No newline at end of file + - DATABASE_POOL_METRICS