Skip to content

Commit 6445819

Browse files
authored
[API] Jaeger Propagator should not be deprecated (open-telemetry#3086)
1 parent 3d9c2b5 commit 6445819

File tree

4 files changed

+18
-58
lines changed

4 files changed

+18
-58
lines changed

CHANGELOG.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,20 @@ Increment the:
1515

1616
## [Unreleased]
1717

18+
* [API] Jaeger Propagator should not be deprecated
19+
[#3086](https://github.com/open-telemetry/opentelemetry-cpp/pull/3086)
20+
21+
Important changes:
22+
23+
* [API] Jaeger Propagator should not be deprecated
24+
[#3086](https://github.com/open-telemetry/opentelemetry-cpp/pull/3086)
25+
26+
* Deprecation of the Jaeger propagator, as announced on 2023-01-31
27+
in version 1.8.2, is now reverted.
28+
* This deprecation turned out to be not justified,
29+
as the Jaeger propagator can be used without the (now removed)
30+
Jaeger exporter.
31+
1832
## [1.17 2024-10-07]
1933

2034
* [CI] Add a clang-tidy build

DEPRECATED.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -46,45 +46,7 @@ N/A
4646

4747
## [opentelemetry-cpp API]
4848

49-
### Jaeger propagator
50-
51-
#### Announcement (Jaeger)
52-
53-
* Version: 1.8.2
54-
* Date: 2023-01-31
55-
* PR: [DEPRECATION] Deprecate the Jaeger exporter
56-
[#1923](https://github.com/open-telemetry/opentelemetry-cpp/pull/1923)
57-
58-
This PR also listed the Jaeger propagator as deprecated.
59-
60-
#### Motivation (Jaeger)
61-
62-
The Jaeger Exporter is now (July 2023) removed from the OpenTelemetry specification.
63-
64-
The Jaeger Propagator remains, because changing propagation is a longer
65-
process compared to changing an export format.
66-
67-
New deployments however are encouraged to use a W3C compliant propagator,
68-
and avoid the Jaeger propagator, which is now deprecated.
69-
70-
#### Scope (Jaeger)
71-
72-
The following are deprecated and planned for removal:
73-
74-
* the API header `opentelemetry/trace/propagation/jaeger.h`, including:
75-
* the C++ class `JaegerPropagator`
76-
77-
#### Mitigation (Jaeger)
78-
79-
Use a W3C compliant propagator instead.
80-
81-
That is, use class HttpTraceContext and "traceparent" tags.
82-
83-
Do not use class JaegerPropagator and "uber-trace-id" tags.
84-
85-
#### Planned removal (Jaeger)
86-
87-
No date set yet for the Jaeger Propagator.
49+
N/A
8850

8951
## [opentelemetry-cpp SDK]
9052

api/include/opentelemetry/trace/propagation/jaeger.h

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@
33

44
#pragma once
55

6-
#ifdef OPENTELEMETRY_NO_DEPRECATED_CODE
7-
# error "header <opentelemetry/trace/propagation/jaeger.h> is deprecated."
8-
#endif
9-
106
#include "detail/hex.h"
117
#include "detail/string.h"
128
#include "opentelemetry/context/propagation/text_map_propagator.h"
@@ -21,7 +17,7 @@ namespace propagation
2117

2218
static const nostd::string_view kJaegerTraceHeader = "uber-trace-id";
2319

24-
class OPENTELEMETRY_DEPRECATED JaegerPropagator : public context::propagation::TextMapPropagator
20+
class JaegerPropagator : public context::propagation::TextMapPropagator
2521
{
2622
public:
2723
void Inject(context::propagation::TextMapCarrier &carrier,

api/test/trace/propagation/CMakeLists.txt

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
add_subdirectory(detail)
55

6-
foreach(testname http_text_format_test b3_propagation_test)
6+
foreach(testname http_text_format_test b3_propagation_test
7+
jaeger_propagation_test)
78
add_executable(${testname} "${testname}.cc")
89
target_link_libraries(${testname} ${GTEST_BOTH_LIBRARIES}
910
${CMAKE_THREAD_LIBS_INIT} opentelemetry_api)
@@ -12,16 +13,3 @@ foreach(testname http_text_format_test b3_propagation_test)
1213
TEST_PREFIX trace.
1314
TEST_LIST ${testname})
1415
endforeach()
15-
16-
if(NOT WITH_NO_DEPRECATED_CODE)
17-
foreach(testname jaeger_propagation_test)
18-
19-
add_executable(${testname} "${testname}.cc")
20-
target_link_libraries(${testname} ${GTEST_BOTH_LIBRARIES}
21-
${CMAKE_THREAD_LIBS_INIT} opentelemetry_api)
22-
gtest_add_tests(
23-
TARGET ${testname}
24-
TEST_PREFIX trace.
25-
TEST_LIST ${testname})
26-
endforeach()
27-
endif()

0 commit comments

Comments
 (0)