com.arpnetworking.metrics.impl.TsdTimer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of metrics-client Show documentation
Client library in Java for metrics collection and publication.
There is a newer version: 0.13.0
/*
 * Copyright 2014 Groupon.com
 *
 * 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.arpnetworking.metrics.impl;

import com.arpnetworking.metrics.Quantity;
import com.arpnetworking.metrics.StopWatch;
import com.arpnetworking.metrics.Timer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;

/**
 * Implementation of {@link Timer}. This class is thread safe.
 *
 * @author Ville Koskela (ville dot koskela at inscopemetrics dot io)
 */
/* package private */ final class TsdTimer implements Timer, Quantity {
    /**
     * Package private static factory. All {@link TsdTimer} instances should
     * be created through the {@link TsdMetrics} instance.
     *
     * @param name The name of the timer.
     * @param isOpen Reference to state of containing {@link TsdMetrics}
     * instance. This is provided as a separate parameter to avoid creating a
     * cyclical dependency between {@link TsdMetrics} and
     * {@link TsdTimer} which could cause garbage collection delays.
     */
    /* package private */ static TsdTimer newInstance(final String name, final AtomicBoolean isOpen) {
        return new TsdTimer(name, isOpen, DEFAULT_LOGGER);
    }

    @Override
    public void stop() {
        close();
    }

    @Override
    public void close() {
        final boolean wasRunning = _stopWatch.isRunning();
        final boolean wasAborted = _isAborted.get();
        if (!_isOpen.get()) {
            _logger.warn(String.format("Timer closed/stopped after metrics instance closed; timer=%s", this));
        }
        if (wasAborted) {
            _logger.warn(String.format("Timer closed/stopped after aborted; timer=%s", this));
        } else if (!wasRunning) {
            _logger.warn(String.format("Timer closed/stopped multiple times; timer=%s", this));
        } else {
            try {
                _stopWatch.stop();
            } catch (final IllegalStateException e) {
                _logger.warn(String.format("Timer closed/stopped multiple times; timer=%s", this));
            }
        }
    }

    @Override
    public void abort() {
        final boolean wasAborted = _isAborted.getAndSet(true);
        final boolean wasRunning = _stopWatch.isRunning();
        if (!_isOpen.get()) {
            _logger.warn(String.format("Timer aborted after metrics instance closed; timer=%s", this));
        }
        if (wasAborted) {
            _logger.warn(String.format("Timer aborted multiple times; timer=%s", this));
        } else if (!wasRunning) {
            _logger.warn(String.format("Timer aborted after closed/stopped; timer=%s", this));
        }
    }

    @Override
    public Number getValue() {
        if (_stopWatch.isRunning()) {
            _logger.warn(String.format("Timer access before it is closed/stopped; timer=%s", this));
            return 0;
        }
        return TsdMetrics.convertTimeUnit(
                _stopWatch.getElapsedTime().getValue().longValue(),
                _stopWatch.getUnit(),
                TimeUnit.SECONDS);
    }

    @Override
    public boolean isRunning() {
        return _stopWatch.isRunning();
    }

    @Override
    public boolean isAborted() {
        return _isAborted.get();
    }

    @Override
    public String toString() {
        return String.format(
                "TsdTimer{Name=%s, StopWatch=%s, IsAborted=%s, IsOpen=%s}",
                _name,
                _stopWatch,
                _isAborted,
                _isOpen);
    }

    // NOTE: Package private for testing
    TsdTimer(final String name, final AtomicBoolean isOpen, final Logger logger) {
        _name = name;
        _isOpen = isOpen;
        _logger = logger;
        _stopWatch = StopWatch.start();
        _isAborted = new AtomicBoolean(false);
    }

    TsdTimer(final String name, final AtomicBoolean isOpen, final StopWatch stopWatch, final Logger logger) {
        _name = name;
        _isOpen = isOpen;
        _logger = logger;
        _stopWatch = stopWatch;
        _isAborted = new AtomicBoolean(false);
    }

    private final String _name;
    private final AtomicBoolean _isOpen;
    private final AtomicBoolean _isAborted;
    private final StopWatch _stopWatch;
    private final Logger _logger;

    private static final Logger DEFAULT_LOGGER = LoggerFactory.getLogger(TsdTimer.class);
}