Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 12 additions & 12 deletions docs/database/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,25 @@ database metrics and logs.
> [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 by default
> until the database semantic conventions are marked stable.
> Conventions include, but are not limited to, attributes,
> metric and span names, and unit of measure.
> * SHOULD NOT change the version of the database conventions that they emit by
> default in their existing major version. Conventions include (but are not
> limited to) attributes, metric and span names, and unit of measure.
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version as a comma-separated list of category-specific values
> in their existing major version as a comma-separated list of category-specific values
> (e.g., http, databases, messaging). The list of values includes:
> * `database` - emit the new, stable database conventions,
> and stop emitting the old experimental database conventions
> that the instrumentation emitted previously.
> * `database/dup` - emit both the old and the stable database conventions,
> allowing for a seamless transition.
> * `database` - emit the stable database conventions, and stop emitting
> the experimental database conventions that the instrumentation emitted
> previously.
> * `database/dup` - emit both the experimental and stable database conventions,
> allowing for a phased rollout of the stable semantic conventions.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental database conventions
> the instrumentation was emitting previously.
> * Note: `database/dup` has higher precedence than `database` in case both values are present
> * SHOULD maintain (security patching at a minimum) the existing major version
> * SHOULD maintain (security patching at a minimum) their existing major version
> for at least six months after it starts emitting both sets of conventions.
> * SHOULD drop the environment variable in the next major version.
> * MAY drop the environment variable in their next major version and emit only
> the stable database conventions.

Semantic conventions for database operations are defined for the following signals:

Expand Down
24 changes: 12 additions & 12 deletions docs/database/database-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,25 +32,25 @@ linkTitle: Metrics
> [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 by default
> until the database semantic conventions are marked stable.
> Conventions include, but are not limited to, attributes,
> metric and span names, and unit of measure.
> * SHOULD NOT change the version of the database conventions that they emit by
> default in their existing major version. Conventions include (but are not
> limited to) attributes, metric and span names, and unit of measure.
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version as a comma-separated list of category-specific values
> in their existing major version as a comma-separated list of category-specific values
> (e.g., http, databases, messaging). The list of values includes:
> * `database` - emit the new, stable database conventions,
> and stop emitting the old experimental database conventions
> that the instrumentation emitted previously.
> * `database/dup` - emit both the old and the stable database conventions,
> allowing for a seamless transition.
> * `database` - emit the stable database conventions, and stop emitting
> the experimental database conventions that the instrumentation emitted
> previously.
> * `database/dup` - emit both the experimental and stable database conventions,
> allowing for a phased rollout of the stable semantic conventions.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental database conventions
> the instrumentation was emitting previously.
> * Note: `database/dup` has higher precedence than `database` in case both values are present
> * SHOULD maintain (security patching at a minimum) the existing major version
> * SHOULD maintain (security patching at a minimum) their existing major version
> for at least six months after it starts emitting both sets of conventions.
> * SHOULD drop the environment variable in the next major version.
> * MAY drop the environment variable in their next major version and emit only
> the stable database conventions.

## Database operation

Expand Down
24 changes: 12 additions & 12 deletions docs/database/database-spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,25 @@ linkTitle: Spans
> [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 by default
> until the database semantic conventions are marked stable.
> Conventions include, but are not limited to, attributes,
> metric and span names, and unit of measure.
> * SHOULD NOT change the version of the database conventions that they emit by
> default in their existing major version. Conventions include (but are not
> limited to) attributes, metric and span names, and unit of measure.
> * SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN`
> in the existing major version as a comma-separated list of category-specific values
> in their existing major version as a comma-separated list of category-specific values
> (e.g., http, databases, messaging). The list of values includes:
> * `database` - emit the new, stable database conventions,
> and stop emitting the old experimental database conventions
> that the instrumentation emitted previously.
> * `database/dup` - emit both the old and the stable database conventions,
> allowing for a seamless transition.
> * `database` - emit the stable database conventions, and stop emitting
> the experimental database conventions that the instrumentation emitted
> previously.
> * `database/dup` - emit both the experimental and stable database conventions,
> allowing for a phased rollout of the stable semantic conventions.
> * The default behavior (in the absence of one of these values) is to continue
> emitting whatever version of the old experimental database conventions
> the instrumentation was emitting previously.
> * Note: `database/dup` has higher precedence than `database` in case both values are present
> * SHOULD maintain (security patching at a minimum) the existing major version
> * SHOULD maintain (security patching at a minimum) their existing major version
> for at least six months after it starts emitting both sets of conventions.
> * SHOULD drop the environment variable in the next major version.
> * MAY drop the environment variable in their next major version and emit only
> the stable database conventions.

## Name

Expand Down
3 changes: 3 additions & 0 deletions docs/non-normative/db-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ transitioning to the stable database semantic conventions.
Specifically, when existing database instrumentations published by OpenTelemetry are
updated to the stable database semantic conventions, they:

- SHOULD NOT change the version of the database conventions that they emit by
default in their existing major version. Conventions include (but are not
limited to) attributes, metric and span names, and unit of measure.
- SHOULD introduce an environment variable `OTEL_SEMCONV_STABILITY_OPT_IN` in
their existing major version, which accepts:
- `database` - emit the stable database conventions, and stop emitting
Expand Down
Loading