org.avaje.metric.RequestTiming Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of avaje-metric-api Show documentation

The newest version!

package org.avaje.metric;

import java.util.List;

/**
 * Holds the details for a request including it's timing entries.
 */
public interface RequestTiming {

  /**
   * Set the external request id (typically obtaining from MDC logging context).
   * 
   * This is an optional but useful to be able to relate the request timing output
   * to a specific application request.
   * 
   */
  void setExternalRequestId(String externalRequestId);

  /**
   * Return the external request id if it had been set.
   * 
   * This is an optional but useful to be able to relate the request timing output
   * to a specific application request.
   * 
   */
  String getExternalRequestId();

  /**
   * Return the time the request was reported.
   */
  long getReportTime();

  /**
   * Return the entries for the request.
   */
  List getEntries();

}