### YamlMime:JavaType
uid: "com.azure.core.util.tracing.TracerProxy"
fullName: "com.azure.core.util.tracing.TracerProxy"
name: "TracerProxy"
nameWithType: "TracerProxy"
summary: "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."
deprecatedTag: "use "
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "@Deprecatedpublic final class **TracerProxy**"
methods:
- uid: "com.azure.core.util.tracing.TracerProxy.end(int,java.lang.Throwable,com.azure.core.util.Context)"
fullName: "com.azure.core.util.tracing.TracerProxy.end(int responseCode, Throwable error, Context context)"
name: "end(int responseCode, Throwable error, Context context)"
nameWithType: "TracerProxy.end(int responseCode, Throwable error, Context context)"
summary: "For the plugged in , its current tracing span is marked as completed."
modifiers:
- "static"
parameters:
- description: "Response status code if the span is in an HTTP call context."
name: "responseCode"
type: ""
- description: " that happened during the span or null
if no exception occurred."
name: "error"
type: "Throwable"
- description: "Additional metadata that is passed through the call stack."
name: "context"
type: ""
syntax: "public static void end(int responseCode, Throwable error, Context context)"
desc: "For the plugged in , its current tracing span is marked as completed."
- uid: "com.azure.core.util.tracing.TracerProxy.isTracingEnabled()"
fullName: "com.azure.core.util.tracing.TracerProxy.isTracingEnabled()"
name: "isTracingEnabled()"
nameWithType: "TracerProxy.isTracingEnabled()"
summary: "Returns true if tracing is enabled."
modifiers:
- "static"
syntax: "public static boolean isTracingEnabled()"
desc: "Returns true if tracing is enabled."
returns:
description: "true if tracing is enabled."
type: ""
- uid: "com.azure.core.util.tracing.TracerProxy.setAttribute(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.core.util.tracing.TracerProxy.setAttribute(String key, String value, Context context)"
name: "setAttribute(String key, String value, Context context)"
nameWithType: "TracerProxy.setAttribute(String key, String value, Context context)"
summary: "For the plugged in , the key-value pair metadata is added to its current span."
modifiers:
- "static"
parameters:
- description: "Name of the metadata."
name: "key"
type: "String"
- description: "Value of the metadata."
name: "value"
type: "String"
- description: "Additional metadata that is passed through the call stack."
name: "context"
type: ""
syntax: "public static void setAttribute(String key, String value, Context context)"
desc: "For the plugged in , the key-value pair metadata is added to its current span. If the `context` does not contain a span, then no metadata is added."
- uid: "com.azure.core.util.tracing.TracerProxy.setSpanName(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.core.util.tracing.TracerProxy.setSpanName(String spanName, Context context)"
name: "setSpanName(String spanName, Context context)"
nameWithType: "TracerProxy.setSpanName(String spanName, Context context)"
summary: "Sets the span name for each plugged into the SDK."
modifiers:
- "static"
parameters:
- description: "Name of the span."
name: "spanName"
type: "String"
- description: "Additional metadata that is passed through the call stack."
name: "context"
type: ""
syntax: "public static Context setSpanName(String spanName, Context context)"
desc: "Sets the span name for each plugged into the SDK."
returns:
description: "An updated object."
type: ""
- uid: "com.azure.core.util.tracing.TracerProxy.start(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.core.util.tracing.TracerProxy.start(String methodName, Context context)"
name: "start(String methodName, Context context)"
nameWithType: "TracerProxy.start(String methodName, Context context)"
summary: "A new tracing span with INTERNAL kind is created for each plugged into the SDK."
modifiers:
- "static"
parameters:
- description: "Name of the method triggering the span creation."
name: "methodName"
type: "String"
- description: "Additional metadata that is passed through the call stack."
name: "context"
type: ""
syntax: "public static Context start(String methodName, Context context)"
desc: "A new tracing span with INTERNAL kind is created for each plugged into the SDK.\n\nThe `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 the `context` and any downstream `start()` calls will use the created span as the parent."
returns:
description: "An updated object."
type: ""
- uid: "com.azure.core.util.tracing.TracerProxy.start(java.lang.String,com.azure.core.util.tracing.StartSpanOptions,com.azure.core.util.Context)"
fullName: "com.azure.core.util.tracing.TracerProxy.start(String methodName, StartSpanOptions spanOptions, Context context)"
name: "start(String methodName, StartSpanOptions spanOptions, Context context)"
nameWithType: "TracerProxy.start(String methodName, StartSpanOptions spanOptions, Context context)"
summary: "A new tracing span is created for each plugged into the SDK."
modifiers:
- "static"
parameters:
- description: "Name of the method triggering the span creation."
name: "methodName"
type: "String"
- description: "span creation options."
name: "spanOptions"
type: ""
- description: "Additional metadata that is passed through the call stack."
name: "context"
type: ""
syntax: "public static Context start(String methodName, StartSpanOptions spanOptions, Context context)"
desc: "A new tracing span is created for each plugged into the SDK.\n\nThe `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 the `context` and any downstream `start()` calls will use the created span as the parent."
returns:
description: "An updated object."
type: ""
type: "class"
desc: "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."
hasDeprecatedTag: true
metadata: {}
package: "com.azure.core.util.tracing"
artifact: com.azure:azure-core:1.54.0