org.opensearch.telemetry.metrics.MetricsRegistryFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation

OpenSearch subproject :server

There is a newer version: 2.18.0

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.telemetry.metrics;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.opensearch.common.annotation.InternalApi;
import org.opensearch.telemetry.Telemetry;
import org.opensearch.telemetry.TelemetrySettings;
import org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry;
import org.opensearch.telemetry.tracing.Tracer;

import java.io.Closeable;
import java.io.IOException;
import java.util.Optional;

/**
 * {@link MetricsRegistryFactory} represents a single global class that is used to access {@link MetricsRegistry}s.
 * 
 * The {@link MetricsRegistry} singleton object can be retrieved using MetricsRegistryFactory::getMetricsRegistry. The {@link MetricsRegistryFactory} object
 * is created during class initialization and cannot subsequently be changed.
 *
 * @opensearch.internal
 */
@InternalApi
public class MetricsRegistryFactory implements Closeable {

    private static final Logger logger = LogManager.getLogger(MetricsRegistryFactory.class);

    private final TelemetrySettings telemetrySettings;
    private final MetricsRegistry metricsRegistry;

    public MetricsRegistryFactory(TelemetrySettings telemetrySettings, Optional telemetry) {
        this.telemetrySettings = telemetrySettings;
        this.metricsRegistry = metricsRegistry(telemetry);
    }

    /**
     * Returns the {@link MetricsRegistry} instance
     *
     * @return MetricsRegistry instance
     */
    public MetricsRegistry getMetricsRegistry() {
        return metricsRegistry;
    }

    /**
     * Closes the {@link Tracer}
     */
    @Override
    public void close() {
        try {
            metricsRegistry.close();
        } catch (IOException e) {
            logger.warn("Error closing MetricsRegistry", e);
        }
    }

    private MetricsRegistry metricsRegistry(Optional telemetry) {
        MetricsRegistry metricsRegistry = telemetry.map(Telemetry::getMetricsTelemetry)
            .map(metricsTelemetry -> createDefaultMetricsRegistry(metricsTelemetry))
            .orElse(NoopMetricsRegistry.INSTANCE);
        return metricsRegistry;
    }

    private MetricsRegistry createDefaultMetricsRegistry(MetricsTelemetry metricsTelemetry) {
        return new DefaultMetricsRegistry(metricsTelemetry);
    }

}