LoggingScopeFactory (REEF 0.10.0-incubating API)

java.lang.Object
- org.apache.reef.util.logging.LoggingScopeFactory

public class LoggingScopeFactory
extends Object

Create Logging scope objects

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVE_CONTEXT`
`static String`	`BRIDGE_SETUP`
`static String`	`CONTEXT_CLOSE`
`static String`	`CONTEXT_MESSAGE`
`static String`	`DRIVER_RESTART`
`static String`	`DRIVER_RESTART_ACTIVE_CONTEXT`
`static String`	`DRIVER_RESTART_COMPLETE`
`static String`	`DRIVER_RESTART_RUNNING_TASK`
`static String`	`DRIVER_START`
`static String`	`DRIVER_STOP`
`static String`	`DRIVER_SUBMIT`
`static String`	`EVALUATOR_ALLOCATED`
`static String`	`EVALUATOR_BRIDGE_SUBMIT`
`static String`	`EVALUATOR_COMPLETED`
`static String`	`EVALUATOR_FAILED`
`static String`	`EVALUATOR_LAUNCH`
`static String`	`EVALUATOR_REQUESTOR`
`static String`	`EVALUATOR_SUBMIT`
`static String`	`HTTP_REQUEST`
`static String`	`HTTP_SERVER`
`static String`	`LOCAL_JOB_SUBMIT`
`static String`	`REEF_SUBMIT`
`static String`	`TASK_COMPLETE`
`static String`	`TASK_MESSAGE`
`static String`	`TASK_RUNNING`
`static String`	`TASK_SUSPEND`

Method Summary

Methods
Modifier and Type	Method and Description
`LoggingScope`	`activeContextReceived(String contextId)` This is to measure the time in calling activeContext handler
`LoggingScope`	`closedContext(String contextId)` This is to measure the time in calling closedContext handler
`LoggingScope`	`contextMessageReceived(String msg)` This is to measure the time in calling contextMessageReceivedHandler
`LoggingScope`	`driverRestart(StartTime startTime)` This is to measure the time in calling driverRestartHandler
`LoggingScope`	`driverRestartActiveContextReceived(String contextId)` This is to measure the time in calling driverRestartActiveContextReceivedHandler
`LoggingScope`	`driverRestartCompleted(long timeStamp)` This is to measure the time in calling driverRestartCompletedHandler
`LoggingScope`	`driverRestartRunningTask(String taskId)` This is to measure the time in calling driverRestartRunningTaskHandler
`LoggingScope`	`driverStart(StartTime startTime)` The method is to measure the time used to start the driver.
`LoggingScope`	`driverStop(long timeStamp)` The method is to measure the time used to stop the driver.
`LoggingScope`	`driverSubmit(Boolean submitDriver)` This is to measure the time to submit a driver
`LoggingScope`	`evaluatorAllocated(String evaluatorId)` This is to measure the time on evaluatorAllocated handler
`LoggingScope`	`evaluatorCompleted(String evaluatorId)` This is to measure the time in calling evaluatorCompleted handler
`LoggingScope`	`evaluatorFailed(String evaluatorId)` This is to measure the time in calling evaluatorFailed handler
`LoggingScope`	`evaluatorLaunch(String evaluatorId)` This is to measure the time to launch an evaluator
`LoggingScope`	`evaluatorRequestorPassToCs()` The method is to measure the time used to pass EvaluatorRequestor from Java to .Net.
`LoggingScope`	`evaluatorRequestSubmitToJavaDriver(int evaluatorsNumber)` The method is to measure the time used to submit Evaluator request from CLR to Java driver.
`LoggingScope`	`evaluatorSubmit(int evaluatorNumber)` The method is to measure the time used to submit a Evaluator request at java side
`static LoggingScope`	`getNewLoggingScope(Level logLevel, String msg)` Get a new instance of LoggingScope with specified log level
`LoggingScope`	`getNewLoggingScope(String msg)` Get a new instance of LoggingScope with injected LoggingScopeFactory instance
`LoggingScope`	`getNewLoggingScope(String msg, Object[] params)` Get a new instance of LoggingScope with msg and params through new
`LoggingScope`	`httpRequest(String uri)` This is to measure the time in handling a http request
`LoggingScope`	`httpServer()` This is to measure the time used to create HttpServer
`LoggingScope`	`localJobSubmission()` This is to measure the time for a job submission
`LoggingScope`	`reefSubmit()` This is to measure the time to call Reef.Submit
`LoggingScope`	`setupBridge()` The method is to measure the time used to set up Java CRL bridge.
`LoggingScope`	`taskCompleted(String taskId)` This is to measure the time in calling taskCompletedHandler
`LoggingScope`	`taskMessageReceived(String msg)` This is to measure the time in calling taskMessageReceivedHandler
`LoggingScope`	`taskRunning(String taskId)` This is to measure the time in calling runningTaskHandler
`LoggingScope`	`taskSuspended(String taskId)` This is to measure the time in calling taskSuspendedHandler

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

- Field Detail
  - DRIVER_START
```
public static final String DRIVER_START
```
    See Also:
    Constant Field Values
  - DRIVER_STOP
```
public static final String DRIVER_STOP
```
    See Also:
    Constant Field Values
  - BRIDGE_SETUP
```
public static final String BRIDGE_SETUP
```
    See Also:
    Constant Field Values
  - EVALUATOR_REQUESTOR
```
public static final String EVALUATOR_REQUESTOR
```
    See Also:
    Constant Field Values
  - EVALUATOR_BRIDGE_SUBMIT
```
public static final String EVALUATOR_BRIDGE_SUBMIT
```
    See Also:
    Constant Field Values
  - EVALUATOR_SUBMIT
```
public static final String EVALUATOR_SUBMIT
```
    See Also:
    Constant Field Values
  - EVALUATOR_LAUNCH
```
public static final String EVALUATOR_LAUNCH
```
    See Also:
    Constant Field Values
  - EVALUATOR_ALLOCATED
```
public static final String EVALUATOR_ALLOCATED
```
    See Also:
    Constant Field Values
  - EVALUATOR_COMPLETED
```
public static final String EVALUATOR_COMPLETED
```
    See Also:
    Constant Field Values
  - EVALUATOR_FAILED
```
public static final String EVALUATOR_FAILED
```
    See Also:
    Constant Field Values
  - ACTIVE_CONTEXT
```
public static final String ACTIVE_CONTEXT
```
    See Also:
    Constant Field Values
  - TASK_RUNNING
```
public static final String TASK_RUNNING
```
    See Also:
    Constant Field Values
  - TASK_COMPLETE
```
public static final String TASK_COMPLETE
```
    See Also:
    Constant Field Values
  - TASK_MESSAGE
```
public static final String TASK_MESSAGE
```
    See Also:
    Constant Field Values
  - CONTEXT_MESSAGE
```
public static final String CONTEXT_MESSAGE
```
    See Also:
    Constant Field Values
  - CONTEXT_CLOSE
```
public static final String CONTEXT_CLOSE
```
    See Also:
    Constant Field Values
  - DRIVER_RESTART
```
public static final String DRIVER_RESTART
```
    See Also:
    Constant Field Values
  - DRIVER_RESTART_COMPLETE
```
public static final String DRIVER_RESTART_COMPLETE
```
    See Also:
    Constant Field Values
  - DRIVER_RESTART_RUNNING_TASK
```
public static final String DRIVER_RESTART_RUNNING_TASK
```
    See Also:
    Constant Field Values
  - DRIVER_RESTART_ACTIVE_CONTEXT
```
public static final String DRIVER_RESTART_ACTIVE_CONTEXT
```
    See Also:
    Constant Field Values
  - TASK_SUSPEND
```
public static final String TASK_SUSPEND
```
    See Also:
    Constant Field Values
  - DRIVER_SUBMIT
```
public static final String DRIVER_SUBMIT
```
    See Also:
    Constant Field Values
  - REEF_SUBMIT
```
public static final String REEF_SUBMIT
```
    See Also:
    Constant Field Values
  - LOCAL_JOB_SUBMIT
```
public static final String LOCAL_JOB_SUBMIT
```
    See Also:
    Constant Field Values
  - HTTP_REQUEST
```
public static final String HTTP_REQUEST
```
    See Also:
    Constant Field Values
  - HTTP_SERVER
```
public static final String HTTP_SERVER
```
    See Also:
    Constant Field Values
- Method Detail
  - getNewLoggingScope
```
public static LoggingScope getNewLoggingScope(Level logLevel,
                              String msg)
