build.tmp.org.xbib.metrics.common.Histogram Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of metrics-common Show documentation

null

There is a newer version: 2.1.0

package org.xbib.metrics.common;

import org.xbib.metrics.api.Count;
import org.xbib.metrics.api.Metric;
import org.xbib.metrics.api.Reservoir;
import org.xbib.metrics.api.Sampling;
import org.xbib.metrics.api.Snapshot;

import java.util.concurrent.atomic.LongAdder;

/**
 * A metric which calculates the distribution of a value.
 *
 * @see Accurately computing running
 * variance
 */
public class Histogram implements Metric, Sampling, Count {

    private final Reservoir reservoir;

    private final LongAdder count;

    /**
     * Creates a new {@link Histogram} with the given reservoir.
     *
     * @param reservoir the reservoir to create a histogram from
     */
    public Histogram(Reservoir reservoir) {
        this.reservoir = reservoir;
        this.count = new LongAdder();
    }

    @Override
    public void inc() {
        inc(1);
    }

    /**
     * Adds a recorded value.
     *
     * @param value the length of the value
     */
    @Override
    public void inc(long value) {
        count.increment();
        reservoir.update(value);
    }

    @Override
    public void inc(String index, String type, String id) {
        // not used
    }

    @Override
    public void dec() {
        dec(1);
    }

    @Override
    public void dec(long n) {
        throw new UnsupportedOperationException();
    }

    @Override
    public void dec(String index, String type, String id) {
        // not used
    }

    /**
     * Returns the number of values recorded.
     *
     * @return the number of values recorded
     */
    @Override
    public long getCount() {
        return count.sum();
    }

    @Override
    public String getIncChecksum(String index, String type) {
        return null;
    }

    @Override
    public String getDecChecksum(String index, String type) {
        return null;
    }

    @Override
    public Snapshot getSnapshot() {
        return reservoir.getSnapshot();
    }
}