org.apache.logging.log4j.util.Timer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.logging.log4j.util;
import java.io.Serializable;
import java.text.DecimalFormat;
/**
* Primarily used in unit tests, but can be used to track elapsed time for a request or portion of any other operation
* so long as all the timer methods are called on the same thread in which it was started. Calling start on
* multiple threads will cause the times to be aggregated.
*/
public class Timer implements Serializable, StringBuilderFormattable
{
private static final long serialVersionUID = 9175191792439630013L;
private final String name; // The timer's name
public enum Status {
Started, Stopped, Paused
}
private Status status; // The timer's status
private long elapsedTime; // The elapsed time
private final int iterations;
private static long NANO_PER_SECOND = 1000000000L;
private static long NANO_PER_MINUTE = NANO_PER_SECOND * 60;
private static long NANO_PER_HOUR = NANO_PER_MINUTE * 60;
private ThreadLocal startTime = new ThreadLocal() {
@Override protected Long initialValue() {
return 0L;
}
};
/**
* Constructor.
* @param name the timer name.
*/
public Timer(final String name)
{
this(name, 0);
}
/**
* Constructor.
*
* @param name the timer name.
*/
public Timer(final String name, final int iterations)
{
this.name = name;
status = Status.Stopped;
this.iterations = (iterations > 0) ? iterations : 0;
}
/**
* Start the timer.
*/
public synchronized void start()
{
startTime.set(System.nanoTime());
elapsedTime = 0;
status = Status.Started;
}
public synchronized void startOrResume() {
if (status == Status.Stopped) {
start();
} else {
resume();
}
}
/**
* Stop the timer.
*/
public synchronized String stop()
{
elapsedTime += System.nanoTime() - startTime.get();
startTime.set(0L);
status = Status.Stopped;
return toString();
}
/**
* Pause the timer.
*/
public synchronized void pause()
{
elapsedTime += System.nanoTime() - startTime.get();
startTime.set(0L);
status = Status.Paused;
}
/**
* Resume the timer.
*/
public synchronized void resume()
{
startTime.set(System.nanoTime());
status = Status.Started;
}
/**
* Accessor for the name.
* @return the timer's name.
*/
public String getName()
{
return name;
}
/**
* Access the elapsed time.
*
* @return the elapsed time.
*/
public long getElapsedTime()
{
return elapsedTime / 1000000;
}
/**
* Access the elapsed time.
*
* @return the elapsed time.
*/
public long getElapsedNanoTime()
{
return elapsedTime;
}
/**
* Returns the name of the last operation performed on this timer (Start, Stop, Pause or
* Resume).
* @return the string representing the last operation performed.
*/
public Status getStatus()
{
return status;
}
/**
* Returns the String representation of the timer based upon its current state
*/
@Override
public String toString()
{
final StringBuilder result = new StringBuilder();
formatTo(result);
return result.toString();
}
@Override
public void formatTo(final StringBuilder buffer) {
buffer.append("Timer ").append(name);
switch (status) {
case Started:
buffer.append(" started");
break;
case Paused:
buffer.append(" paused");
break;
case Stopped:
long nanoseconds = elapsedTime;
// Get elapsed hours
long hours = nanoseconds / NANO_PER_HOUR;
// Get remaining nanoseconds
nanoseconds = nanoseconds % NANO_PER_HOUR;
// Get minutes
long minutes = nanoseconds / NANO_PER_MINUTE;
// Get remaining nanoseconds
nanoseconds = nanoseconds % NANO_PER_MINUTE;
// Get seconds
long seconds = nanoseconds / NANO_PER_SECOND;
// Get remaining nanoseconds
nanoseconds = nanoseconds % NANO_PER_SECOND;
String elapsed = Strings.EMPTY;
if (hours > 0) {
elapsed += hours + " hours ";
}
if (minutes > 0 || hours > 0) {
elapsed += minutes + " minutes ";
}
DecimalFormat numFormat;
numFormat = new DecimalFormat("#0");
elapsed += numFormat.format(seconds) + '.';
numFormat = new DecimalFormat("000000000");
elapsed += numFormat.format(nanoseconds) + " seconds";
buffer.append(" stopped. Elapsed time: ").append(elapsed);
if (iterations > 0) {
nanoseconds = elapsedTime / iterations;
// Get elapsed hours
hours = nanoseconds / NANO_PER_HOUR;
// Get remaining nanoseconds
nanoseconds = nanoseconds % NANO_PER_HOUR;
// Get minutes
minutes = nanoseconds / NANO_PER_MINUTE;
// Get remaining nanoseconds
nanoseconds = nanoseconds % NANO_PER_MINUTE;
// Get seconds
seconds = nanoseconds / NANO_PER_SECOND;
// Get remaining nanoseconds
nanoseconds = nanoseconds % NANO_PER_SECOND;
elapsed = Strings.EMPTY;
if (hours > 0) {
elapsed += hours + " hours ";
}
if (minutes > 0 || hours > 0) {
elapsed += minutes + " minutes ";
}
numFormat = new DecimalFormat("#0");
elapsed += numFormat.format(seconds) + '.';
numFormat = new DecimalFormat("000000000");
elapsed += numFormat.format(nanoseconds) + " seconds";
buffer.append(" Average per iteration: ").append(elapsed);
}
break;
default:
buffer.append(' ').append(status);
break;
}
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (!(o instanceof Timer)) {
return false;
}
final Timer timer = (Timer) o;
if (elapsedTime != timer.elapsedTime) {
return false;
}
if (startTime != timer.startTime) {
return false;
}
if (name != null ? !name.equals(timer.name) : timer.name != null) {
return false;
}
if (status != null ? !status.equals(timer.status) : timer.status != null) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result;
result = (name != null ? name.hashCode() : 0);
result = 29 * result + (status != null ? status.hashCode() : 0);
long time = startTime.get();
result = 29 * result + (int) (time ^ (time >>> 32));
result = 29 * result + (int) (elapsedTime ^ (elapsedTime >>> 32));
return result;
}
}