```
    Get a new instance of LoggingScope with specified log level
    
    Parameters:
    logLevel -
    msg -
    
    Returns:
  - getNewLoggingScope
```
public LoggingScope getNewLoggingScope(String msg)
```
    Get a new instance of LoggingScope with injected LoggingScopeFactory instance
    
    Parameters:
    msg -
    
    Returns:
  - getNewLoggingScope
```
public LoggingScope getNewLoggingScope(String msg,
                              Object[] params)
```
    Get a new instance of LoggingScope with msg and params through new
    
    Parameters:
    msg -
    params -
    
    Returns:
  - driverStart
```
public LoggingScope driverStart(StartTime startTime)
```
    The method is to measure the time used to start the driver. It can be inserted to the code between start driver till it is started
    
    Parameters:
    startTime -
    
    Returns:
  - driverStop
```
public LoggingScope driverStop(long timeStamp)
```
    The method is to measure the time used to stop the driver. It can be inserted to the code between start driver stop till it is stopped
    
    Parameters:
    timeStamp -
    
    Returns:
  - setupBridge
```
public LoggingScope setupBridge()
```
    The method is to measure the time used to set up Java CRL bridge. It can be inserted to the code between beginning of bridge set up and the end of it
    
    Returns:
  - evaluatorRequestorPassToCs
```
public LoggingScope evaluatorRequestorPassToCs()
```
    The method is to measure the time used to pass EvaluatorRequestor from Java to .Net. It can be inserted to the code between beginning to send EvaluatorRequestor to CLR until it is returned.
    
    Returns:
  - evaluatorRequestSubmitToJavaDriver
```
public LoggingScope evaluatorRequestSubmitToJavaDriver(int evaluatorsNumber)
```
    The method is to measure the time used to submit Evaluator request from CLR to Java driver. It can be inserted to evaluator submit() method.
    
    Parameters:
    evaluatorsNumber -
    
    Returns:
  - evaluatorSubmit
```
public LoggingScope evaluatorSubmit(int evaluatorNumber)
```
    The method is to measure the time used to submit a Evaluator request at java side
    
    Parameters:
    evaluatorNumber -
    
    Returns:
  - evaluatorAllocated
```
public LoggingScope evaluatorAllocated(String evaluatorId)
```
    This is to measure the time on evaluatorAllocated handler
    
    Parameters:
    evaluatorId -
    
    Returns:
  - evaluatorLaunch
```
public LoggingScope evaluatorLaunch(String evaluatorId)
```
    This is to measure the time to launch an evaluator
    
    Parameters:
    evaluatorId -
    
    Returns:
  - evaluatorCompleted
```
public LoggingScope evaluatorCompleted(String evaluatorId)
```
    This is to measure the time in calling evaluatorCompleted handler
    
    Parameters:
    evaluatorId -
    
    Returns:
  - evaluatorFailed
```
public LoggingScope evaluatorFailed(String evaluatorId)
```
    This is to measure the time in calling evaluatorFailed handler
    
    Parameters:
    evaluatorId -
    
    Returns:
  - activeContextReceived
```
public LoggingScope activeContextReceived(String contextId)
```
    This is to measure the time in calling activeContext handler
    
    Parameters:
    contextId -
    
    Returns:
  - closedContext
```
public LoggingScope closedContext(String contextId)
```
    This is to measure the time in calling closedContext handler
    
    Parameters:
    contextId -
    
    Returns:
  - taskRunning
```
public LoggingScope taskRunning(String taskId)
```
    This is to measure the time in calling runningTaskHandler
    
    Parameters:
    taskId -
    
    Returns:
  - taskCompleted
```
public LoggingScope taskCompleted(String taskId)
```
    This is to measure the time in calling taskCompletedHandler
    
    Parameters:
    taskId -
    
    Returns:
  - taskSuspended
```
public LoggingScope taskSuspended(String taskId)
```
    This is to measure the time in calling taskSuspendedHandler
    
    Parameters:
    taskId -
    
    Returns:
  - taskMessageReceived
```
public LoggingScope taskMessageReceived(String msg)
```
    This is to measure the time in calling taskMessageReceivedHandler
    
    Parameters:
    msg -
    
    Returns:
  - contextMessageReceived
```
public LoggingScope contextMessageReceived(String msg)
```
    This is to measure the time in calling contextMessageReceivedHandler
    
    Parameters:
    msg -
    
    Returns:
  - driverRestart
```
public LoggingScope driverRestart(StartTime startTime)
```
    This is to measure the time in calling driverRestartHandler
    
    Parameters:
    startTime -
    
    Returns:
  - driverRestartCompleted
```
public LoggingScope driverRestartCompleted(long timeStamp)
```
    This is to measure the time in calling driverRestartCompletedHandler
    
    Parameters:
    timeStamp -
    
    Returns:
  - driverRestartRunningTask
```
public LoggingScope driverRestartRunningTask(String taskId)
```
    This is to measure the time in calling driverRestartRunningTaskHandler
    
    Parameters:
    taskId -
    
    Returns:
  - driverRestartActiveContextReceived
```
public LoggingScope driverRestartActiveContextReceived(String contextId)
```
    This is to measure the time in calling driverRestartActiveContextReceivedHandler
    
    Parameters:
    contextId -
    
    Returns:
  - httpRequest
```
public LoggingScope httpRequest(String uri)
```
    This is to measure the time in handling a http request
    
    Parameters:
    uri -
    
    Returns:
  - httpServer
```
public LoggingScope httpServer()
```
    This is to measure the time used to create HttpServer
    
    Returns:
  - driverSubmit
```
public LoggingScope driverSubmit(Boolean submitDriver)
```
    This is to measure the time to submit a driver
    
    Parameters:
    submitDriver -
    
    Returns:
  - reefSubmit
```
public LoggingScope reefSubmit()
```
    This is to measure the time to call Reef.Submit
    
    Returns:
  - localJobSubmission
```
public LoggingScope localJobSubmission()
```
    This is to measure the time for a job submission
    
    Returns:

Class LoggingScopeFactory

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DRIVER_START

DRIVER_STOP

BRIDGE_SETUP

EVALUATOR_REQUESTOR

EVALUATOR_BRIDGE_SUBMIT

EVALUATOR_SUBMIT

EVALUATOR_LAUNCH

EVALUATOR_ALLOCATED

EVALUATOR_COMPLETED

EVALUATOR_FAILED

ACTIVE_CONTEXT

TASK_RUNNING

TASK_COMPLETE

TASK_MESSAGE

CONTEXT_MESSAGE

CONTEXT_CLOSE

DRIVER_RESTART

DRIVER_RESTART_COMPLETE

DRIVER_RESTART_RUNNING_TASK

DRIVER_RESTART_ACTIVE_CONTEXT

TASK_SUSPEND

DRIVER_SUBMIT

REEF_SUBMIT

LOCAL_JOB_SUBMIT

HTTP_REQUEST

HTTP_SERVER

Method Detail

getNewLoggingScope

getNewLoggingScope

getNewLoggingScope

driverStart

driverStop

setupBridge

evaluatorRequestorPassToCs

evaluatorRequestSubmitToJavaDriver

evaluatorSubmit

evaluatorAllocated

evaluatorLaunch

evaluatorCompleted

evaluatorFailed

activeContextReceived

closedContext

taskRunning

taskCompleted

taskSuspended

taskMessageReceived

contextMessageReceived

driverRestart

driverRestartCompleted

driverRestartRunningTask

driverRestartActiveContextReceived

httpRequest

httpServer

driverSubmit

reefSubmit

localJobSubmission