com.google.gerrit.metrics.Timer2 Maven / Gradle / Ivy
// Copyright (C) 2015 The Android Open Source Project
//
// 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.google.gerrit.metrics;
import static java.util.concurrent.TimeUnit.NANOSECONDS;
import com.google.gerrit.extensions.registration.RegistrationHandle;
import java.util.concurrent.TimeUnit;
/**
* Records elapsed time for an operation or span.
*
* Typical usage in a try-with-resources block:
*
*
* try (Timer2.Context ctx = timer.start(field)) {
* }
*
*
* @param type of the field.
* @param type of the field.
*/
public abstract class Timer2 implements RegistrationHandle {
public static class Context extends TimerContext {
private final Timer2 timer;
private final Object field1;
private final Object field2;
@SuppressWarnings("unchecked")
Context(Timer2 timer, F1 field1, F2 field2) {
this.timer = (Timer2) timer;
this.field1 = field1;
this.field2 = field2;
}
@Override
public void record(long elapsed) {
timer.record(field1, field2, elapsed, NANOSECONDS);
}
}
/**
* Begin a timer for the current block, value will be recorded when closed.
*
* @param field1 bucket to record the timer
* @param field2 bucket to record the timer
* @return timer context
*/
public Context start(F1 field1, F2 field2) {
return new Context(this, field1, field2);
}
/**
* Record a value in the distribution.
*
* @param field1 bucket to record the timer
* @param field2 bucket to record the timer
* @param value value to record
* @param unit time unit of the value
*/
public abstract void record(F1 field1, F2 field2, long value, TimeUnit unit);
}