-
Notifications
You must be signed in to change notification settings - Fork 216
Add OpenTracing interceptor for standalone activities #2909
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.
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
Open
444am
wants to merge
2
commits into
temporalio:master
Choose a base branch
from
444am:444am/activity-client-otel-interceptor
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
30 changes: 30 additions & 0 deletions
30
...entracing/src/main/java/io/temporal/opentracing/OpenTracingActivityClientInterceptor.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| package io.temporal.opentracing; | ||
|
|
||
| import io.temporal.common.interceptors.ActivityClientCallsInterceptor; | ||
| import io.temporal.common.interceptors.ActivityClientInterceptorBase; | ||
| import io.temporal.opentracing.internal.ContextAccessor; | ||
| import io.temporal.opentracing.internal.OpenTracingActivityClientCallsInterceptor; | ||
| import io.temporal.opentracing.internal.SpanFactory; | ||
|
|
||
| public class OpenTracingActivityClientInterceptor extends ActivityClientInterceptorBase { | ||
| private final OpenTracingOptions options; | ||
| private final SpanFactory spanFactory; | ||
| private final ContextAccessor contextAccessor; | ||
|
|
||
| public OpenTracingActivityClientInterceptor() { | ||
| this(OpenTracingOptions.getDefaultInstance()); | ||
| } | ||
|
|
||
| public OpenTracingActivityClientInterceptor(OpenTracingOptions options) { | ||
| this.options = options; | ||
| this.spanFactory = new SpanFactory(options); | ||
| this.contextAccessor = new ContextAccessor(options); | ||
| } | ||
|
|
||
| @Override | ||
| public ActivityClientCallsInterceptor activityClientCallsInterceptor( | ||
| ActivityClientCallsInterceptor next) { | ||
| return new OpenTracingActivityClientCallsInterceptor( | ||
| next, options, spanFactory, contextAccessor); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
151 changes: 151 additions & 0 deletions
151
...main/java/io/temporal/opentracing/internal/OpenTracingActivityClientCallsInterceptor.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| package io.temporal.opentracing.internal; | ||
|
|
||
| import io.opentracing.Scope; | ||
| import io.opentracing.Span; | ||
| import io.opentracing.Tracer; | ||
| import io.temporal.common.interceptors.ActivityClientCallsInterceptor; | ||
| import io.temporal.common.interceptors.ActivityClientCallsInterceptorBase; | ||
| import io.temporal.opentracing.OpenTracingOptions; | ||
| import io.temporal.opentracing.SpanOperationType; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| public class OpenTracingActivityClientCallsInterceptor extends ActivityClientCallsInterceptorBase { | ||
| private final SpanFactory spanFactory; | ||
| private final Tracer tracer; | ||
| private final ContextAccessor contextAccessor; | ||
|
|
||
| public OpenTracingActivityClientCallsInterceptor( | ||
| ActivityClientCallsInterceptor next, | ||
| OpenTracingOptions options, | ||
| SpanFactory spanFactory, | ||
| ContextAccessor contextAccessor) { | ||
| super(next); | ||
| this.spanFactory = spanFactory; | ||
| this.tracer = options.getTracer(); | ||
| this.contextAccessor = contextAccessor; | ||
| } | ||
|
|
||
| @Override | ||
| public StartActivityOutput startActivity(StartActivityInput input) { | ||
| Span activityStartSpan = | ||
| contextAccessor.writeSpanContextToHeader( | ||
| () -> | ||
| spanFactory | ||
| .createStandaloneActivityStartSpan( | ||
| tracer, input.getActivityType(), input.getOptions().getId()) | ||
| .start(), | ||
| input.getHeader(), | ||
| tracer); | ||
| try (Scope ignored = tracer.scopeManager().activate(activityStartSpan)) { | ||
| return super.startActivity(input); | ||
| } finally { | ||
| activityStartSpan.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public <R> GetActivityResultOutput<R> getActivityResult(GetActivityResultInput<R> input) | ||
| throws TimeoutException { | ||
| Span span = | ||
| spanFactory | ||
| .createStandaloneActivityOperationSpan( | ||
| tracer, SpanOperationType.GET_STANDALONE_ACTIVITY_RESULT, input.getActivityId()) | ||
| .start(); | ||
| try (Scope ignored = tracer.scopeManager().activate(span)) { | ||
| return super.getActivityResult(input); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public <R> CompletableFuture<GetActivityResultOutput<R>> getActivityResultAsync( | ||
| GetActivityResultInput<R> input) { | ||
| Span span = | ||
| spanFactory | ||
| .createStandaloneActivityOperationSpan( | ||
| tracer, SpanOperationType.GET_STANDALONE_ACTIVITY_RESULT, input.getActivityId()) | ||
| .start(); | ||
| try (Scope ignored = tracer.scopeManager().activate(span)) { | ||
| return super.getActivityResultAsync(input) | ||
| .whenComplete( | ||
| (result, throwable) -> { | ||
| span.finish(); | ||
| }); | ||
| } catch (Throwable t) { | ||
| span.finish(); | ||
| throw t; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public DescribeActivityOutput describeActivity(DescribeActivityInput input) { | ||
| Span span = | ||
| spanFactory | ||
| .createStandaloneActivityOperationSpan( | ||
| tracer, SpanOperationType.DESCRIBE_STANDALONE_ACTIVITY, input.getId()) | ||
| .start(); | ||
| try (Scope ignored = tracer.scopeManager().activate(span)) { | ||
| return super.describeActivity(input); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public CancelActivityOutput cancelActivity(CancelActivityInput input) { | ||
| Span span = | ||
| spanFactory | ||
| .createStandaloneActivityOperationSpan( | ||
| tracer, SpanOperationType.CANCEL_STANDALONE_ACTIVITY, input.getId()) | ||
| .start(); | ||
| try (Scope ignored = tracer.scopeManager().activate(span)) { | ||
| return super.cancelActivity(input); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public TerminateActivityOutput terminateActivity(TerminateActivityInput input) { | ||
| Span span = | ||
| spanFactory | ||
| .createStandaloneActivityOperationSpan( | ||
| tracer, SpanOperationType.TERMINATE_STANDALONE_ACTIVITY, input.getId()) | ||
| .start(); | ||
| try (Scope ignored = tracer.scopeManager().activate(span)) { | ||
| return super.terminateActivity(input); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ListActivitiesOutput listActivities(ListActivitiesInput input) { | ||
| Span span = | ||
| spanFactory | ||
| .createStandaloneActivityQuerySpan( | ||
| tracer, SpanOperationType.LIST_STANDALONE_ACTIVITIES, input.getQuery()) | ||
| .start(); | ||
| try (Scope ignored = tracer.scopeManager().activate(span)) { | ||
| return super.listActivities(input); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public CountActivitiesOutput countActivities(CountActivitiesInput input) { | ||
| Span span = | ||
| spanFactory | ||
| .createStandaloneActivityQuerySpan( | ||
| tracer, SpanOperationType.COUNT_STANDALONE_ACTIVITIES, input.getQuery()) | ||
| .start(); | ||
| try (Scope ignored = tracer.scopeManager().activate(span)) { | ||
| return super.countActivities(input); | ||
| } finally { | ||
| span.finish(); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ActionName has to be set for getSpanName(), but ActivityType is not provided in GetActivityResultInput / DescribeActivityInput etc. To minimize the cardinality I'm using a fixed placeholder here as of now. Let me know if you believe repeatedly using
activityIdfor distinction would be better.