Skip to content

Commit 021490e

Browse files
authored
[REMOVAL] Removed deprecated semantic convention header files. (#3475)
1 parent 3d901a8 commit 021490e

File tree

5 files changed

+74
-10342
lines changed

5 files changed

+74
-10342
lines changed

CHANGELOG.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,46 @@ Increment the:
2727
* [BUILD] Upgrade opentelemetry-proto to 1.7.0
2828
[#3443](https://github.com/open-telemetry/opentelemetry-cpp/pull/3443)
2929

30+
* [REMOVAL] Removed deprecated semantic convention header files
31+
[#3475](https://github.com/open-telemetry/opentelemetry-cpp/pull/3475)
32+
33+
Important changes:
34+
35+
* [REMOVAL] Removed deprecated semantic convention header files
36+
[#3475](https://github.com/open-telemetry/opentelemetry-cpp/pull/3475)
37+
38+
* Old semantic conventions header files have been removed,
39+
per announcement from Nov 9, 2024, see
40+
[#3105](https://github.com/open-telemetry/opentelemetry-cpp/pull/3105)
41+
42+
* Mitigation steps are repeated below, for convenience.
43+
44+
* Two things have changed:
45+
46+
* the header file to use
47+
* the symbol name to use.
48+
49+
Before, the semantic convention for `url.full` was:
50+
51+
* declared in file `semantic_conventions.h`
52+
* declared as symbol `SemanticConventions::kUrlFull`
53+
54+
Now, the `url.full` convention, which is part or the `url` group, is:
55+
56+
* declared in file `semconv/url_attributes.h`
57+
* declared as symbol `semconv::url::kUrlFull`
58+
59+
Application code that uses semantic conventions must be adjusted
60+
accordingly.
61+
62+
In addition, semantic conventions that are not marked as stable
63+
are generated in a different header file, placed under directory
64+
`incubating`, to better separate stable and non stable code.
65+
66+
For example, file `semconv/incubating/url_attributes.h`
67+
defines `semconv::url::kUrlDomain`,
68+
which is not marked as stable in semconv v1.27.0
69+
3070
## [1.21 2025-05-28]
3171

3272
* [BUILD] Remove WITH_ABSEIL

DEPRECATED.md

Lines changed: 1 addition & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -62,78 +62,4 @@ N/A
6262

6363
## Semantic conventions
6464

65-
### Header files "semantic_conventions.h"
66-
67-
#### Announcement (semantic_conventions.h)
68-
69-
Deprecation is announced as part of the migration to weaver:
70-
71-
* `Version:` release following opentelemetry-cpp 1.17.0
72-
* `Date:` Nov 9, 2024
73-
* `PR:` [PR 3105](https://github.com/open-telemetry/opentelemetry-cpp/pull/3105)
74-
75-
#### Motivation (semantic_conventions.h)
76-
77-
The header files for semantic conventions are generated automatically.
78-
The tooling to generate these files is changing:
79-
80-
* before, the build-tool repository was used
81-
* now, the weaver repository is used
82-
83-
Changes in tooling allows to generate code that is better organized,
84-
with dedicated header files per group of semantic conventions,
85-
instead of a single header file for everything.
86-
87-
#### Scope (semantic_conventions.h)
88-
89-
The following files:
90-
91-
* `api/include/opentelemetry/trace/semantic_conventions.h`
92-
* `sdk/include/opentelemetry/sdk/resource/semantic_conventions.h`
93-
94-
are now deprecated.
95-
96-
They correspond to semantic conventions v1.27.0,
97-
and will no longer be maintained up to date.
98-
99-
These files will be removed in the future.
100-
101-
#### Mitigation (semantic_conventions.h)
102-
103-
Two things have changed:
104-
105-
* the header file to use
106-
* the symbol name to use.
107-
108-
Before, the semantic convention for `url.full` was:
109-
110-
* declared in file `semantic_conventions.h`
111-
* declared as symbol `SemanticConventions::kUrlFull`
112-
113-
Now, the `url.full` convention, which is part or the `url` group, is:
114-
115-
* declared in file `semconv/url_attributes.h`
116-
* declared as symbol `semconv::url::kUrlFull`
117-
118-
Application code that uses semantic conventions must be adjusted
119-
accordingly.
120-
121-
In addition, semantic conventions that are not marked as stable
122-
are generated in a different header file, placed under directory
123-
`incubating`, to better separate stable and non stable code.
124-
125-
For example, file `semconv/incubating/url_attributes.h`
126-
defines `semconv::url::kUrlDomain`,
127-
which is not marked as stable in semconv v1.27.0
128-
129-
#### Planned removal (semantic_conventions.h)
130-
131-
The following files:
132-
133-
* `api/include/opentelemetry/trace/semantic_conventions.h`
134-
* `sdk/include/opentelemetry/sdk/resource/semantic_conventions.h`
135-
136-
will be removed.
137-
138-
The removal date is planned for July 1, 2025.
139-
This allows more than six months for applications to adjust.
65+
N/A

0 commit comments

Comments
 (0)