Package com.google.api.client.http
Class OpenCensusUtils
java.lang.Object
com.google.api.client.http.OpenCensusUtils
Beta
Utilities for Census monitoring and tracing.
- Since:
- 1.28
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final AtomicLong
Sequence id generator for message event.private static boolean
Whether spans should be recorded locally.private static final Logger
(package private) static io.opencensus.trace.propagation.TextFormat
TextFormat
used in tracing context propagation.(package private) static io.opencensus.trace.propagation.TextFormat.Setter
TextFormat.Setter
forpropagationTextFormat
.static final String
Span name for tracingHttpRequest.execute()
.private static final io.opencensus.trace.Tracer
OpenCensus tracing component. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic io.opencensus.trace.EndSpanOptions
getEndSpanOptions
(Integer statusCode) Returns anEndSpanOptions
to end a http span according to the status code.static io.opencensus.trace.Tracer
Returns the tracing component of OpenCensus.static boolean
Returns whether spans should be recorded locally.static void
propagateTracingContext
(io.opencensus.trace.Span span, HttpHeaders headers) Propagate information of current tracing context.(package private) static void
recordMessageEvent
(io.opencensus.trace.Span span, long size, io.opencensus.trace.MessageEvent.Type eventType) Records a message event of a certainMessageEvent.Type
.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 theTextFormat
used in context propagation.static void
setPropagationTextFormatSetter
(io.opencensus.trace.propagation.TextFormat.Setter textFormatSetter) Sets theTextFormat.Setter
used in context propagation.
-
Field Details
-
logger
-
SPAN_NAME_HTTP_REQUEST_EXECUTE
Span name for tracingHttpRequest.execute()
. -
tracer
private static final io.opencensus.trace.Tracer tracerOpenCensus tracing component. When no OpenCensus implementation is provided, it will return a no-op tracer. -
idGenerator
Sequence id generator for message event. -
isRecordEvent
private static volatile boolean isRecordEventWhether spans should be recorded locally. Defaults to true. -
propagationTextFormat
TextFormat
used in tracing context propagation. -
propagationTextFormatSetter
@Nullable static volatile io.opencensus.trace.propagation.TextFormat.Setter propagationTextFormatSetterTextFormat.Setter
forpropagationTextFormat
.
-
-
Constructor Details
-
OpenCensusUtils
private OpenCensusUtils()
-
-
Method Details
-
setPropagationTextFormat
public static void setPropagationTextFormat(@Nullable io.opencensus.trace.propagation.TextFormat textFormat) Sets theTextFormat
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 withsetPropagationTextFormatSetter(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 theTextFormat.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 withsetPropagationTextFormat(io.opencensus.trace.propagation.TextFormat)
for setting purpose.- Parameters:
textFormatSetter
- theTextFormat.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
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
Returns anEndSpanOptions
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
- Thespan
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
- Thespan
in which the receive event occurs.size
- Size of the response.
-
recordMessageEvent
static void recordMessageEvent(io.opencensus.trace.Span span, long size, io.opencensus.trace.MessageEvent.Type eventType) Records a message event of a certainMessageEvent.Type
. This method is package protected sinceMessageEvent
might be deprecated in future releases.- Parameters:
span
- Thespan
in which the event occurs.size
- Size of the message.eventType
- TheNetworkEvent.Type
of the message event.
-