Package com.azure.core.util

Class TracingOptions

java.lang.Object

com.azure.core.util.TracingOptions

public class TracingOptions
extends Object

Metrics configuration options for clients.

Constructor Summary

Constructors

Constructor	Description
TracingOptions()	Creates new instance of TracingOptions

Method Summary

Modifier and Type	Method	Description
static TracingOptions	fromConfiguration(Configuration configuration)	Loads metrics options from the configuration.
boolean	isEnabled()	Flag indicating if metrics should be enabled.
TracingOptions	setEnabled(boolean enabled)	Enables or disables metrics.

Methods inherited from class java.lang.Object

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

Constructor Details

TracingOptions

public TracingOptions()

Creates new instance of TracingOptions

Method Details

fromConfiguration

public static TracingOptions fromConfiguration(Configuration configuration)

Loads metrics options from the configuration.

Parameters:

configuration - The Configuration that is used to load proxy configurations from the environment. If null is passed then Configuration.getGlobalConfiguration() will be used.

Returns:

A TracingOptions reflecting a tracing options loaded from the configuration, if no tracing options are found, default (enabled) tracing options will be returned.

isEnabled

public boolean isEnabled()

Flag indicating if metrics should be enabled.

Returns:

true if metrics are enabled, false otherwise.

setEnabled

public TracingOptions setEnabled(boolean enabled)

Enables or disables metrics. By default, metrics are enabled if and only if metrics implementation is detected.

Parameters:

enabled - pass true to enable metrics.

Returns:

the updated TracingOptions object.