com.palantir.atlasdb.util.AtlasDbMetrics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-client Show documentation
Palantir open source project
There is a newer version: 0.1193.0
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.palantir.atlasdb.util;

import com.codahale.metrics.MetricRegistry;
import com.github.benmanes.caffeine.cache.Cache;
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.logger.SafeLogger;
import com.palantir.logsafe.logger.SafeLoggerFactory;
import com.palantir.tritium.api.event.InstrumentationFilter;
import com.palantir.tritium.event.InstrumentationFilters;
import com.palantir.tritium.event.InvocationContext;
import com.palantir.tritium.event.log.LoggingInvocationEventHandler;
import com.palantir.tritium.event.log.LoggingLevel;
import com.palantir.tritium.metrics.caffeine.CaffeineCacheStats;
import com.palantir.tritium.metrics.registry.TaggedMetricRegistry;
import com.palantir.tritium.proxy.Instrumentation;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;
import org.slf4j.LoggerFactory;

public final class AtlasDbMetrics {
    private static final SafeLogger log = SafeLoggerFactory.get(AtlasDbMetrics.class);

    private AtlasDbMetrics() {}

    public static  T instrumentTimed(
            MetricRegistry metricRegistry, Class serviceInterface, U service) {
        return instrument(metricRegistry, serviceInterface, service, serviceInterface.getName(), instrumentTimedOnly());
    }

    /**
     * Instruments an instance of the provided service interface, registering timers for only the methods annotated
     * with {@link com.palantir.atlasdb.metrics.Timed}.
     */
    public static  T instrumentTimed(
            MetricRegistry metricRegistry, Class serviceInterface, U service, String name) {
        return instrument(metricRegistry, serviceInterface, service, name, instrumentTimedOnly());
    }

    /**
     * @deprecated use {@link #instrumentTimed(MetricRegistry, Class, Object)}
     */
    @Deprecated
    public static  T instrument(MetricRegistry metricRegistry, Class serviceInterface, U service) {
        return instrument(metricRegistry, serviceInterface, service, serviceInterface.getName());
    }

    /**
     * @deprecated use {@link #instrumentTimed(MetricRegistry, Class, Object, String)}
     */
    @Deprecated
    public static  T instrument(
            MetricRegistry metricRegistry, Class serviceInterface, U service, String name) {
        return instrument(metricRegistry, serviceInterface, service, name, instrumentAllMethods());
    }

    public static  T instrumentWithTaggedMetrics(
            TaggedMetricRegistry taggedMetrics, Class serviceInterface, U service) {
        return Instrumentation.builder(serviceInterface, service)
                .withHandler(
                        new TaggedMetricsInvocationEventHandler(taggedMetrics, MetricRegistry.name(serviceInterface)))
                .withPerformanceTraceLogging()
                .build();
    }

    public static  T instrumentWithTaggedMetrics(
            TaggedMetricRegistry taggedMetrics,
            Class serviceInterface,
            U service,
            Function> tagFunction) {
        return Instrumentation.builder(serviceInterface, service)
                .withHandler(new TaggedMetricsInvocationEventHandler(
                        taggedMetrics, MetricRegistry.name(serviceInterface), tagFunction))
                .withPerformanceTraceLogging()
                .build();
    }

    public static void registerCache(MetricRegistry metricRegistry, Cache cache, String metricsPrefix) {
        Set existingMetrics = metricRegistry.getMetrics().keySet().stream()
                .filter(name -> name.startsWith(metricsPrefix))
                .collect(Collectors.toSet());
        if (existingMetrics.isEmpty()) {
            CaffeineCacheStats.registerCache(metricRegistry, cache, metricsPrefix);
        } else {
            log.info(
                    "Not registering cache with prefix '{}' as metric registry already contains metrics: {}",
                    SafeArg.of("metricsPrefix", metricsPrefix),
                    SafeArg.of("existingMetrics", existingMetrics));
        }
    }

    private static  T instrument(
            MetricRegistry metricRegistry,
            Class serviceInterface,
            U service,
            String name,
            InstrumentationFilter instrumentationFilter) {
        return Instrumentation.builder(serviceInterface, service)
                .withFilter(instrumentationFilter)
                .withHandler(new SlidingWindowMetricsInvocationHandler(metricRegistry, name))
                .withLogging(
                        LoggerFactory.getLogger("performance." + name),
                        LoggingLevel.TRACE,
                        LoggingInvocationEventHandler.LOG_DURATIONS_GREATER_THAN_1_MICROSECOND)
                .build(); // Ok
    }

    private static InstrumentationFilter instrumentTimedOnly() {
        return new TimedOnlyInstrumentationFilter();
    }

    private static InstrumentationFilter instrumentAllMethods() {
        return InstrumentationFilters.INSTRUMENT_ALL;
    }
}