Skip to content

tracing: Deprecate OpenTracing #28987

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yanavlasov merged 6 commits into from
Aug 16, 2023
Merged

tracing: Deprecate OpenTracing #28987

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
eb7d249
Deprecate OpenTracing
RyanTheOptimist Aug 11, 2023
4fa6849
security_posture: unknown
RyanTheOptimist Aug 11, 2023
68cd2ed
proto
RyanTheOptimist Aug 11, 2023
9debb03
DEPRECATED_FEATURE_TEST
RyanTheOptimist Aug 12, 2023
c4f2db3
Revert log
RyanTheOptimist Aug 14, 2023
29a734c
Merge branch 'main' into DeprecateOT
RyanTheOptimist Aug 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions api/envoy/config/trace/v3/dynamic_ot.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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";
Expand All @@ -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,

@htuch htuch Aug 14, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An observation is that we could set a message-level deprecated annotation, but I'm guessing we would have to update some of the code for warning on this use of deprecated. Not strictly needed here, as to use this filter you need to set some stuff. But, for an empty filter config it would be needed in the future.

@RyanTheOptimist RyanTheOptimist Aug 14, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I had exactly the same thought. I'm inclined to leave that out of this PR and address it if/when we have an empty filter config to deprecate.

(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"];
}
3 changes: 3 additions & 0 deletions changelogs/current.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ 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.

minor_behavior_changes:
# *Changes that may cause incompatibilities for some users, but should not for most*
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/extensions_metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions source/extensions/tracers/dynamic_ot/config.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ DynamicOpenTracingTracerFactory::DynamicOpenTracingTracerFactory()
Tracing::DriverSharedPtr DynamicOpenTracingTracerFactory::createTracerDriverTyped(
const envoy::config::trace::v3::DynamicOtConfig& proto_config,
Server::Configuration::TracerFactoryContext& context) {
ENVOY_LOG_MISC(warn, "OpenTracing is deprecated and will be removed soon.");

@htuch htuch Aug 14, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be generated anyway via the use of the deprecated proto fields?

@RyanTheOptimist RyanTheOptimist Aug 14, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, fair point. I think I misread the suggestion on slack as saying we needed an explicit log in the factory. Reverted.


const std::string& library = proto_config.library();
const ProtobufWkt::Struct& config_struct = proto_config.config();
absl::StatusOr<std::string> json_or_error = MessageUtil::getJsonStringFromMessage(config_struct);
Expand Down
2 changes: 1 addition & 1 deletion test/extensions/tracers/dynamic_ot/config_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")))
Expand Down