Package com.azure.core.util

Class MetricsOptions

java.lang.Object

com.azure.core.util.MetricsOptions

public class MetricsOptions
extends Object

Metrics configuration options for clients.

Constructor Summary

Constructors

Constructor	Description
MetricsOptions()	Creates new instance of MetricsOptions

Method Summary

Modifier and Type	Method	Description
static MetricsOptions	fromConfiguration(Configuration configuration)	Attempts to load metrics options from the configuration.
boolean	isEnabled()	Flag indicating if metrics should be enabled.
MetricsOptions	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

MetricsOptions

public MetricsOptions()

Creates new instance of MetricsOptions

Method Details

fromConfiguration

public static MetricsOptions fromConfiguration(Configuration configuration)

Attempts to load metrics options from the configuration.

null will be returned if no metric options are found in the environment.

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 MetricsOptions reflecting a metrics loaded from configuration, if no options are found, default (enabled) 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 MetricsOptions 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 MetricsOptions object.