Error Reporting

The easiest way of reporting any message or error from inside an Iotellect driver or plugin is using a standard logging facility. Iotellect uses Log4j library for logging. Logging a message requires just one line of Java code:

Logger.getLogger("ag.core").info("A message");

/* or */

Logger.getLogger("ag.device.acme").error("Unexpected error", exception);

The Log4j library documentation offers comprehensive documentation for all aspects of logging configuration and implementation.

The Log class provides pre-defined loggers for common Iotellect logging categories. Here is a usage example:

Log.CORE.info("A message");

Error Reporting via Iotellect Events

Messages and errors reported through the logging facility are not visible to system operators. Only system administrators having access to machine running Iotellect Server or Iotellect Client will be able to check the log files. Redirecting logging output to other destinations will still hardly make it available to the operators.

To make any message or problem visible to one or more system operators, report it by firing an Iotellect event of Info type:

  • Retrieve an instance of a relevant Context via ContextManager.get(). This could be a device context (if reporting an issue from a driver), an administration context (if reporting a system-wide issue, such as a plugin startup problem), or any other Iotellect Server context.
  • Call Context.fireEvent() to generate a new context event. The event will be stored in the server database and routed to subscribed listeners (e.g. Event Logs), making it accessible by system operators and administrators.

The below example illustrates how to report an internal recoverable error from a device driver:

Context deviceContext = getDeviceContext();

deviceContext.fireEvent(AbstractContext.E_INFO, "Something happened inside the driver");

Was this page helpful?