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

impl(otel): traced async backoff in retry loop #11051

Merged
merged 1 commit into from
Mar 16, 2023
Merged

impl(otel): traced async backoff in retry loop #11051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions google/cloud/internal/async_rest_retry_loop.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include "google/cloud/future.h"
#include "google/cloud/idempotency.h"
#include "google/cloud/internal/call_context.h"
#include "google/cloud/internal/grpc_opentelemetry.h"
#include "google/cloud/internal/invoke_result.h"
#include "google/cloud/internal/rest_context.h"
#include "google/cloud/internal/retry_loop_helpers.h"
Expand Down Expand Up @@ -245,11 +246,11 @@ class AsyncRestRetryLoopImpl
auto self = this->shared_from_this();
auto state = StartOperation();
if (state.cancelled) return;
SetPending(state.operation,
cq_.MakeRelativeTimer(backoff_policy_->OnCompletion())
.then([self](future<TimerArgType> f) {
self->OnBackoff(f.get());
}));
SetPending(state.operation, internal::TracedAsyncBackoff(
cq_, backoff_policy_->OnCompletion())
.then([self](future<TimerArgType> f) {
self->OnBackoff(f.get());
}));
}

void OnAttempt(T result) {
Expand Down
33 changes: 28 additions & 5 deletions google/cloud/internal/async_rest_retry_loop_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,33 @@ TEST_F(AsyncRestRetryLoopCancelTest, ShutdownDuringTimer) {

#ifdef GOOGLE_CLOUD_CPP_HAVE_OPENTELEMETRY

using ::google::cloud::testing_util::IsActive;
using ::google::cloud::testing_util::SpanNamed;
using ::testing::AllOf;
using ::testing::Each;
using ::testing::SizeIs;

TEST(AsyncRestRetryLoopTest, TracedBackoff) {
auto span_catcher = testing_util::InstallSpanCatcher();

internal::OptionsSpan o(
Options{}.set<internal::OpenTelemetryTracingOption>(true));
AutomaticallyCreatedRestBackgroundThreads background;
(void)AsyncRestRetryLoop(
TestRetryPolicy(), TestBackoffPolicy(), Idempotency::kIdempotent,
background.cq(),
[&](auto, auto, auto) {
return make_ready_future<StatusOr<int>>(
internal::UnavailableError("try again"));
},
42, "error message")
.get();

auto spans = span_catcher->GetSpans();
EXPECT_THAT(spans,
AllOf(SizeIs(kMaxRetries), Each(SpanNamed("Async Backoff"))));
}

TEST(AsyncRestRetryLoopTest, CallSpanActiveThroughout) {
auto span_catcher = testing_util::InstallSpanCatcher();

Expand All @@ -565,7 +592,6 @@ TEST(AsyncRestRetryLoopTest, CallSpanActiveThroughout) {
TestRetryPolicy(), TestBackoffPolicy(), Idempotency::kIdempotent,
background.cq(),
[&](auto, auto, auto) {
using testing_util::IsActive;
EXPECT_THAT(span, IsActive());
return sequencer.PushBack();
},
Expand All @@ -585,10 +611,7 @@ TEST(AsyncRestRetryLoopTest, CallSpanActiveDuringCancel) {
internal::OptionsSpan o(
Options{}.set<internal::OpenTelemetryTracingOption>(true));

promise<StatusOr<int>> p([&] {
using testing_util::IsActive;
EXPECT_THAT(span, IsActive());
});
promise<StatusOr<int>> p([&] { EXPECT_THAT(span, IsActive()); });

AutomaticallyCreatedRestBackgroundThreads background;
future<StatusOr<int>> actual = AsyncRestRetryLoop(
Expand Down
3 changes: 2 additions & 1 deletion google/cloud/internal/async_retry_loop.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
#include "google/cloud/future.h"
#include "google/cloud/grpc_options.h"
#include "google/cloud/internal/call_context.h"
#include "google/cloud/internal/grpc_opentelemetry.h"
#include "google/cloud/internal/invoke_result.h"
#include "google/cloud/internal/retry_loop_helpers.h"
#include "google/cloud/internal/retry_policy.h"
Expand Down Expand Up @@ -244,7 +245,7 @@ class AsyncRetryLoopImpl
auto state = StartOperation();
if (state.cancelled) return;
SetPending(state.operation,
cq_.MakeRelativeTimer(backoff_policy_->OnCompletion())
TracedAsyncBackoff(cq_, backoff_policy_->OnCompletion())
.then([self](future<TimerArgType> f) {
self->OnBackoff(f.get());
}));
Expand Down
31 changes: 26 additions & 5 deletions google/cloud/internal/async_retry_loop_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,31 @@ TEST_F(AsyncRetryLoopCancelTest, ShutdownDuringTimer) {

#ifdef GOOGLE_CLOUD_CPP_HAVE_OPENTELEMETRY

using ::google::cloud::testing_util::IsActive;
using ::google::cloud::testing_util::SpanNamed;
using ::testing::AllOf;
using ::testing::Each;
using ::testing::SizeIs;

TEST(AsyncRetryLoopTest, TracedBackoff) {
auto span_catcher = testing_util::InstallSpanCatcher();

OptionsSpan o(Options{}.set<OpenTelemetryTracingOption>(true));
AutomaticallyCreatedBackgroundThreads background;
(void)AsyncRetryLoop(
TestRetryPolicy(), TestBackoffPolicy(), Idempotency::kIdempotent,
background.cq(),
[&](auto, auto, auto) {
return make_ready_future<StatusOr<int>>(UnavailableError("try again"));
},
42, "error message")
.get();

auto spans = span_catcher->GetSpans();
EXPECT_THAT(spans,
AllOf(SizeIs(kMaxRetries), Each(SpanNamed("Async Backoff"))));
}

TEST(AsyncRetryLoopTest, CallSpanActiveThroughout) {
auto span_catcher = testing_util::InstallSpanCatcher();

Expand All @@ -575,7 +600,6 @@ TEST(AsyncRetryLoopTest, CallSpanActiveThroughout) {
TestRetryPolicy(), TestBackoffPolicy(), Idempotency::kIdempotent,
background.cq(),
[&](auto, auto, auto) {
using testing_util::IsActive;
EXPECT_THAT(span, IsActive());
return sequencer.PushBack();
},
Expand All @@ -594,10 +618,7 @@ TEST(AsyncRetryLoopTest, CallSpanActiveDuringCancel) {
auto scope = opentelemetry::trace::Scope(span);
OptionsSpan o(Options{}.set<OpenTelemetryTracingOption>(true));

promise<StatusOr<int>> p([span] {
using testing_util::IsActive;
EXPECT_THAT(span, IsActive());
});
promise<StatusOr<int>> p([span] { EXPECT_THAT(span, IsActive()); });

AutomaticallyCreatedBackgroundThreads background;
future<StatusOr<int>> actual = AsyncRetryLoop(
Expand Down