io.micrometer.registry.otlp.internal.CumulativeBase2ExponentialHistogram Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micrometer-registry-otlp Show documentation

Publishes Micrometer meters in OTLP format

There is a newer version: 1.14.1

Show newest version

/*
 * Copyright 2023 VMware, Inc.
 *
 * 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
 *
 * https://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 io.micrometer.registry.otlp.internal;

import java.util.concurrent.TimeUnit;

import io.micrometer.common.lang.Nullable;

/**
 * A {@link Base2ExponentialHistogram} that tracks values cumulatively from first recorded
 * value. *
 * 
 * *  This is an internal class and might have breaking changes, external *
 * implementations SHOULD NOT rely on this implementation.  *
 * 
 *
 * @author Lenin Jaganathan
 * @since 1.14.0
 */
public class CumulativeBase2ExponentialHistogram extends Base2ExponentialHistogram {

    private ExponentialHistogramSnapShot exponentialHistogramSnapShot;

    /**
     * Creates an Base2ExponentialHistogram that record positive values cumulatively.
     * @param maxScale - maximum scale that can be used. The recordings start with this
     * scale and gets downscaled to the scale that supports recording data within
     * maxBucketsCount.
     * @param maxBucketsCount - maximum number of buckets that can be used for
     * distribution.
     * @param zeroThreshold - values less than or equal to this are considered in zero
     * count and recorded in the histogram. If less than 0, this is rounded to zero. In
     * case of recording time, this should be in nanoseconds.
     * @param baseUnit - an Optional TimeUnit. If set to a non-null unit, the recorded
     * values are converted to this unit.
     */
    public CumulativeBase2ExponentialHistogram(final int maxScale, final int maxBucketsCount,
            final double zeroThreshold, @Nullable final TimeUnit baseUnit) {
        super(maxScale, maxBucketsCount, zeroThreshold, baseUnit);
        this.exponentialHistogramSnapShot = DefaultExponentialHistogramSnapShot.getEmptySnapshotForScale(maxScale);
    }

    @Override
    public ExponentialHistogramSnapShot getLatestExponentialHistogramSnapshot() {
        return this.exponentialHistogramSnapShot;
    }

    @Override
    synchronized void takeExponentialHistogramSnapShot() {
        this.exponentialHistogramSnapShot = getCurrentValuesSnapshot();
    }

}