142 строки
12 KiB
YAML
142 строки
12 KiB
YAML
### 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 <xref uid=\"com.azure.core.util.tracing.TracerProvider\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TracerProvider\"></xref>"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public 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 <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref>, 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: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"java.lang.Throwable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Throwable\"></xref> that happened during the span or <code>null</code> if no exception occurred."
|
|
name: "error"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html\">Throwable</a>"
|
|
- description: "Additional metadata that is passed through the call stack."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static void end(int responseCode, Throwable error, Context context)"
|
|
desc: "For the plugged in <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref>, 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: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref>, the key-value pair metadata is added to its current span."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "Name of the metadata."
|
|
name: "key"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Value of the metadata."
|
|
name: "value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Additional metadata that is passed through the call stack."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static void setAttribute(String key, String value, Context context)"
|
|
desc: "For the plugged in <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref>, 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 <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref> plugged into the SDK."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "Name of the span."
|
|
name: "spanName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Additional metadata that is passed through the call stack."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Context setSpanName(String spanName, Context context)"
|
|
desc: "Sets the span name for each <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref> plugged into the SDK."
|
|
returns:
|
|
description: "An updated <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> object."
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref> plugged into the SDK."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "Name of the method triggering the span creation."
|
|
name: "methodName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Additional metadata that is passed through the call stack."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Context start(String methodName, Context context)"
|
|
desc: "A new tracing span with INTERNAL kind is created for each <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref> 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 <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> object."
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref> plugged into the SDK."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "Name of the method triggering the span creation."
|
|
name: "methodName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "span creation options."
|
|
name: "spanOptions"
|
|
type: "<xref href=\"com.azure.core.util.tracing.StartSpanOptions?alt=com.azure.core.util.tracing.StartSpanOptions&text=StartSpanOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Additional metadata that is passed through the call stack."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static Context start(String methodName, StartSpanOptions spanOptions, Context context)"
|
|
desc: "A new tracing span is created for each <xref uid=\"com.azure.core.util.tracing.Tracer\" data-throw-if-not-resolved=\"false\" data-raw-source=\"tracer\"></xref> 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 <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> object."
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
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.52.0
|