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
40 changes: 40 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,46 @@ Increment the:
* [BUILD] Upgrade opentelemetry-proto to 1.7.0
[#3443](https://github.com/open-telemetry/opentelemetry-cpp/pull/3443)

* [REMOVAL] Removed deprecated semantic convention header files
[#3475](https://github.com/open-telemetry/opentelemetry-cpp/pull/3475)

Important changes:

* [REMOVAL] Removed deprecated semantic convention header files
[#3475](https://github.com/open-telemetry/opentelemetry-cpp/pull/3475)

* Old semantic conventions header files have been removed,
per announcement from Nov 9, 2024, see
[#3105](https://github.com/open-telemetry/opentelemetry-cpp/pull/3105)

* Mitigation steps are repeated below, for convenience.

* Two things have changed:

* the header file to use
* the symbol name to use.

Before, the semantic convention for `url.full` was:

* declared in file `semantic_conventions.h`
* declared as symbol `SemanticConventions::kUrlFull`

Now, the `url.full` convention, which is part or the `url` group, is:

* declared in file `semconv/url_attributes.h`
* declared as symbol `semconv::url::kUrlFull`

Application code that uses semantic conventions must be adjusted
accordingly.

In addition, semantic conventions that are not marked as stable
are generated in a different header file, placed under directory
`incubating`, to better separate stable and non stable code.

For example, file `semconv/incubating/url_attributes.h`
defines `semconv::url::kUrlDomain`,
which is not marked as stable in semconv v1.27.0

## [1.21 2025-05-28]

* [BUILD] Remove WITH_ABSEIL
Expand Down
76 changes: 1 addition & 75 deletions DEPRECATED.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,78 +62,4 @@ N/A

## Semantic conventions

### Header files "semantic_conventions.h"

#### Announcement (semantic_conventions.h)

Deprecation is announced as part of the migration to weaver:

* `Version:` release following opentelemetry-cpp 1.17.0
* `Date:` Nov 9, 2024
* `PR:` [PR 3105](https://github.com/open-telemetry/opentelemetry-cpp/pull/3105)

#### Motivation (semantic_conventions.h)

The header files for semantic conventions are generated automatically.
The tooling to generate these files is changing:

* before, the build-tool repository was used
* now, the weaver repository is used

Changes in tooling allows to generate code that is better organized,
with dedicated header files per group of semantic conventions,
instead of a single header file for everything.

#### Scope (semantic_conventions.h)

The following files:

* `api/include/opentelemetry/trace/semantic_conventions.h`
* `sdk/include/opentelemetry/sdk/resource/semantic_conventions.h`

are now deprecated.

They correspond to semantic conventions v1.27.0,
and will no longer be maintained up to date.

These files will be removed in the future.

#### Mitigation (semantic_conventions.h)

Two things have changed:

* the header file to use
* the symbol name to use.

Before, the semantic convention for `url.full` was:

* declared in file `semantic_conventions.h`
* declared as symbol `SemanticConventions::kUrlFull`

Now, the `url.full` convention, which is part or the `url` group, is:

* declared in file `semconv/url_attributes.h`
* declared as symbol `semconv::url::kUrlFull`

Application code that uses semantic conventions must be adjusted
accordingly.

In addition, semantic conventions that are not marked as stable
are generated in a different header file, placed under directory
`incubating`, to better separate stable and non stable code.

For example, file `semconv/incubating/url_attributes.h`
defines `semconv::url::kUrlDomain`,
which is not marked as stable in semconv v1.27.0

#### Planned removal (semantic_conventions.h)

The following files:

* `api/include/opentelemetry/trace/semantic_conventions.h`
* `sdk/include/opentelemetry/sdk/resource/semantic_conventions.h`

will be removed.

The removal date is planned for July 1, 2025.
This allows more than six months for applications to adjust.
N/A
Loading
Loading