Skip to content

Commit 450528b

Browse files
committed
DOC: ot: mention planned deprecation of the OT filter
Miroslav mentioned below that he's currently working on an OpenTelemetry replacement for the OpenTracing filter since OpenTracing itself is no longer maintained nor supported: haproxy/haproxy#2782 (comment) Given that he aims for 3.2, let's already settle on an upcoming deprecation of the filter for 3.3 with a removal for 3.5. This will leave time to finish the development and permit users to switch smoothly. At this point no warning is emitted (since the users have no alternative) but better mention this plan in the doc to make them aware of future changes.
1 parent 03f57fc commit 450528b

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

addons/ot/README

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ via the OpenTracing API with OpenTracing compatible servers (tracers).
4747
Currently, tracers that support this API include Datadog, Jaeger, LightStep
4848
and Zipkin.
4949

50+
Note: The OpenTracing filter shouldn't be used for new designs as OpenTracing
51+
itself is no longer maintained nor supported by its authors. A
52+
replacement filter base on OpenTelemetry is currently under development
53+
and is expected to be ready around HAProxy 3.2. As such OpenTracing will
54+
be deprecated in 3.3 and removed in 3.5.
55+
5056
The OT filter was primarily tested with the Jaeger tracer, while configurations
5157
for both Datadog and Zipkin tracers were also set in the test directory.
5258

doc/configuration.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28490,6 +28490,13 @@ filter opentracing [id <id>] config <file>
2849028490
More detailed documentation related to the operation, configuration and use
2849128491
of the filter can be found in the addons/ot directory.
2849228492

28493+
Note: The OpenTracing filter shouldn't be used for new designs as OpenTracing
28494+
itself is no longer maintained nor supported by its authors. A
28495+
replacement filter base on OpenTelemetry is currently under development
28496+
and is expected to be ready around HAProxy 3.2. As such OpenTracing will
28497+
be deprecated in 3.3 and removed in 3.5.
28498+
28499+
2849328500
9.7. Bandwidth limitation
2849428501
--------------------------
2849528502

0 commit comments

Comments
 (0)