Skip to content
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

Jump to bottom

Cleanup: Remove useless const in tracing interface. #30201

Merged
merged 2 commits into from
Oct 13, 2023
Merged

Cleanup: Remove useless const in tracing interface. #30201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
adb86d6
Clean up: tracing interface is passing the tracing decision by value.
KBaichoo Oct 13, 2023
7c68d01
Fmt.
KBaichoo Oct 13, 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
2 changes: 1 addition & 1 deletion envoy/tracing/trace_driver.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ class Driver {
virtual SpanPtr startSpan(const Config& config, TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) PURE;
Tracing::Decision tracing_decision) PURE;
};

using DriverPtr = std::unique_ptr<Driver>;
Expand Down
2 changes: 1 addition & 1 deletion envoy/tracing/tracer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Tracer {

virtual SpanPtr startSpan(const Config& config, TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const Tracing::Decision tracing_decision) PURE;
Tracing::Decision tracing_decision) PURE;
};

using TracerSharedPtr = std::shared_ptr<Tracer>;
Expand Down
4 changes: 2 additions & 2 deletions source/common/tracing/tracer_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ class NullTracer : public Tracer {
public:
// Tracing::Tracer
SpanPtr startSpan(const Config&, TraceContext&, const StreamInfo::StreamInfo&,
const Tracing::Decision) override {
Tracing::Decision) override {
return SpanPtr{new NullSpan()};
}
};
Expand All @@ -77,7 +77,7 @@ class TracerImpl : public Tracer {
// Tracing::Tracer
SpanPtr startSpan(const Config& config, TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

DriverSharedPtr driverForTest() const { return driver_; }

Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/common/ot/opentracing_driver_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Tracing::SpanPtr OpenTracingDriver::startSpan(const Tracing::Config& config,
Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) {
Tracing::Decision tracing_decision) {
const PropagationMode propagation_mode = this->propagationMode();
const opentracing::Tracer& tracer = this->tracer();
std::unique_ptr<opentracing::Span> active_span;
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/common/ot/opentracing_driver_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class OpenTracingDriver : public Tracing::Driver, protected Logger::Loggable<Log
Tracing::SpanPtr startSpan(const Tracing::Config& config, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

virtual opentracing::Tracer& tracer() PURE;

Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/datadog/tracer.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Tracer::Tracer(const std::string& collector_cluster, const std::string& collecto
Tracing::SpanPtr Tracer::startSpan(const Tracing::Config&, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) {
Tracing::Decision tracing_decision) {
ThreadLocalTracer& thread_local_tracer = **thread_local_slot_;
if (!thread_local_tracer.tracer) {
return std::make_unique<Tracing::NullSpan>();
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/datadog/tracer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ class Tracer : public Tracing::Driver, private Logger::Loggable<Logger::Id::trac
Tracing::SpanPtr startSpan(const Tracing::Config& config, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

private:
TracerStats tracer_stats_;
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/opencensus/opencensus_tracer_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ Tracing::SpanPtr Driver::startSpan(const Tracing::Config& config,
Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) {
Tracing::Decision tracing_decision) {
return std::make_unique<Span>(config, oc_config_, trace_context, operation_name,
stream_info.startTime(), tracing_decision);
}
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/opencensus/opencensus_tracer_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class Driver : public Tracing::Driver, Logger::Loggable<Logger::Id::tracing> {
Tracing::SpanPtr startSpan(const Tracing::Config& config, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

private:
void applyTraceConfig(const opencensus::proto::trace::v1::TraceConfig& config);
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/opentelemetry/opentelemetry_tracer_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Tracing::SpanPtr Driver::startSpan(const Tracing::Config& config,
Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) {
Tracing::Decision tracing_decision) {
// Get tracer from TLS and start span.
auto& tracer = tls_slot_ptr_->getTyped<Driver::TlsTracer>().tracer();
SpanContextExtractor extractor(trace_context);
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/opentelemetry/opentelemetry_tracer_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class Driver : Logger::Loggable<Logger::Id::tracing>, public Tracing::Driver {
Tracing::SpanPtr startSpan(const Tracing::Config& config, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

private:
class TlsTracer : public ThreadLocal::ThreadLocalObject {
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/opentelemetry/tracer.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ void Tracer::sendSpan(::opentelemetry::proto::trace::v1::Span& span) {
}

Tracing::SpanPtr Tracer::startSpan(const Tracing::Config& config, const std::string& operation_name,
SystemTime start_time, const Tracing::Decision tracing_decision,
SystemTime start_time, Tracing::Decision tracing_decision,
bool downstream_span) {
// Create an Tracers::OpenTelemetry::Span class that will contain the OTel span.
Span new_span(config, operation_name, start_time, time_source_, *this, downstream_span);
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/opentelemetry/tracer.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class Tracer : Logger::Loggable<Logger::Id::tracing> {
void sendSpan(::opentelemetry::proto::trace::v1::Span& span);

Tracing::SpanPtr startSpan(const Tracing::Config& config, const std::string& operation_name,
SystemTime start_time, const Tracing::Decision tracing_decision,
SystemTime start_time, Tracing::Decision tracing_decision,
bool downstream_span = true);

Tracing::SpanPtr startSpan(const Tracing::Config& config, const std::string& operation_name,
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/skywalking/skywalking_tracer_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Driver::Driver(const envoy::config::trace::v3::SkyWalkingConfig& proto_config,

Tracing::SpanPtr Driver::startSpan(const Tracing::Config&, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo&, const std::string&,
const Tracing::Decision decision) {
Tracing::Decision decision) {
auto& tracer = tls_slot_ptr_->getTyped<Driver::TlsTracer>().tracer();
TracingContextPtr tracing_context;
// TODO(shikugawa): support extension span header.
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/skywalking/skywalking_tracer_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class Driver : public Tracing::Driver, public Logger::Loggable<Logger::Id::traci
Tracing::SpanPtr startSpan(const Tracing::Config& config, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

private:
void loadConfig(const envoy::config::trace::v3::ClientConfig& client_config,
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/xray/xray_tracer_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Tracing::SpanPtr Driver::startSpan(const Tracing::Config& config,
Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) {
Tracing::Decision tracing_decision) {
// First thing is to determine whether this request will be sampled or not.
// if there's a X-Ray header and it has a sampling decision already determined (i.e. Sample=1)
// then we can move on; otherwise, we ask the sampling strategy whether this request should be
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/xray/xray_tracer_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class Driver : public Tracing::Driver, public Logger::Loggable<Logger::Id::traci
Tracing::SpanPtr startSpan(const Tracing::Config& config, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

private:
struct TlsTracer : ThreadLocal::ThreadLocalObject {
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/zipkin/zipkin_tracer_impl.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Driver::Driver(const envoy::config::trace::v3::ZipkinConfig& zipkin_config,
Tracing::SpanPtr Driver::startSpan(const Tracing::Config& config,
Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info, const std::string&,
const Tracing::Decision tracing_decision) {
Tracing::Decision tracing_decision) {
Tracer& tracer = *tls_->getTyped<TlsTracer>().tracer_;
SpanPtr new_zipkin_span;
SpanContextExtractor extractor(trace_context);
Expand Down
2 changes: 1 addition & 1 deletion source/extensions/tracers/zipkin/zipkin_tracer_impl.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ class Driver : public Tracing::Driver {
Tracing::SpanPtr startSpan(const Tracing::Config& config, Tracing::TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const std::string& operation_name,
const Tracing::Decision tracing_decision) override;
Tracing::Decision tracing_decision) override;

// Getters to return the ZipkinDriver's key members.
Upstream::ClusterManager& clusterManager() { return cm_; }
Expand Down
2 changes: 1 addition & 1 deletion test/common/tracing/tracer_manager_impl_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace {
class SampleDriver : public Driver {
public:
SpanPtr startSpan(const Config&, Tracing::TraceContext&, const StreamInfo::StreamInfo&,
const std::string&, const Tracing::Decision) override {
const std::string&, Tracing::Decision) override {
return nullptr;
}
};
Expand Down
9 changes: 4 additions & 5 deletions test/mocks/tracing/mocks.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,13 @@ class MockTracer : public Tracer {

SpanPtr startSpan(const Config& config, TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const Tracing::Decision tracing_decision) override {
Tracing::Decision tracing_decision) override {
return SpanPtr{startSpan_(config, trace_context, stream_info, tracing_decision)};
}

MOCK_METHOD(Span*, startSpan_,
(const Config& config, TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info,
const Tracing::Decision tracing_decision));
const StreamInfo::StreamInfo& stream_info, Tracing::Decision tracing_decision));
};

class MockDriver : public Driver {
Expand All @@ -79,15 +78,15 @@ class MockDriver : public Driver {

SpanPtr startSpan(const Config& config, TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info, const std::string& operation_name,
const Tracing::Decision tracing_decision) override {
Tracing::Decision tracing_decision) override {
return SpanPtr{
startSpan_(config, trace_context, stream_info, operation_name, tracing_decision)};
}

MOCK_METHOD(Span*, startSpan_,
(const Config& config, TraceContext& trace_context,
const StreamInfo::StreamInfo& stream_info, const std::string& operation_name,
const Tracing::Decision tracing_decision));
Tracing::Decision tracing_decision));
};

class MockTracerManager : public TracerManager {
Expand Down
Loading