Logging

When building a connector, you can utilize the operation log, document log, and container log. The operation and document logs are readily available in the Build tab and the Process reporting page.

Whenever possible, use the execution logs instead of the container logs.

Execution log statements do not need to be guarded by a check for the current log level because the Atom handles this. Additionally, execution loggers are only applicable to the current execution, so they should not be stored in static variables or cached for later use.

• Operation log — Use when logging information that is relevant to the current execution (i.e., it is not information that is specific to a single input document). An operation log instance can be obtained by calling OperationResponse.getLogger() (see the Javadocs).
• Document log — Use when logging information that is only relevant to the current document being processed (i.e., it is not information that applies to all input documents). A document log instance can be obtained by calling TrackedData.getLogger() (see the Javadocs).
• Container log — Use when no execution logs are available. A container log instance can be obtained by calling Logger.getLogger(String name). Loggers obtained this way should be stored in static variables.

note

There is currently no browse log, so the only available option during browse or import is the container log.