ITracer (sitewhere-server-api 1.9.0 API)

```
public interface ITracer
```
Pluggable debug facility that allows hierarchical data execution information to be stored for later analysis.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`asHtml()` Returns output from trace as HTML.
`void`	`debug(java.lang.String message, org.apache.logging.log4j.Logger logger)` Store or log a debug message.
`void`	`error(java.lang.String message, java.lang.Throwable error, org.apache.logging.log4j.Logger logger)` Store or log an error message.
`void`	`info(java.lang.String message, org.apache.logging.log4j.Logger logger)` Store or log an informational message.
`boolean`	`isEnabled()` Indicates if the tracer is enabled.
`void`	`pop(org.apache.logging.log4j.Logger logger)` Pops back up a level on the trace stack.
`void`	`push(TracerCategory category, java.lang.String message, org.apache.logging.log4j.Logger logger)` Pushes another level into the trace stack.
`void`	`setEnabled(boolean enabled)` Enables or disables the tracer.
`void`	`start(TracerCategory category, java.lang.String message, org.apache.logging.log4j.Logger logger)` Start tracing.
`void`	`stop(org.apache.logging.log4j.Logger logger)` Stop tracing.
`void`	`timing(java.lang.String message, long delta, java.util.concurrent.TimeUnit unit, org.apache.logging.log4j.Logger logger)` Store timing information.
`void`	`warn(java.lang.String message, java.lang.Throwable error, org.apache.logging.log4j.Logger logger)` Store or log an warning message.

Method Detail

start

void start(TracerCategory category,
           java.lang.String message,
           org.apache.logging.log4j.Logger logger)

Start tracing.

Parameters:: category -; message -; logger -

stop

void stop(org.apache.logging.log4j.Logger logger)

Stop tracing.

Parameters:: logger -

isEnabled
```
boolean isEnabled()
```
Indicates if the tracer is enabled.

Returns:

setEnabled
```
void setEnabled(boolean enabled)
```
Enables or disables the tracer.

Parameters:

enabled -

asHtml
```
java.lang.String asHtml()
                 throws java.lang.UnsupportedOperationException
```
Returns output from trace as HTML. Implementations can throw an UnsupportedOperationException if they are stateless.

Returns:

Throws:

java.lang.UnsupportedOperationException

push

void push(TracerCategory category,
          java.lang.String message,
          org.apache.logging.log4j.Logger logger)

Pushes another level into the trace stack.

Parameters:: category -; message -; logger -

pop
```
void pop(org.apache.logging.log4j.Logger logger)
```
Pops back up a level on the trace stack.

Parameters:

logger -

debug

void debug(java.lang.String message,
           org.apache.logging.log4j.Logger logger)

Store or log a debug message.

Parameters:: message -; logger -

info

void info(java.lang.String message,
          org.apache.logging.log4j.Logger logger)

Store or log an informational message.

Parameters:: message -; logger -

warn

void warn(java.lang.String message,
          java.lang.Throwable error,
          org.apache.logging.log4j.Logger logger)

Store or log an warning message.

Parameters:: message -; error -; logger -

error

void error(java.lang.String message,
           java.lang.Throwable error,
           org.apache.logging.log4j.Logger logger)

Store or log an error message.

Parameters:: message -; error -; logger -

timing

void timing(java.lang.String message,
            long delta,
            java.util.concurrent.TimeUnit unit,
            org.apache.logging.log4j.Logger logger)

Store timing information.

Parameters:: message -; delta -; unit -; logger -

Interface ITracer