Content Platform Engine logging
The Content Platform Engine server and Java client APIs are capable of producing log messages to assist in system health monitoring and problem diagnosis. Logging statements are present in the Content Platform Engine code which, when enabled, result in log messages being written to an output file in textual form. These files can then be analyzed by automated tools or by IBM support personnel.
Log messages are of different levels, reflecting their character, importance, and the
volume in which they are produced when enabled. The levels are described in the following
table:
| Level | Description |
| Error | Report a failure of some kind in the server or client library. These will usually interrupt the operation in progress and result in an exception being returned to the client application, but this is not always the case. |
| Warning | A warning condition is one where a divergence from the expected behavior has occurred but this has not prevented the operation in question from proceeding. |
| Informational | Informational messages report significant events in normal operation of the server or client. |
| Summary Trace | Trace messages provide diagnostic information for problem analysis. The summary level is the least detailed and least verbose of the tracing levels. |
| Moderate Trace | Moderate tracing produces additional information beyond that of summary. |
| Detailed Trace | This level produces the greatest amount of detail and volume of logging. |
| Timer Trace | This is a variant of detailed tracing which concerns itself solely with reporting elapsed time for specific operations. Only the Content Engine produces timer trace messages. |
The server designates the first three levels as system logging and the remainder, as their names imply, as trace logging. This distinction is reflected in the manner by which logging is controlled and to where the messages are logged. The APIs do not make any such distinction, simply treating the levels as a single spectrum.