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 troubleshooting the issue.

Tip
From the Ignition UI connected to your instance of MQTT Distributor, navigate to Status > Diagnostic > Logs. Read the user manual Diagnostics - 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

Logger: com.cirruslink.mqtt.transmission.gateway.TransmissionClient

Level: TRACE

Description: This will log each published message including topic and payload

MQTT Engine

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

Level: TRACE

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

Note: At TRACE this logger is very noisy and will quickly fill up Ignition logs


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

Level: TRACE

Description: This will log a message for each tag included in the message payload as it is updated at MQTT Engine. The logged message includes tag path, value and timestamp. This logger also includes in incoming UDT definitions if included in NBIRTH messages

Note: At TRACE this logger is very noisy and will quickly fill up Ignition logs


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

...

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.


Logger: com.cirruslink.cahriotchariot.server.core.PacletHandler PacketHandler (4.0.14 and newer)

Level: DEBUG

...