RequestLog (Fili: parent pom 0.10-SNAPSHOT API)

java.lang.Object
- com.yahoo.bard.webservice.logging.RequestLog

```
public class RequestLog
extends Object
```
Represents the logging framework that provides timing capabilities of arbitrary phases on the handling lifecycle of a request and accumulation of information for such a request in a single mega log line.

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`accumulate(RequestLog ctx)` Accumulates timings and threads to current thread's request log context.
`static void`	`addIdPrefix(String idPrefix)` Prepend an id prefix to generated druid query id.
`static RequestLog`	`copy()` Exports a snapshot of the request log of the current thread without resetting the request log for that thread.
`static RequestLog`	`dump()` Exports a snapshot of the request log of the current thread and also resets the request log for that thread.
`static String`	`export()` Exports current thread's request log object as a formatted string without resetting it.
`static Map<String,Float>`	`getAggregateDurations()` Get the aggregate durations for this request.
`static Map<String,Long>`	`getDurations()` Get the aggregate durations for this request.
`static String`	`getId()` Returns the id of this request log as a string.
`static boolean`	`isRunning(Object caller)` Check if a stopwatch is currently running.
`static boolean`	`isRunning(String timePhaseName)` Check if a stopwatch is currently running.
`static void`	`log()` Write the request log object of the current thread as JSON.
`static void`	`record(LogInfo logPhase)` Record logging information in the logging context.
`static void`	`registerTime(TimedPhase stoppedPhase)` Registers the final duration of a stopped timer with the RequestLog.
`static void`	`restore(RequestLog ctx)` Overwrite current thread's request log context.
`static LogInfo`	`retrieve(Class cls)` Retrieve logging information in the logging context.
`static Map<String,LogInfo>`	`retrieveAll()` Returns a map of all the LogInfo blocks currently registered with this thread's RequestLog.
`static TimedPhase`	`startTiming(Object caller)` Start a stopwatch.
`static TimedPhase`	`startTiming(String timePhaseName)` Start a stopwatch.
`static void`	`stopMostRecentTimer()` Deprecated. Stopping a timer based on context is brittle, and prone to unexpected changes. Timers should be stopped explicitly, or started in a try-with-resources block
`static void`	`stopTiming(Object caller)` Pause a stopwatch.
`static void`	`stopTiming(String timePhaseName)` Pause a stopwatch.
`static void`	`switchTiming(String nextPhase)` Deprecated. This method is too dependent on context that can be too easily changed by internal method calls. Each timer should be explicitly started by `startTiming(String)` and stopped by `stopTiming(String)` instead

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDurations
```
public static Map<String,Long> getDurations()
```
    Get the aggregate durations for this request.
    
    Returns:
    
    A map of phase to duration (ns)
  - getAggregateDurations
```
public static Map<String,Float> getAggregateDurations()
```
    Get the aggregate durations for this request.
    
    Returns:
    
    A map of phase to duration (ms)
  - isRunning
```
public static boolean isRunning(Object caller)
```
    Check if a stopwatch is currently running.
    
    Parameters:
    
    caller - the caller to name this stopwatch with its class's simple name
    
    Returns:
    
    whether this stopwatch is currently running
  - isRunning
```
public static boolean isRunning(String timePhaseName)
```
    Check if a stopwatch is currently running.
    
    Parameters:
    
    timePhaseName - the name of this stopwatch
    
    Returns:
    
    whether this stopwatch is started
  - startTiming
```
public static TimedPhase startTiming(Object caller)
```
    Start a stopwatch. Time is accumulated if the stopwatch is already registered
    
    Parameters:
    
    caller - the caller to name this stopwatch with its class's simple name
    
    Returns:
    
    The stopwatch
  - startTiming
```
public static TimedPhase startTiming(String timePhaseName)
```
    Start a stopwatch. Time is accumulated if the stopwatch is already registered
    
    Parameters:
    
    timePhaseName - the name of this stopwatch
    
    Returns:
    
    The stopwatch
  - switchTiming
