Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Cirrus Link modules support logging in the Ignition Gateway logs. Often when you are working with Cirrus Link support you will be asked to turn up a particular logger level to DEBUG or TRACE to assist in trouble shooting the issue.

Tip
From the Ignition UI connected to your instance of MQTT Distributor, navigate to Status > Diagnostic > Logs. Read the user manual Diagnostic - Logs explaining how to use the Logs console in Ignition 

Here we will document some of the common loggers and the extended information available in DEBUG and/or TRACE level. 

MQTT Transmission


MQTT Engine

MQTT Distributor

Set the debug level for the io.moquette.spi.impl.ProtocolProcessor logger to TRACE and set the filter of the Logs view to ProtocolProcessor.

...

Logger: com.cirruslink.mqttengine.gateway.sparkplug.sparkplugBPayloadHandler

Level: TRACE

Description: This will log the incoming messages in the SparkplugB namespace including topic and message payload.


Logger: com.cirruslink.mqttengine.gateway.json.JsonPayloadHandler

Level: TRACE

Description: This will log the incoming messages in a custom namespace when parsing the string payload as JSON


Logger: com.cirruslink.mqttengine.gateway.string.StringPayloadHandler

Level: TRACE

Description: This will log the incoming messages in a custom namespace when not parsing the string payload as JSON


MQTT Distributor

Logger: io.moquette.spi.impl.ProtocolProcessor

Level: DEBUG

Description: This will log the connect requests for MQTT Clients. This allows us to see if multiple clients with the same Client ID are trying to connect to the broker which causes Colliding Client IDs.

Image Added