com.swirlds.common.metrics.platform.PlatformDurationGauge 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) 2018-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 static com.swirlds.metrics.api.Metric.ValueType.VALUE;

import com.swirlds.common.metrics.DurationGauge;
import com.swirlds.common.metrics.PlatformMetric;
import com.swirlds.metrics.api.snapshot.Snapshot;
import com.swirlds.metrics.impl.AbstractMetric;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
import java.util.List;
import java.util.concurrent.atomic.AtomicLong;

/**
 * Platform-implementation of {@link DurationGauge}
 */
public class PlatformDurationGauge extends AbstractMetric implements PlatformMetric, DurationGauge {
    private final AtomicLong nanos;
    private final ChronoUnit unit;

    /**
     * Constructs a new PlatformDurationGauge with the given configuration.
     * @param config the configuration for this duration gauge
     */
    public PlatformDurationGauge(@NonNull final DurationGauge.Config config) {
        super(config);
        this.unit = config.getTimeUnit();
        this.nanos = new AtomicLong();
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    @Override
    public List takeSnapshot() {
        return List.of(new Snapshot.SnapshotEntry(VALUE, get()));
    }

    private double getAsDouble() {
        return nanos.get();
    }

    @Override
    public long getNanos() {
        return nanos.get();
    }

    @Override
    public void set(final Duration duration) {
        if (duration == null) {
            return;
        }
        nanos.set(duration.toNanos());
    }

    @Override
    public double get() {
        return getAsDouble() / unit.getDuration().toNanos();
    }
}