```
@Deprecated
public static void switchTiming(String nextPhase)
```
    Deprecated. This method is too dependent on context that can be too easily changed by internal method calls. Each timer should be explicitly started by startTiming(String) and stopped by stopTiming(String) instead
    
    Stop the most recent stopwatch and start this one. Time is accumulated if the stopwatch is already registered.
    
    Parameters:
    
    nextPhase - the name of the stopwatch to be started
  - stopTiming
```
public static void stopTiming(Object caller)
```
    Pause a stopwatch.
    
    Parameters:
    
    caller - the caller to name this stopwatch with its class's simple name
  - registerTime
```
public static void registerTime(TimedPhase stoppedPhase)
```
    Registers the final duration of a stopped timer with the RequestLog.
    
    Parameters:
    
    stoppedPhase - The phase that has been stopped, and whose duration needs to be stored
  - stopTiming
```
public static void stopTiming(String timePhaseName)
```
    Pause a stopwatch.
    
    Parameters:
    
    timePhaseName - the name of this stopwatch
  - stopMostRecentTimer
```
@Deprecated
public static void stopMostRecentTimer()
```
    Deprecated. Stopping a timer based on context is brittle, and prone to unexpected changes. Timers should be stopped explicitly, or started in a try-with-resources block
    
    Stop the most recent stopwatch.
  - record
```
public static void record(LogInfo logPhase)
```
    Record logging information in the logging context.
    
    Parameters:
    
    logPhase - The name of the class destined to hold this logging information
    
    See Also:
    
    LogBlock
  - retrieve
```
public static LogInfo retrieve(Class cls)
```
    Retrieve logging information in the logging context.
    
    Parameters:
    
    cls - The class destined to hold this logging information
    
    Returns:
    
    the logging information in the logging context
    
    See Also:
    
    LogBlock
  - retrieveAll
```
public static Map<String,LogInfo> retrieveAll()
```
    Returns a map of all the LogInfo blocks currently registered with this thread's RequestLog.
    
    Returns:
    
    A map of all the LogInfo objects registered to this thread's RequestLog
  - log
```
public static void log()
```
    Write the request log object of the current thread as JSON. The thread's request log is cleared after a call to this method.
  - dump
```
public static RequestLog dump()
```
    Exports a snapshot of the request log of the current thread and also resets the request log for that thread.
    
    Returns:
    
    the log context of the current thread
  - copy
```
public static RequestLog copy()
```
    Exports a snapshot of the request log of the current thread without resetting the request log for that thread.
    
    Returns:
    
    the log context of the current thread
  - getId
```
public static String getId()
```
    Returns the id of this request log as a string. If called on an empty request log context, it initializes it.
    
    Returns:
    
    the log id
  - addIdPrefix
```
public static void addIdPrefix(String idPrefix)
```
    Prepend an id prefix to generated druid query id.
    
    Parameters:
    
    idPrefix - Prefix for queryId sent to druid
  - restore
```
public static void restore(RequestLog ctx)
```
    Overwrite current thread's request log context. It first clears the request log of the current thread and then fills it with the contents found in ctx
    
    Parameters:
    
    ctx - the log context to restore to current thread's request log
  - accumulate
```
public static void accumulate(RequestLog ctx)
```
    Accumulates timings and threads to current thread's request log context. It fills in the contents found in ctx. If the two contexts refer to different requests, then it logs a warning and returns.
    
    Parameters:
    
    ctx - The log context to accumulate to current thread's request log
  - export
```
public static String export()
```
    Exports current thread's request log object as a formatted string without resetting it.
    
    Returns:
    
    log object as a formatted string

Class RequestLog

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getDurations

getAggregateDurations

isRunning

isRunning

startTiming

startTiming

switchTiming

stopTiming

registerTime

stopTiming

stopMostRecentTimer

record

retrieve

retrieveAll

log

dump

copy

getId

addIdPrefix

restore

accumulate

export