# Interface MetricsUtil (3.43.1)

3.43.1 (latest) 3.41.0 3.38.0 3.37.0 3.36.0 3.35.1 3.33.4 3.32.2 3.31.9 3.30.11 3.28.0 3.27.2 3.26.5 3.25.1 3.24.3 3.22.0 3.21.4 3.20.0 3.17.0 3.16.3 3.15.7 3.14.4 3.13.2 3.12.1 3.11.0 3.10.0 3.9.6 3.8.2 3.7.10 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.1.0 3.0.21

    public interface MetricsUtil

A utility interface for metrics collection. Classes that implement this interface may make their
own design choices for how they approach metrics collection. For instance, they may be no-op, or
they may use a particular metrics framework such as OpenTelemetry.

## Static Fields

### ENABLE_METRICS_ENV_VAR

    public static final String ENABLE_METRICS_ENV_VAR

| **Field Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### logger

    public static final Logger logger

| **Field Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/logging/Logger.html` |   |

## Static Methods

### getInstance(FirestoreOptions firestoreOptions)

    public static MetricsUtil getInstance(FirestoreOptions firestoreOptions)

Creates an instance of `MetricsUtil`. If the environment variable
`FIRESTORE_ENABLE_METRICS` is set to false or off, an instance of DisabledMetricsUtil
will be returned. Otherwise, an instance of EnabledMetricsUtil will be returned.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `firestoreOptions` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.FirestoreOptions` The Firestore options that configures client side metrics. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.telemetry.MetricsUtil` | An instance of `MetricsUtil`. |

### shouldCreateEnabledInstance()

    public static boolean shouldCreateEnabledInstance()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

## Methods

### addMetricsTracerFactory(List\<ApiTracerFactory\> apiTracerFactories)

    public abstract void addMetricsTracerFactory(List<ApiTracerFactory> apiTracerFactories)

Adds a metrics tracer factory to the given list of API tracer factories.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `apiTracerFactories` | `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.tracing.ApiTracerFactory.html>` The list of API tracer factories. |

### createMetricsContext(String methodName)

    public abstract MetricsUtil.MetricsContext createMetricsContext(String methodName)

Creates a new `MetricsContext` for the given method and starts timing.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `methodName` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The name of the method. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-firestore/latest/com.google.cloud.firestore.telemetry.MetricsUtil.MetricsContext` | A new `MetricsContext`. |