open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add placeholder for database stability transition plan (#733) 

Co-authored-by: Joao Grassi <joao.grassi@dynatrace.com>
This commit is contained in:
Trask Stalnaker 2024-02-12 06:08:27 -08:00 committed by GitHub
parent b6afdeb6ee
commit 183647b9e5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/database/README.md
View File

@ -12,6 +12,13 @@ path_base_for_github_subdir:
This document defines semantic conventions for database client spans as well as This document defines semantic conventions for database client spans as well as
database metrics and logs. database metrics and logs.
> **Warning**
> Existing database instrumentations that are using
> [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/README.md)
> (or prior) SHOULD NOT change the version of the database conventions that they emit
> until a transition plan to the (future) stable semantic conventions has been published.
> Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
Semantic conventions for database operations are defined for the following signals: Semantic conventions for database operations are defined for the following signals:
* [DB Spans](database-spans.md): Semantic Conventions for database client *spans*. * [DB Spans](database-spans.md): Semantic Conventions for database client *spans*.

7
docs/database/database-metrics.md
View File

@ -28,6 +28,13 @@ and attributes but more may be added in the future.
<!-- tocstop --> <!-- tocstop -->
> **Warning**
> Existing database instrumentations that are using
> [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-metrics.md)
> (or prior) SHOULD NOT change the version of the database conventions that they emit
> until a transition plan to the (future) stable semantic conventions has been published.
> Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
## Connection pools ## Connection pools
The following metric instruments describe database client connection pool operations. The following metric instruments describe database client connection pool operations.

7
docs/database/database-spans.md
View File

@ -17,6 +17,13 @@ linkTitle: Client Calls
<!-- tocstop --> <!-- tocstop -->
> **Warning**
> Existing database instrumentations that are using
> [v1.24.0 of this document](https://github.com/open-telemetry/semantic-conventions/blob/v1.24.0/docs/database/database-spans.md)
> (or prior) SHOULD NOT change the version of the database conventions that they emit
> until a transition plan to the (future) stable semantic conventions has been published.
> Conventions include, but are not limited to, attributes, metric and span names, and unit of measure.
>
> **Warning** > **Warning**
> Existing Database instrumentations that are using > Existing Database instrumentations that are using
> [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/database.md) > [v1.20.0 of this document](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/semantic_conventions/database.md)