org.opensearch.indices.replication.common.ReplicationTimer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensearch Show documentation
OpenSearch subproject :server
There is a newer version: 2.18.0
/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

package org.opensearch.indices.replication.common;

import org.opensearch.common.annotation.PublicApi;
import org.opensearch.common.unit.TimeValue;
import org.opensearch.core.common.io.stream.StreamInput;
import org.opensearch.core.common.io.stream.StreamOutput;
import org.opensearch.core.common.io.stream.Writeable;

import java.io.IOException;

/**
 * A serializable timer that is used to measure the time taken for
 * file replication operations like recovery.
 *
 * @opensearch.api
 */
@PublicApi(since = "1.0.0")
public class ReplicationTimer implements Writeable {
    private long startTime = 0;
    private long startNanoTime = 0;
    private long time = -1;
    private long stopTime = 0;

    public ReplicationTimer() {}

    public ReplicationTimer(StreamInput in) throws IOException {
        startTime = in.readVLong();
        startNanoTime = in.readVLong();
        stopTime = in.readVLong();
        time = in.readVLong();
    }

    @Override
    public synchronized void writeTo(StreamOutput out) throws IOException {
        out.writeVLong(startTime);
        out.writeVLong(startNanoTime);
        out.writeVLong(stopTime);
        // write a snapshot of current time, which is not per se the time field
        out.writeVLong(time());
    }

    public synchronized void start() {
        assert startTime == 0 : "already started";
        startTime = System.currentTimeMillis();
        startNanoTime = System.nanoTime();
    }

    /**
     * Returns start time in millis
     */
    public synchronized long startTime() {
        return startTime;
    }

    /**
     * Returns elapsed time in millis, or 0 if timer was not started
     */
    public synchronized long time() {
        if (startNanoTime == 0) {
            return 0;
        }
        if (time >= 0) {
            return time;
        }
        return Math.max(0, TimeValue.nsecToMSec(System.nanoTime() - startNanoTime));
    }

    /**
     * Returns stop time in millis
     */
    public synchronized long stopTime() {
        return stopTime;
    }

    public synchronized void stop() {
        assert stopTime == 0 : "already stopped";
        stopTime = Math.max(System.currentTimeMillis(), startTime);
        time = TimeValue.nsecToMSec(System.nanoTime() - startNanoTime);
        assert time >= 0;
    }

    public synchronized void reset() {
        startTime = 0;
        startNanoTime = 0;
        time = -1;
        stopTime = 0;
    }

    // only used in tests
    public long getStartNanoTime() {
        return startNanoTime;
    }
}