com.arpnetworking.metrics.codahale.Histogram Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2015 Groupon.com
 *
 * 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.arpnetworking.metrics.codahale;

import com.arpnetworking.metrics.Metrics;
import com.codahale.metrics.Reservoir;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

/**
 * Represents a Histogram that is wrapped to output ArpNetworking metrics. Each update will result in a counter sample being created.
 *
 * @author Brandon Arp (barp at groupon dot com)
 */
@SuppressFBWarnings("NM_SAME_SIMPLE_NAME_AS_SUPERCLASS")
public class Histogram extends com.codahale.metrics.Histogram {
    /**
     * Creates a new {@link Histogram} with the given reservoir.
     *
     * @param name name of the metric
     * @param lock lock for the metrics reference
     * @param reservoir the reservoir to create a histogram from
     */
    public Histogram(final String name, final SafeRefLock lock, final Reservoir reservoir) {
        super(reservoir);
        _name = name;
        _lock = lock;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void update(final long value) {
        _lock.readLocked(metrics -> {
                    metrics.resetCounter(_name);
                    metrics.incrementCounter(_name, value);
                });
        super.update(value);
    }

    private final String _name;
    private final SafeRefLock _lock;
}