tracing: Deprecate OpenTracing (envoyproxy#28987)

* Deprecate OpenTracing * Change security_posture to `unknown`. The OT extension is no longer covered by security process. --------- Signed-off-by: Ryan Hamilton <rch@google.com>
phlax · Aug 16, 2023 · 494c716 · 494c716
1 parent c33afb4
commit 494c716
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 4 deletions.
diff --git a/api/envoy/config/trace/v3/dynamic_ot.proto b/api/envoy/config/trace/v3/dynamic_ot.proto
@@ -4,6 +4,7 @@ package envoy.config.trace.v3;
 
 import "google/protobuf/struct.proto";
 
+import "envoy/annotations/deprecation.proto";
 import "udpa/annotations/migrate.proto";
 import "udpa/annotations/status.proto";
 import "udpa/annotations/versioning.proto";
@@ -29,9 +30,14 @@ message DynamicOtConfig {
 
   // Dynamic library implementing the `OpenTracing API
   // <https://github.com/opentracing/opentracing-cpp>`_.
-  string library = 1 [(validate.rules).string = {min_len: 1}];
+  string library = 1 [
+    deprecated = true,
+    (validate.rules).string = {min_len: 1},
+    (envoy.annotations.deprecated_at_minor_version) = "3.0"
+  ];
 
   // The configuration to use when creating a tracer from the given dynamic
   // library.
-  google.protobuf.Struct config = 2;
+  google.protobuf.Struct config = 2
+      [deprecated = true, (envoy.annotations.deprecated_at_minor_version) = "3.0"];
 }
diff --git a/changelogs/current.yaml b/changelogs/current.yaml
@@ -2,6 +2,10 @@ date: Pending
 
 behavior_changes:
 # *Changes that are expected to cause an incompatibility if applicable; deployment changes are likely required*
+- area: tracing
+  change: |
+    OpenTracing is now deprecated since the upstream project has been abandoned.
+
 - area: eds
   change: |
     Introduced caching of EDS assignments when used with ADS. Prior to this change, Envoy required that EDS assignments were sent

diff --git a/source/extensions/extensions_metadata.yaml b/source/extensions/extensions_metadata.yaml
@@ -1105,7 +1105,7 @@ envoy.tracers.datadog:
 envoy.tracers.dynamic_ot:
   categories:
   - envoy.tracers
-  security_posture: robust_to_untrusted_downstream
+  security_posture: unknown
   status: stable
   type_urls:
   - envoy.config.trace.v3.DynamicOtConfig

diff --git a/test/extensions/tracers/dynamic_ot/config_test.cc b/test/extensions/tracers/dynamic_ot/config_test.cc
@@ -22,7 +22,7 @@ namespace Tracers {
 namespace DynamicOt {
 namespace {
 
-TEST(DynamicOtTracerConfigTest, DynamicOpentracingHttpTracer) {
+TEST(DynamicOtTracerConfigTest, DEPRECATED_FEATURE_TEST(DynamicOpentracingHttpTracer)) {
   NiceMock<Server::Configuration::MockTracerFactoryContext> context;
   EXPECT_CALL(context.server_factory_context_.cluster_manager_,
               getThreadLocalCluster(Eq("fake_cluster")))