IServiceMonitor (App Status Toolkit 2.0 API)

All Known Implementing Classes:

AbstractLoggingServiceMonitor, AbstractServiceMonitor, ServiceCall
```
public interface IServiceMonitor
```
Service monitor

Author:

Guillaume Mary, Nicolas Richeton

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`beginCall(Object... parameters)` Notify of the beginning of a call to a service.
`void`	`cacheHit()` Reports that a cache system was used instead of performing the actual call.
`void`	`context(String name, String value)`
`void`	`correlationId(String correlationId)`
`void`	`endCall()` Notify the end of a call to a service.
`void`	`error(String message)` Reports an error : the call has succeed but returns an error (with data).
`void`	`executionTime(long timeMillis)` Manually set the execution time.
`void`	`failure(String reason)` Reports a failure : the call has failed completely
`void`	`failure(String reason, Exception e)` Reports a failure : the call has failed completely with exception e.
`void`	`nestedCall()` Report that another service was called in order to perform original action
`void`	`setLogFormat(String format)` Set the log message format for this monitor instance, based on : http://commons.apache.org/lang/api-release/org/apache/commons/lang3/text/ StrSubstitutor.html Example : `${correlationId}\|${group}\|${name}\|${responseTime}\|${cache}\|${status}\|${statusMessage}` Available variables : group name responseTime cache failure failureReason failureException error errorMessage correlationId status : SUCCESS/FAILURE/ERROR statusMessage : failure or error message Any additional context values
`void`	`setLogger(org.slf4j.Logger logger)` Set the logger to use for this service call.

- Method Detail
  - beginCall
```
void beginCall(Object... parameters)
```
    Notify of the beginning of a call to a service.
    
    Parameters:
    operationName - operation name
    parameters - operation parameters
  - cacheHit
```
void cacheHit()
```
    Reports that a cache system was used instead of performing the actual call.
  - context
```
void context(String name,
           String value)
```
  - correlationId
```
void correlationId(String correlationId)
```
  - endCall
```
void endCall()
```
    Notify the end of a call to a service.
  - error
```
void error(String message)
```
    Reports an error : the call has succeed but returns an error (with data).
    
    Parameters:
    message -
  - executionTime
```
void executionTime(long timeMillis)
```
    Manually set the execution time. If this method is not called, execution time is computed between beginCall and endCall.
  - failure
```
void failure(String reason)
```
    Reports a failure : the call has failed completely
    
    Parameters:
    reason -
  - failure
```
void failure(String reason,
           Exception e)
```
    Reports a failure : the call has failed completely with exception e.
    
    Parameters:
    reason -
    e -
  - nestedCall
```
void nestedCall()
```
    Report that another service was called in order to perform original action
  - setLogFormat
```
void setLogFormat(String format)
```
    Set the log message format for this monitor instance, based on : http://commons.apache.org/lang/api-release/org/apache/commons/lang3/text/ StrSubstitutor.html
    Example : ${correlationId}|${group}|${name}|${responseTime}|${cache}|${status}|${statusMessage}
    
    Available variables :
    - group
    - name
    - responseTime
    - cache
    - failure
    - failureReason
    - failureException
    - error
    - errorMessage
    - correlationId
    - status : SUCCESS/FAILURE/ERROR
    - statusMessage : failure or error message
    - Any additional context values
    Parameters:
    format -
  - setLogger
```
void setLogger(org.slf4j.Logger logger)
```
    Set the logger to use for this service call.
    
    Parameters:
    logger -

Interface IServiceMonitor

Method Summary

Method Detail

beginCall

cacheHit

context

correlationId

endCall

error

executionTime

failure

failure

nestedCall

setLogFormat

setLogger