Skip to content

Commit

Permalink
fix(otel): end async client spans properly (#12919)
Browse files Browse the repository at this point in the history
  • Loading branch information
@dbolduc
dbolduc committed Oct 18, 2023
1 parent 591db9a commit 2c26eb9
Show file tree
Hide file tree
Showing 516 changed files with 4,428 additions and 6,765 deletions.
4 changes: 2 additions & 2 deletions generator/integration_tests/golden/v1/internal/golden_kitchen_sink_tracing_connection.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ GoldenKitchenSinkTracingConnection::WriteLogEntries(google::test::admin::databas
StreamRange<std::string>
GoldenKitchenSinkTracingConnection::ListLogs(google::test::admin::database::v1::ListLogsRequest request) {
auto span = internal::MakeSpan("golden_v1::GoldenKitchenSinkConnection::ListLogs");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
auto sr = child_->ListLogs(std::move(request));
return internal::MakeTracedStreamRange<std::string>(
std::move(span), std::move(sr));
Expand Down Expand Up @@ -86,7 +86,7 @@ GoldenKitchenSinkTracingConnection::Deprecated2(google::test::admin::database::v
StreamRange<google::test::admin::database::v1::Response>
GoldenKitchenSinkTracingConnection::StreamingRead(google::test::admin::database::v1::Request const& request) {
auto span = internal::MakeSpan("golden_v1::GoldenKitchenSinkConnection::StreamingRead");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
auto sr = child_->StreamingRead(request);
return internal::MakeTracedStreamRange<google::test::admin::database::v1::Response>(
std::move(span), std::move(sr));
Expand Down
6 changes: 3 additions & 3 deletions generator/integration_tests/golden/v1/internal/golden_kitchen_sink_tracing_stub.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ std::unique_ptr<AsyncStreamingReadWriteRpc<
GoldenKitchenSinkTracingStub::AsyncStreamingReadWrite(
CompletionQueue const& cq, std::shared_ptr<grpc::ClientContext> context) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenKitchenSink", "StreamingReadWrite");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto stream = child_->AsyncStreamingReadWrite(cq, context);
return std::make_unique<internal::AsyncStreamingReadWriteRpcTracing<
Expand Down Expand Up @@ -170,7 +170,7 @@ GoldenKitchenSinkTracingStub::AsyncStreamingRead(
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::Request const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenKitchenSink", "StreamingRead");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto stream = child_->AsyncStreamingRead(cq, context, request);
return std::make_unique<
Expand All @@ -184,7 +184,7 @@ GoldenKitchenSinkTracingStub::AsyncStreamingWrite(
google::cloud::CompletionQueue const& cq,
std::shared_ptr<grpc::ClientContext> context) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenKitchenSink", "StreamingWrite");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto stream = child_->AsyncStreamingWrite(cq, context);
return std::make_unique<
Expand Down
22 changes: 11 additions & 11 deletions generator/integration_tests/golden/v1/internal/golden_thing_admin_tracing_connection.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ GoldenThingAdminTracingConnection::GoldenThingAdminTracingConnection(
StreamRange<google::test::admin::database::v1::Database>
GoldenThingAdminTracingConnection::ListDatabases(google::test::admin::database::v1::ListDatabasesRequest request) {
auto span = internal::MakeSpan("golden_v1::GoldenThingAdminConnection::ListDatabases");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
auto sr = child_->ListDatabases(std::move(request));
return internal::MakeTracedStreamRange<google::test::admin::database::v1::Database>(
std::move(span), std::move(sr));
Expand All @@ -45,7 +45,7 @@ future<StatusOr<google::test::admin::database::v1::Database>>
GoldenThingAdminTracingConnection::CreateDatabase(google::test::admin::database::v1::CreateDatabaseRequest const& request) {
auto span = internal::MakeSpan(
"golden_v1::GoldenThingAdminConnection::CreateDatabase");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
return internal::EndSpan(std::move(span), child_->CreateDatabase(request));
}

Expand All @@ -60,7 +60,7 @@ future<StatusOr<google::test::admin::database::v1::UpdateDatabaseDdlMetadata>>
GoldenThingAdminTracingConnection::UpdateDatabaseDdl(google::test::admin::database::v1::UpdateDatabaseDdlRequest const& request) {
auto span = internal::MakeSpan(
"golden_v1::GoldenThingAdminConnection::UpdateDatabaseDdl");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
return internal::EndSpan(std::move(span), child_->UpdateDatabaseDdl(request));
}

Expand Down Expand Up @@ -103,7 +103,7 @@ future<StatusOr<google::test::admin::database::v1::Backup>>
GoldenThingAdminTracingConnection::CreateBackup(google::test::admin::database::v1::CreateBackupRequest const& request) {
auto span = internal::MakeSpan(
"golden_v1::GoldenThingAdminConnection::CreateBackup");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
return internal::EndSpan(std::move(span), child_->CreateBackup(request));
}

Expand Down Expand Up @@ -131,7 +131,7 @@ GoldenThingAdminTracingConnection::DeleteBackup(google::test::admin::database::v
StreamRange<google::test::admin::database::v1::Backup>
GoldenThingAdminTracingConnection::ListBackups(google::test::admin::database::v1::ListBackupsRequest request) {
auto span = internal::MakeSpan("golden_v1::GoldenThingAdminConnection::ListBackups");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
auto sr = child_->ListBackups(std::move(request));
return internal::MakeTracedStreamRange<google::test::admin::database::v1::Backup>(
std::move(span), std::move(sr));
Expand All @@ -141,14 +141,14 @@ future<StatusOr<google::test::admin::database::v1::Database>>
GoldenThingAdminTracingConnection::RestoreDatabase(google::test::admin::database::v1::RestoreDatabaseRequest const& request) {
auto span = internal::MakeSpan(
"golden_v1::GoldenThingAdminConnection::RestoreDatabase");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
return internal::EndSpan(std::move(span), child_->RestoreDatabase(request));
}

StreamRange<google::longrunning::Operation>
GoldenThingAdminTracingConnection::ListDatabaseOperations(google::test::admin::database::v1::ListDatabaseOperationsRequest request) {
auto span = internal::MakeSpan("golden_v1::GoldenThingAdminConnection::ListDatabaseOperations");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
auto sr = child_->ListDatabaseOperations(std::move(request));
return internal::MakeTracedStreamRange<google::longrunning::Operation>(
std::move(span), std::move(sr));
Expand All @@ -157,7 +157,7 @@ GoldenThingAdminTracingConnection::ListDatabaseOperations(google::test::admin::d
StreamRange<google::longrunning::Operation>
GoldenThingAdminTracingConnection::ListBackupOperations(google::test::admin::database::v1::ListBackupOperationsRequest request) {
auto span = internal::MakeSpan("golden_v1::GoldenThingAdminConnection::ListBackupOperations");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
auto sr = child_->ListBackupOperations(std::move(request));
return internal::MakeTracedStreamRange<google::longrunning::Operation>(
std::move(span), std::move(sr));
Expand All @@ -167,23 +167,23 @@ future<StatusOr<google::test::admin::database::v1::Database>>
GoldenThingAdminTracingConnection::LongRunningWithoutRouting(google::test::admin::database::v1::RestoreDatabaseRequest const& request) {
auto span = internal::MakeSpan(
"golden_v1::GoldenThingAdminConnection::LongRunningWithoutRouting");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
return internal::EndSpan(std::move(span), child_->LongRunningWithoutRouting(request));
}

future<StatusOr<google::test::admin::database::v1::Database>>
GoldenThingAdminTracingConnection::AsyncGetDatabase(google::test::admin::database::v1::GetDatabaseRequest const& request) {
auto span = internal::MakeSpan(
"golden_v1::GoldenThingAdminConnection::AsyncGetDatabase");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
return internal::EndSpan(std::move(span), child_->AsyncGetDatabase(request));
}

future<Status>
GoldenThingAdminTracingConnection::AsyncDropDatabase(google::test::admin::database::v1::DropDatabaseRequest const& request) {
auto span = internal::MakeSpan(
"golden_v1::GoldenThingAdminConnection::AsyncDropDatabase");
auto scope = opentelemetry::trace::Scope(span);
internal::OTelScope scope(span);
return internal::EndSpan(std::move(span), child_->AsyncDropDatabase(request));
}

Expand Down
54 changes: 18 additions & 36 deletions generator/integration_tests/golden/v1/internal/golden_thing_admin_tracing_stub.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,8 @@ GoldenThingAdminTracingStub::AsyncCreateDatabase(
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::CreateDatabaseRequest const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenThingAdmin", "CreateDatabase");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncCreateDatabase(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand All @@ -70,10 +68,8 @@ GoldenThingAdminTracingStub::AsyncUpdateDatabaseDdl(
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::UpdateDatabaseDdlRequest const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenThingAdmin", "UpdateDatabaseDdl");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncUpdateDatabaseDdl(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand Down Expand Up @@ -134,10 +130,8 @@ GoldenThingAdminTracingStub::AsyncCreateBackup(
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::CreateBackupRequest const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenThingAdmin", "CreateBackup");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncCreateBackup(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand Down Expand Up @@ -188,10 +182,8 @@ GoldenThingAdminTracingStub::AsyncRestoreDatabase(
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::RestoreDatabaseRequest const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenThingAdmin", "RestoreDatabase");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncRestoreDatabase(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand Down Expand Up @@ -222,10 +214,8 @@ GoldenThingAdminTracingStub::AsyncLongRunningWithoutRouting(
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::RestoreDatabaseRequest const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenThingAdmin", "LongRunningWithoutRouting");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncLongRunningWithoutRouting(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand All @@ -235,10 +225,8 @@ future<StatusOr<google::test::admin::database::v1::Database>> GoldenThingAdminTr
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::GetDatabaseRequest const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenThingAdmin", "GetDatabase");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncGetDatabase(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand All @@ -248,10 +236,8 @@ future<Status> GoldenThingAdminTracingStub::AsyncDropDatabase(
std::shared_ptr<grpc::ClientContext> context,
google::test::admin::database::v1::DropDatabaseRequest const& request) {
auto span = internal::MakeSpanGrpc("google.test.admin.database.v1.GoldenThingAdmin", "DropDatabase");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncDropDatabase(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand All @@ -263,10 +249,8 @@ GoldenThingAdminTracingStub::AsyncGetOperation(
google::longrunning::GetOperationRequest const& request) {
auto span =
internal::MakeSpanGrpc("google.longrunning.Operations", "GetOperation");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncGetOperation(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand All @@ -277,10 +261,8 @@ future<Status> GoldenThingAdminTracingStub::AsyncCancelOperation(
google::longrunning::CancelOperationRequest const& request) {
auto span = internal::MakeSpanGrpc("google.longrunning.Operations",
"CancelOperation");
{
auto scope = opentelemetry::trace::Scope(span);
internal::InjectTraceContext(*context, *propagator_);
}
internal::OTelScope scope(span);
internal::InjectTraceContext(*context, *propagator_);
auto f = child_->AsyncCancelOperation(cq, context, request);
return internal::EndSpan(std::move(context), std::move(span), std::move(f));
}
Expand Down
3 changes: 3 additions & 0 deletions generator/integration_tests/tests/golden_kitchen_sink_tracing_connection_test.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ using ::google::cloud::testing_util::DisableTracing;
using ::google::cloud::testing_util::EnableTracing;
using ::google::cloud::testing_util::InstallSpanCatcher;
using ::google::cloud::testing_util::OTelAttribute;
using ::google::cloud::testing_util::OTelContextCaptured;
using ::google::cloud::testing_util::SpanHasAttributes;
using ::google::cloud::testing_util::SpanHasInstrumentationScope;
using ::google::cloud::testing_util::SpanKindIsClient;
Expand Down Expand Up @@ -148,6 +149,7 @@ TEST(GoldenKitchenSinkTracingConnectionTest, ListLogs) {
auto mock = std::make_shared<MockGoldenKitchenSinkConnection>();
EXPECT_CALL(*mock, ListLogs).WillOnce([] {
EXPECT_TRUE(ThereIsAnActiveSpan());
EXPECT_TRUE(OTelContextCaptured());
return mocks::MakeStreamRange<std::string>({},
internal::AbortedError("fail"));
});
Expand Down Expand Up @@ -253,6 +255,7 @@ TEST(GoldenKitchenSinkTracingConnectionTest, StreamingRead) {
auto mock = std::make_shared<MockGoldenKitchenSinkConnection>();
EXPECT_CALL(*mock, StreamingRead).WillOnce([] {
EXPECT_TRUE(ThereIsAnActiveSpan());
EXPECT_TRUE(OTelContextCaptured());
return mocks::MakeStreamRange<Response>({}, internal::AbortedError("fail"));
});

Expand Down
4 changes: 4 additions & 0 deletions generator/integration_tests/tests/golden_kitchen_sink_tracing_stub_test.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ using ::testing::Return;

using ::google::cloud::testing_util::InstallSpanCatcher;
using ::google::cloud::testing_util::OTelAttribute;
using ::google::cloud::testing_util::OTelContextCaptured;
using ::google::cloud::testing_util::SpanHasAttributes;
using ::google::cloud::testing_util::SpanHasInstrumentationScope;
using ::google::cloud::testing_util::SpanKindIsClient;
Expand Down Expand Up @@ -301,6 +302,7 @@ TEST(GoldenKitchenSinkTracingStubTest, AsyncStreamingRead) {
.WillOnce([](auto const&, auto context, auto const&) {
ValidatePropagator(*context);
EXPECT_TRUE(ThereIsAnActiveSpan());
EXPECT_TRUE(OTelContextCaptured());
using ErrorStream =
::google::cloud::internal::AsyncStreamingReadRpcError<Response>;
return std::make_unique<ErrorStream>(internal::AbortedError("fail"));
Expand Down Expand Up @@ -336,6 +338,7 @@ TEST(GoldenKitchenSinkTracingStubTest, AsyncStreamingWrite) {
.WillOnce([](auto const&, auto context) {
ValidatePropagator(*context);
EXPECT_TRUE(ThereIsAnActiveSpan());
EXPECT_TRUE(OTelContextCaptured());
using ErrorStream =
::google::cloud::internal::AsyncStreamingWriteRpcError<Request,
Response>;
Expand Down Expand Up @@ -372,6 +375,7 @@ TEST(GoldenKitchenSinkTracingStubTest, AsyncStreamingReadWrite) {
.WillOnce([](auto const&, auto context) {
ValidatePropagator(*context);
EXPECT_TRUE(ThereIsAnActiveSpan());
EXPECT_TRUE(OTelContextCaptured());
using ErrorStream =
::google::cloud::internal::AsyncStreamingReadWriteRpcError<
Request, Response>;
Expand Down
Loading

0 comments on commit 2c26eb9

Please sign in to comment.