com.swirlds.common.metrics.platform.AbstractDistributionMetric Maven / Gradle / Ivy

Go to download

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

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2016-2024 Hedera Hashgraph, LLC
 *
 * 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.swirlds.common.metrics.platform;

import com.swirlds.common.metrics.PlatformMetric;
import com.swirlds.common.metrics.statistics.StatsBuffered;
import com.swirlds.metrics.api.MetricConfig;
import com.swirlds.metrics.api.snapshot.Snapshot.SnapshotEntry;
import com.swirlds.metrics.impl.AbstractMetric;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.List;
import java.util.Objects;

/**
 * Represents a metric computed over a distribution function
 */
public abstract class AbstractDistributionMetric extends AbstractMetric implements PlatformMetric {

    /**
     * Half-life of the metric
     */
    protected final double halfLife;

    AbstractDistributionMetric(@NonNull final MetricConfig config, final double halfLife) {
        super(config);
        this.halfLife = halfLife;
    }

    /**
     * Returns the mean value of this {@code Metric}.
     *
     * @return the current value
     */
    public abstract double get();

    /**
     * Getter of the {@code halfLife}
     *
     * @return the {@code halfLife}
     */
    public double getHalfLife() {
        return halfLife;
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    @Override
    public Double get(@NonNull final ValueType valueType) {
        Objects.requireNonNull(valueType, "valueType must not be null");
        return switch (valueType) {
            case VALUE -> get();
            case MAX -> getStatsBuffered().getMax();
            case MIN -> getStatsBuffered().getMin();
            case STD_DEV -> getStatsBuffered().getStdDev();
            default -> throw new IllegalArgumentException("Unsupported ValueType: " + valueType);
        };
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    @Override
    public List takeSnapshot() {
        final StatsBuffered statsBuffered = getStatsBuffered();
        return List.of(
                new SnapshotEntry(ValueType.VALUE, get()),
                new SnapshotEntry(ValueType.MAX, statsBuffered.getMax()),
                new SnapshotEntry(ValueType.MIN, statsBuffered.getMin()),
                new SnapshotEntry(ValueType.STD_DEV, statsBuffered.getStdDev()));
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void reset() {
        getStatsBuffered().reset(halfLife);
    }
}