com.google.api.client.http

Class OpenCensusUtils

java.lang.Object

com.google.api.client.http.OpenCensusUtils

@Beta
public class OpenCensusUtils
extends Object

Beta
Utilities for Census monitoring and tracing.

Since:

1.28

Author:

Hailong Wen

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPAN_NAME_HTTP_REQUEST_EXECUTE Span name for tracing HttpRequest.execute().

Method Summary

Modifier and Type	Method and Description
static io.opencensus.trace.EndSpanOptions	getEndSpanOptions(Integer statusCode) Returns an EndSpanOptions to end a http span according to the status code.
static io.opencensus.trace.Tracer	getTracer() Returns the tracing component of OpenCensus.
static boolean	isRecordEvent() Returns whether spans should be recorded locally.
static void	propagateTracingContext(io.opencensus.trace.Span span, HttpHeaders headers) Propagate information of current tracing context.
static void	recordReceivedMessageEvent(io.opencensus.trace.Span span, long size) Records a new message event which contains the size of the response content.
static void	recordSentMessageEvent(io.opencensus.trace.Span span, long size) Records a new message event which contains the size of the request content.
static void	setIsRecordEvent(boolean recordEvent) Sets whether spans should be recorded locally.
static void	setPropagationTextFormat(io.opencensus.trace.propagation.TextFormat textFormat) Sets the TextFormat used in context propagation.
static void	setPropagationTextFormatSetter(io.opencensus.trace.propagation.TextFormat.Setter textFormatSetter) Sets the TextFormat.Setter used in context propagation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SPAN_NAME_HTTP_REQUEST_EXECUTE

public static final String SPAN_NAME_HTTP_REQUEST_EXECUTE

Span name for tracing HttpRequest.execute().

Method Detail

setPropagationTextFormat

public static void setPropagationTextFormat(@Nullable
                                            io.opencensus.trace.propagation.TextFormat textFormat)

Sets the TextFormat used in context propagation.

This API allows users of google-http-client to specify other text format, or disable context propagation by setting it to null. It should be used along with setPropagationTextFormatSetter(io.opencensus.trace.propagation.TextFormat.Setter) for setting purpose.

Parameters:

textFormat - the text format.

setPropagationTextFormatSetter

public static void setPropagationTextFormatSetter(@Nullable
                                                  io.opencensus.trace.propagation.TextFormat.Setter textFormatSetter)

Sets the TextFormat.Setter used in context propagation.

This API allows users of google-http-client to specify other text format setter, or disable context propagation by setting it to null. It should be used along with setPropagationTextFormat(io.opencensus.trace.propagation.TextFormat) for setting purpose.

Parameters:

textFormatSetter - the TextFormat.Setter for the text format.

setIsRecordEvent

public static void setIsRecordEvent(boolean recordEvent)

Sets whether spans should be recorded locally.

This API allows users of google-http-client to turn on/off local span collection.

Parameters:

recordEvent - record span locally if true.

getTracer

public static io.opencensus.trace.Tracer getTracer()

Returns the tracing component of OpenCensus.

Returns:

the tracing component of OpenCensus.

isRecordEvent

public static boolean isRecordEvent()

Returns whether spans should be recorded locally.

Returns:

whether spans should be recorded locally.

propagateTracingContext

public static void propagateTracingContext(io.opencensus.trace.Span span,
                                           HttpHeaders headers)

Propagate information of current tracing context. This information will be injected into HTTP header.

Parameters:

span - the span to be propagated.

headers - the headers used in propagation.

getEndSpanOptions

public static io.opencensus.trace.EndSpanOptions getEndSpanOptions(@Nullable
                                                                   Integer statusCode)

Returns an EndSpanOptions to end a http span according to the status code.

Parameters:

statusCode - the status code, can be null to represent no valid response is returned.

Returns:

an EndSpanOptions that best suits the status code.

recordSentMessageEvent

public static void recordSentMessageEvent(io.opencensus.trace.Span span,
                                          long size)

Records a new message event which contains the size of the request content. Note that the size represents the message size in application layer, i.e., content-length.

Parameters:

span - The span in which the send event occurs.

size - Size of the request.

recordReceivedMessageEvent

public static void recordReceivedMessageEvent(io.opencensus.trace.Span span,
                                              long size)

Records a new message event which contains the size of the response content. Note that the size represents the message size in application layer, i.e., content-length.

Parameters:

span - The span in which the receive event occurs.

size - Size of the response.