From 450528b9f54eb751077fd24fe1df6c0cbf114d7c Mon Sep 17 00:00:00 2001 From: Willy Tarreau Date: Fri, 22 Nov 2024 16:06:09 +0100 Subject: [PATCH] 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: https://github.com/haproxy/haproxy/issues/2782#issuecomment-2493576327 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. --- addons/ot/README | 6 ++++++ doc/configuration.txt | 7 +++++++ 2 files changed, 13 insertions(+) diff --git a/addons/ot/README b/addons/ot/README index a08f47138..936d11678 100644 --- a/addons/ot/README +++ b/addons/ot/README @@ -47,6 +47,12 @@ via the OpenTracing API with OpenTracing compatible servers (tracers). Currently, tracers that support this API include Datadog, Jaeger, LightStep and Zipkin. +Note: The OpenTracing filter shouldn't be used for new designs as OpenTracing + itself is no longer maintained nor supported by its authors. A + replacement filter base on OpenTelemetry is currently under development + and is expected to be ready around HAProxy 3.2. As such OpenTracing will + be deprecated in 3.3 and removed in 3.5. + The OT filter was primarily tested with the Jaeger tracer, while configurations for both Datadog and Zipkin tracers were also set in the test directory. diff --git a/doc/configuration.txt b/doc/configuration.txt index 5b9bcb199..e4e152f66 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -28490,6 +28490,13 @@ filter opentracing [id ] config More detailed documentation related to the operation, configuration and use of the filter can be found in the addons/ot directory. +Note: The OpenTracing filter shouldn't be used for new designs as OpenTracing + itself is no longer maintained nor supported by its authors. A + replacement filter base on OpenTelemetry is currently under development + and is expected to be ready around HAProxy 3.2. As such OpenTracing will + be deprecated in 3.3 and removed in 3.5. + + 9.7. Bandwidth limitation --------------------------