AbstractLoggingServiceMonitor (App Status Toolkit 2.0 API)

java.lang.Object
- net.sf.appstatus.core.services.AbstractServiceMonitor
- - net.sf.appstatus.core.services.AbstractLoggingServiceMonitor

All Implemented Interfaces:

IServiceMonitor

Direct Known Subclasses:

ServiceCall
```
public abstract class AbstractLoggingServiceMonitor
extends AbstractServiceMonitor
```
Default support implementation, with logging.

Author:

Nicolas Richeton

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`cacheHit`
`protected Map<String,String>`	`context`
`protected String`	`correlationId`
`protected Long`	`endTime`
`protected boolean`	`error`
`protected String`	`errorMessage`
`protected Long`	`executionTime`
`protected boolean`	`failure`
`protected Exception`	`failureException`
`protected String`	`failureReason`
`protected Object[]`	`parameters`
`protected long`	`startTime`

Constructor Summary

Constructors
Constructor and Description
`AbstractLoggingServiceMonitor(IService service, boolean enableLog, boolean useThreadLocal)`

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.
`protected org.slf4j.Logger`	`getLogger()`
`protected String`	`getLogMessage()` Returns the log message (at the end of the call).
`long`	`getStartTime()`
`void`	`setLogFormat(String messageFormat)` 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 l)` Set the logger to use for this service call.
`void`	`setMessageFormat(String messageFormat)` Deprecated. Use `setLogFormat(String)` instead

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

Methods inherited from interface net.sf.appstatus.core.services.IServiceMonitor
nestedCall

- Field Detail
  - cacheHit
```
protected boolean cacheHit
```
  - context
```
protected Map<String,String> context
```
  - correlationId
```
protected String correlationId
```
  - endTime
```
protected Long endTime
```
  - error
```
protected boolean error
```
  - errorMessage
```
protected String errorMessage
```
  - executionTime
```
protected Long executionTime
```
  - failure
```
protected boolean failure
```
  - failureException
```
protected Exception failureException
```
  - failureReason
```
protected String failureReason
```
  - parameters
```
protected Object[] parameters
```
  - startTime
```
protected long startTime
```
- Constructor Detail
  - AbstractLoggingServiceMonitor
```
public AbstractLoggingServiceMonitor(IService service,
                             boolean enableLog,
                             boolean useThreadLocal)
```
- Method Detail
  - beginCall
```
public void beginCall(Object... parameters)
```
    Description copied from interface: IServiceMonitor
    
    Notify of the beginning of a call to a service.
    
    Specified by:
    
    beginCall in interface IServiceMonitor
    
    Overrides:
    
    beginCall in class AbstractServiceMonitor
    
    Parameters:
    parameters - operation parameters
  - cacheHit
```
public void cacheHit()
```
    Description copied from interface: IServiceMonitor
    
    Reports that a cache system was used instead of performing the actual call.
  - context
```
public void context(String name,
           String value)
```
  - correlationId
```
public void correlationId(String correlationId)
```
  - endCall
```
public void endCall()
```
    Description copied from interface: IServiceMonitor
    
    Notify the end of a call to a service.
    
    Specified by:
    
    endCall in interface IServiceMonitor
    
    Overrides:
    
    endCall in class AbstractServiceMonitor
  - error
```
public void error(String message)
```
    Description copied from interface: IServiceMonitor
    
    Reports an error : the call has succeed but returns an error (with data).
  - executionTime
```
public void executionTime(long timeMillis)
```
    Description copied from interface: IServiceMonitor
    
    Manually set the execution time. If this method is not called, execution time is computed between beginCall and endCall.
  - failure
```
public void failure(String reason)
```
    Description copied from interface: IServiceMonitor
    
    Reports a failure : the call has failed completely
  - failure
```
public void failure(String reason,
           Exception e)
```
    Description copied from interface: IServiceMonitor
    
    Reports a failure : the call has failed completely with exception e.
  - getLogger
```
protected org.slf4j.Logger getLogger()
```
  - getLogMessage
```
protected String getLogMessage()
```
    Returns the log message (at the end of the call).
    This method can be overridden for very complex messages.
    
    Returns:
  - getStartTime
```
public long getStartTime()
```
  - setLogFormat
```
public void setLogFormat(String messageFormat)
```
    Description copied from interface: IServiceMonitor
    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
  - setLogger
```
public void setLogger(org.slf4j.Logger l)
```
    Description copied from interface: IServiceMonitor
    
    Set the logger to use for this service call.
  - setMessageFormat
```
@Deprecated
public void setMessageFormat(String messageFormat)
```
    Deprecated. Use setLogFormat(String) instead
    Set the log message format, 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:
    messageFormat -

Class AbstractLoggingServiceMonitor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.sf.appstatus.core.services.IServiceMonitor

Field Detail

cacheHit

context

correlationId

endTime

error

errorMessage

executionTime

failure

failureException

failureReason

parameters

startTime

Constructor Detail

AbstractLoggingServiceMonitor

Method Detail

beginCall

cacheHit

context

correlationId

endCall

error

executionTime

failure

failure

getLogger

getLogMessage

getStartTime

setLogFormat

setLogger

setMessageFormat