com.uber.m3.tally.DurationBuckets Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tally-core Show documentation
null
The newest version!
// Copyright (c) 2021 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package com.uber.m3.tally;

import com.uber.m3.util.Duration;

import java.util.Collections;
import java.util.List;

/**
 * {@link Buckets} implementation backed by {@link Duration}s.
 */
public class DurationBuckets extends AbstractBuckets {

    public DurationBuckets(Duration[] durations) {
        super(durations);
    }

    @Override
    public Duration getDurationLowerBoundFor(int bucketIndex) {
        return bucketIndex == 0 ? Duration.MIN_VALUE : buckets.get(bucketIndex - 1);
    }

    @Override
    public Duration getDurationUpperBoundFor(int bucketIndex) {
        return bucketIndex < buckets.size() ? buckets.get(bucketIndex) : Duration.MAX_VALUE;
    }

    @Override
    public int getBucketIndexFor(Duration value) {
        return HistogramImpl.toBucketIndex(Collections.binarySearch(buckets, value));
    }

    @Override
    public List getDurationUpperBounds() {
        return Collections.unmodifiableList(buckets);
    }

    @Override
    public double getValueLowerBoundFor(int bucketIndex) {
        throw new UnsupportedOperationException("not supported");
    }

    @Override
    public double getValueUpperBoundFor(int bucketIndex) {
        throw new UnsupportedOperationException("not supported");
    }

    @Override
    public int getBucketIndexFor(double value) {
        throw new UnsupportedOperationException("not supported");
    }

    @Override
    public List getValueUpperBounds() {
        throw new UnsupportedOperationException("not supported");
    }

    /**
     * @deprecated DO NOT USE
     */
    @Deprecated
    @Override
    public Double[] asValues() {
        Double[] values = new Double[buckets.size()];

        for (int i = 0; i < values.length; i++) {
            values[i] = buckets.get(i).getSeconds();
        }

        return values;
    }

    /**
     * @deprecated DO NOT USE
     */
    @Deprecated
    @Override
    public Duration[] asDurations() {
        return buckets.toArray(new Duration[buckets.size()]);
    }

    /**
     * Helper function to create {@link DurationBuckets} of linear spacing.
     * @param start      the starting bucket's {@link Duration}
     * @param width      the width of each bucket
     * @param numBuckets the number of buckets to create
     * @return {@link DurationBuckets} of the specified parameters
     */
    public static DurationBuckets linear(Duration start, Duration width, int numBuckets) {
        if (numBuckets <= 0) {
            throw new IllegalArgumentException("Must have a positive number of buckets");
        }

        if (width.compareTo(Duration.ZERO) <= 0) {
            throw new IllegalArgumentException("Bucket width must be positive");
        }

        Duration[] buckets = new Duration[numBuckets];

        for (int i = 0; i < numBuckets; i++) {
            buckets[i] = start.add(width.multiply(i));
        }

        return new DurationBuckets(buckets);
    }

    /**
     * Helper function to create {@link DurationBuckets} of exponential spacing.
     * @param start      the starting bucket's {@link Duration}
     * @param factor     the factor between each bucket
     * @param numBuckets the number of buckets to create
     * @return {@link DurationBuckets} of the specified paramters
     */
    public static DurationBuckets exponential(Duration start, double factor, int numBuckets) {
        if (numBuckets <= 0) {
            throw new IllegalArgumentException("Must have a positive number of buckets");
        }

        if (factor <= 1) {
            throw new IllegalArgumentException("Factor must be greater than 1");
        }

        Duration[] buckets = new Duration[numBuckets];

        Duration curDuration = start;

        for (int i = 0; i < numBuckets; i++) {
            buckets[i] = curDuration;

            curDuration = curDuration.multiply(factor);
        }

        return new DurationBuckets(buckets);
    }

    /**
     * Allows to create bucket with finer bucket creation control
     *
     * @param sortedDurations sorted values (ascending) of upper bound of the buckets
     * @return {@link DurationBuckets} of the specified parameters
     */
    public static DurationBuckets custom(Duration... sortedDurations) {
        if (sortedDurations == null || sortedDurations.length == 0) {
            throw new IllegalArgumentException("at least one upper bucket value has to be specified");
        }

        for (int i = 0; i < sortedDurations.length - 1; i++) {
            if (sortedDurations[i].compareTo(sortedDurations[i + 1]) >= 0) {
                throw new IllegalArgumentException("bucketUpperMillis has to be sorted in ascending order with unique values");
            }
        }
        return new DurationBuckets(sortedDurations);
    }
}