All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • com.ea.orbit.metrics.MetricsManager Maven / Gradle / Ivy

    The newest version!
    /*
 Copyright (C) 2015 Electronic Arts Inc.  All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:

 1.  Redistributions of source code must retain the above copyright
     notice, this list of conditions and the following disclaimer.
 2.  Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimer in the
     documentation and/or other materials provided with the distribution.
 3.  Neither the name of Electronic Arts, Inc. ("EA") nor the names of
     its contributors may be used to endorse or promote products derived
     from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY ELECTRONIC ARTS AND ITS CONTRIBUTORS "AS IS" AND ANY
 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL ELECTRONIC ARTS OR ITS CONTRIBUTORS BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.ea.orbit.metrics;

import com.codahale.metrics.Metric;
import com.ea.orbit.metrics.annotations.ExportMetric;
import com.ea.orbit.metrics.annotations.MetricScope;
import com.ea.orbit.metrics.config.ReporterConfig;
import com.ea.orbit.exception.UncheckedException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.codahale.metrics.Gauge;
import com.codahale.metrics.MetricRegistry;
import com.codahale.metrics.Reporter;

import javax.inject.Singleton;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;
import java.util.regex.Pattern;

@Singleton
public class MetricsManager
{
    private static MetricsManager instance = new MetricsManager();
    private static final MetricRegistry registry = new MetricRegistry();
    private static final Logger logger = LoggerFactory.getLogger(MetricsManager.class);
    private Map reporters = new HashMap<>();
    private boolean isInitialized = false;
    private static Pattern nameSanitizationRegex = Pattern.compile("[\\[\\]\\.\\\\/]");

    protected MetricsManager()
    {

    }

    public static MetricsManager getInstance()
    {
        return instance;
    }

    public static String sanitizeMetricName(String name)
    {
        return nameSanitizationRegex.matcher(name).replaceAll(""); //strip illegal characters
    }

     protected MetricRegistry getRegistry()
    {
        return registry;
    }

    public synchronized void initializeMetrics(List reporterConfigs)
    {
        if (!isInitialized)
        {
            for (ReporterConfig reporterConfig : reporterConfigs)
            {
                Reporter reporter = reporterConfig.enableReporter(registry);
                if (reporter != null)
                {
                    reporters.put(reporterConfig, reporter);
                }
                else
                {
                    logger.warn("Failed to enable reporter " + reporterConfig.getClass().getName());
                }
            }
            isInitialized = true;
            logger.info("Orbit Metrics Initialized.");
        }
        else
        {
            if (logger.isWarnEnabled())
            {
                logger.warn("Attempting to initialize the Metrics Manager when it is already initialized!");
            }
        }
    }

    public void registerExportedMetrics(Object obj)
    {
        registerExportedMetrics(obj, "");
    }

    public void registerExportedMetrics(Object obj, String instanceId)
    {
        if (obj == null)
        {
            return;
        }

        for (Field field : findFieldsForMetricExport(obj))
        {
            final ExportMetric annotation = field.getAnnotation(ExportMetric.class);
            //check to see if the field is accessible.
            if (!field.isAccessible())
            {
                throw new IllegalStateException("Field " + field.getName() + " in object " + field.getDeclaringClass().getName() + " is marked for Metrics Export but the field is not accessible");
            }

            final String metricName = buildMetricName(field.getDeclaringClass(), annotation, instanceId);

            try
            {
                Metric metric = null;
                if (Metric.class.isAssignableFrom(field.getDeclaringClass()))
                {
                    metric = (Metric) field.get(obj);
                }
                else
                {
                    metric = buildGaugeForField(field, obj);
                }

                registerMetric(metricName, metric);
            }
            catch (IllegalAccessException iae)
            {
                throw new IllegalStateException("Field " + field.getName() + " was inaccessible: " + iae.getMessage());
            }

        }

        for (Method method : findMethodsForMetricExport(obj))
        {
            //methods declared as metrics must not accept parameters.
            if (method.getParameterCount() > 0)
            {
                throw new IllegalArgumentException("Method " + method.getName() + " in object " + method.getDeclaringClass().getName() + " is marked for Metrics Export but the method definition contains parameters.");
            }

            final ExportMetric annotation = method.getAnnotation(ExportMetric.class);

            final String counterName = buildMetricName(method.getDeclaringClass(), annotation, instanceId);
            registerMetric(counterName, (Gauge) () -> {
                try
                {
                    Object value = method.invoke(obj, new Object[0]);
                    return value;
                }
                catch (IllegalAccessException iae) //convert to an unchecked exception.
                {
                    throw new IllegalStateException("Method " + method.getName() + " was inaccessible: " + iae.getMessage());
                }
                catch (InvocationTargetException ite)
                {
                    throw new UncheckedException("Invocation of method " + method.getName() + " failed", ite.getTargetException());
                }
            });
        }
    }

    public void unregisterExportedMetrics(Object obj)
    {
        unregisterExportedMetrics(obj, "");
    }

    public void unregisterExportedMetrics(Object obj, String instanceId)
    {
        if (obj == null)
        {
            return;
        }

        for (Field field : findFieldsForMetricExport(obj))
        {
            final ExportMetric annotation = field.getAnnotation(ExportMetric.class);

            String metricName = buildMetricName(field.getDeclaringClass(), annotation, instanceId);
            unregisterMetric(metricName);
        }

        for (Method method : findMethodsForMetricExport(obj))
        {
            final ExportMetric annotation = method.getAnnotation(ExportMetric.class);

            String metricName = buildMetricName(method.getDeclaringClass(), annotation, instanceId);
            unregisterMetric(metricName);
        }
    }

    public void registerMetric(String name, Metric metric)
    {
        try
        {
            registry.register(name, metric);

            if (logger.isDebugEnabled())
            {
                logger.debug("Registered new metric " + name);
            }
        }
        catch (IllegalArgumentException iae)
        {
            logger.warn("Unable to register metric " + name + " because a metric already has been registered with the same name");
        }
    }

    public void unregisterMetric(String name)
    {
        registry.remove(name);
    }

    private Metric buildGaugeForField(Field field, Object obj)
    {
        return (Gauge) () -> {
            try
            {
                Object value = field.get(obj);
                return value;
            }
            catch (IllegalAccessException iae) //convert to an unchecked exception.
            {
                throw new IllegalStateException("Field " + field.getName() + " was inaccessible: " + iae.getMessage());
            }
        };
    }

    private List findFieldsForMetricExport(Object obj)
    {
        List exportedFields = new ArrayList<>();

        if (obj != null)
        {
            for (Field field : obj.getClass().getFields())
            {
                if (field.isAnnotationPresent(ExportMetric.class))
                {
                    exportedFields.add(field);
                }
            }
        }

        return exportedFields;
    }

    private List findMethodsForMetricExport(Object obj)
    {
        List exportedMethods = new ArrayList<>();

        if (obj != null)
        {
            for (Method method : obj.getClass().getMethods())
            {
                if (method.isAnnotationPresent(ExportMetric.class))
                {
                    exportedMethods.add(method);
                }
            }
        }

        return exportedMethods;
    }

    private String buildMetricName(Class clazz, ExportMetric annotation, String instanceId)
    {
        if (annotation.scope() == MetricScope.PROTOTYPE)
        {
            if (!instanceId.isEmpty())
            {
                return MetricRegistry.name(clazz.getName(), sanitizeMetricName(instanceId), annotation.name());
            }
            else
            {
                throw new IllegalArgumentException("Class '" + clazz.getName() + "' defines an instance Metric '" + annotation.name() + "' but an Instance ID was not provided!");
            }
        }
        else
        {
            return MetricRegistry.name(clazz.getName(), annotation.name());
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy