Package com.azure.core.util.tracing
Class TracerProxy
java.lang.Object
com.azure.core.util.tracing.TracerProxy
This class provides a means for all client libraries to augment the context information they have received from an
end user with additional distributed tracing information, that may then be passed on to a backend for analysis.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic void
For the plugged intracer
, its current tracing span is marked as completed.static boolean
Returns true if tracing is enabled.static void
setAttribute
(String key, String value, Context context) For the plugged intracer
, the key-value pair metadata is added to its current span.static Context
setSpanName
(String spanName, Context context) Sets the span name for eachtracer
plugged into the SDK.static Context
A new tracing span with INTERNAL kind is created for eachtracer
plugged into the SDK.static Context
start
(String methodName, StartSpanOptions spanOptions, Context context) A new tracing span is created for eachtracer
plugged into the SDK.
-
Method Details
-
start
A new tracing span with INTERNAL kind is created for eachtracer
plugged into the SDK.The
context
will be checked for information about a parent span. If a parent span is found, the new span will be added as a child. Otherwise, the parent span will be created and added to thecontext
and any downstreamstart()
calls will use the created span as the parent.- Parameters:
methodName
- Name of the method triggering the span creation.context
- Additional metadata that is passed through the call stack.- Returns:
- An updated
Context
object.
-
start
A new tracing span is created for eachtracer
plugged into the SDK.The
context
will be checked for information about a parent span. If a parent span is found, the new span will be added as a child. Otherwise, the parent span will be created and added to thecontext
and any downstreamstart()
calls will use the created span as the parent.- Parameters:
methodName
- Name of the method triggering the span creation.spanOptions
- span creation options.context
- Additional metadata that is passed through the call stack.- Returns:
- An updated
Context
object.
-
setAttribute
For the plugged intracer
, the key-value pair metadata is added to its current span. If thecontext
does not contain a span, then no metadata is added.- Parameters:
key
- Name of the metadata.value
- Value of the metadata.context
- Additional metadata that is passed through the call stack.
-
end
For the plugged intracer
, its current tracing span is marked as completed.- Parameters:
responseCode
- Response status code if the span is in an HTTP call context.error
-Throwable
that happened during the span ornull
if no exception occurred.context
- Additional metadata that is passed through the call stack.
-
setSpanName
Sets the span name for eachtracer
plugged into the SDK.- Parameters:
spanName
- Name of the span.context
- Additional metadata that is passed through the call stack.- Returns:
- An updated
Context
object.
-
isTracingEnabled
public static boolean isTracingEnabled()Returns true if tracing is enabled.- Returns:
- true if tracing is enabled.
-