Expand Collapse
Just a second...

Logging reference

Messages logged by Diffusion™ Cloud are logged at different levels depending on their severity.

Log levels

Diffusion Cloud events are logged at different levels of severity. The log levels, ordered from most severe to least severe, are as follows:

Table 1. Log levels
Level Description
ERROR Events that indicate a failure.
WARN Events that indicate a problem with operation.
INFO Significant events.

Log format

Each log line is made up of a number of fields. All of the fields except for the Exception are formatted on a single line, delimited by pipe (|) characters.

yyyy-MM-dd HH:mm:ss.SSS|Level|Thread|Code|Message|LoggerName Exception
Note: Sometimes log messages that are output to the same location as Diffusion Cloud messages can be from other products. You can see which messages are Diffusion Cloud messages by looking for the message code of the format PUSH-XXXXXX. All messages that Diffusion Cloud outputs at INFO level or above include this code.

The meaning of each field is described in the following table.

Table 2. Fields included in the logs
Field Optional or Mandatory Format/values stable between releases Description
Time stamp Mandatory Yes

The time and date the log event occurred.

Asynchronous logging is enabled by default. The server might log a message in a different thread to the one that produced the log event, and at a slightly later time. Consequently, log lines might not be logged in exact time stamp order.

The time stamp is displayed using the timezone configured for the Java Virtual Machine (JVM) running the server. The date format can be changed in the Server.xml configuration file.
Level Mandatory Yes The log severity, using the SLF4J levels: ERROR, WARN, INFO.
Thread Mandatory No The name of the Java™ thread that logged the event.
Code Optional Yes

Diffusion Cloud log messages have a unique code. For example, PUSH-000123. For more information, see .
Message Mandatory No A natural language description of the event.
Logger name Mandatory No The logger name. Usually the fully qualified name of the Java class that produced the event.
Exception Optional No If the log event has an associated Java Throwable, the exception message and stack trace directly follows the message line.

Optional fields are empty if the log event does not have the information.

The third column indicates whether fields are stable between releases. Where possible, Push Technology will not change the format or values of these fields so they can be relied on for automated log monitoring. The fields not marked as stable are more likely to change between releases, including patch releases.

Log message examples

Most log messages are formatted on a single line.

2016-02-19 14:01:31.199|INFO|main|PUSH-000159|The maximum message size is 32768 bytes.|com.pushtechnology.diffusion.DiffusionController

If a log event has an exception, the exception message and stack trace directly follows the message line. The exception can span multiple lines.

2016-02-19 14:14:54.095|ERROR|main|PUSH-000164|Diffusion Server not started.|com.pushtechnology.diffusion.api.server.DiffusionServer
com.pushtechnology.diffusion.server.security.persistence.store.StoreException: Error parsing SystemAuthentication.store
	at com.pushtechnology.diffusion.server.security.persistence.store.systemauthentication.DSLSystemAuthenticationProvider.parse(DSLSystemAuthenticationProvider.java:67)
	at com.pushtechnology.diffusion.server.security.persistence.store.AbstractFileProvider.connect(AbstractFileProvider.java:102)
	at com.pushtechnology.diffusion.server.security.persistence.store.AbstractStoreImpl.getModel(AbstractStoreImpl.java:71)
	at com.pushtechnology.diffusion.server.security.authentication.systemhandler.SystemAuthenticationHandler.<init>(SystemAuthenticationHandler.java:47)
	at com.pushtechnology.diffusion.server.security.persistence.store.systemauthentication.SystemAuthenticationStoreImpl.newHandler(SystemAuthenticationStoreImpl.java:75)
	at com.pushtechnology.diffusion.server.security.authentication.AuthenticationManagerProvider.provide(AuthenticationManagerProvider.java:107)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:498)

This page last modified: 2019/11/22