Skip to content

Add OpenCensus tracing instrumentation in google-http-client module. - #393

Merged
mattwhisenhunt merged 1 commit into
googleapis:devfrom
HailongWen:opencensus-instrumentation
Jan 29, 2018
Merged

Add OpenCensus tracing instrumentation in google-http-client module.#393
mattwhisenhunt merged 1 commit into
googleapis:devfrom
HailongWen:opencensus-instrumentation

Conversation

@HailongWen

@HailongWenHailongWen commented Jan 28, 2018

Copy link
Copy Markdown
Contributor

This PR adds OpenCensus-Java instrumentation in to monitor and record events when executing HttpExecute#execute().

The instrumentation starts a Span when the method begins, and is ended before the method exits. The status of the span will be determined according to the status of the response. This Span is stored into local span store, and can be optionally exported if user explicitly configure an exporter (e.g. stackdriver exporter).

Spans can have children. In this case, the generated Span in the instrumentation will be parent of all the Spans generated by server-side procedure. To link the children Span with their parent, the context information should be propagated to server side. This is done by using OpenCensus HTTP Util to inject the information into the header in the request.

Added OpenCensusUtils provides helper methods to perform context propagation, and setting end status of span.

The added dependency of opencensus-api contains basic no-op implementation. It will be replaced by real implementation if user explicitly adds dependency of opencensus-impl or opencensus-impl-lite (for android and gae) in the classpath.

This PR does not contain integration test when opencensus-impl is provided. It can be added with the help of maintainers.

@HailongWen
HailongWenforce-pushed the opencensus-instrumentation branch from 30e4166 to 9b542cfCompareJanuary 28, 2018 06:40
@HailongWen

HailongWen commented Jan 28, 2018

Copy link
Copy Markdown
ContributorAuthor

Hi @mattwhisenhunt , would you please kindly help on this PR?

mattwhisenhunt
mattwhisenhunt approved these changes Jan 29, 2018
View reviewed changes

@mattwhisenhuntmattwhisenhunt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@mattwhisenhunt
mattwhisenhunt merged commit 2f67205 into googleapis:devJan 29, 2018
bogdandrutu
bogdandrutu reviewed Jan 29, 2018
View reviewed changes
Comment threadgoogle-http-client/src/main/java/com/google/api/client/util/OpenCensusUtils.java
* Sets the {@link TextFormat} used in context propagation.
* @param textFormat the text format.
*/
public static void setPropagationTextFormat(@Nullable TextFormat textFormat) {

This comment was marked as spam.

Sign in to view

Comment threadgoogle-http-client/src/main/java/com/google/api/client/util/OpenCensusUtils.java
* Sets the {@link TextFormat.Setter} used in context propagation.
* @param textFormatSetter the {@code TextFormat.Setter} for the text format.
*/
public static void setPropagationTextFormatSetter(@Nullable TextFormat.Setter textFormatSetter) {

This comment was marked as spam.

Sign in to view

Comment threadgoogle-http-client/src/main/java/com/google/api/client/util/OpenCensusUtils.java
* {@link TextFormat.Setter} for {@link activeTextFormat}.
*/
@Nullable
static TextFormat.Setter propagationTextFormatSetter = null;

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

Comment threadgoogle-http-client/src/main/java/com/google/api/client/http/HttpRequest.java
Preconditions.checkNotNull(requestMethod);
Preconditions.checkNotNull(url);

Span span = tracer.spanBuilder(traceSpanNamePrefix + "execute").startSpan();

This comment was marked as spam.

Sign in to view

Comment threadgoogle-http-client/src/main/java/com/google/api/client/util/OpenCensusUtils.java
public static void propagateTracingContext(HttpHeaders headers) {
Preconditions.checkNotNull(headers);
if (propagationTextFormat != null && propagationTextFormatSetter != null) {
Span span = tracer.getCurrentSpan();

This comment was marked as spam.

Sign in to view

Comment threadgoogle-http-client/src/main/java/com/google/api/client/http/HttpRequest.java
}
}
} while (retryRequest);
span.end(OpenCensusUtils.getEndSpanOptions(response == null ? null : response.getStatusCode()));

This comment was marked as spam.

Sign in to view

Comment threadgoogle-http-client/src/main/java/com/google/api/client/http/HttpRequest.java
// execute
lowLevelHttpRequest.setTimeout(connectTimeout, readTimeout);
// switch tracing scope to current span
Scope ws = tracer.withSpan(span);

This comment was marked as spam.

Sign in to view

@HailongWenHailongWen mentioned this pull request Feb 3, 2018
Merged
clundin25 pushed a commit to clundin25/google-http-java-client that referenced this pull request Aug 11, 2022
@renovate-bot@chingor13
chore(deps): update dependency org.apache.maven.plugins:maven-compile…
37f153f
…r-plugin to v3.8.1 (googleapis#393)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@bogdandrutubogdandrutubogdandrutu left review comments
@mattwhisenhuntmattwhisenhuntmattwhisenhunt approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@HailongWen@bogdandrutu@mattwhisenhunt