When developing flows with the Data Flow Manager (DFM) application, there are several methods to trace/debug a flow during its fine-tuning:
- Using the debug node
- Using the DFM Logs application
- Reviewing the system logs provided in IoT Server Configuration
Each of these logging methods serves different needs. The first allows for easy visualization of data moving through the flow, between nodes, at all points. The second offers access to the technical messages of each node, thereby understanding what's happening within the node itself. The last method enables the identification of more general system errors affecting the platform.
The debug Node
The debug node can be positioned at any point within the flow and connected to a node's output. The contents of the msg.payload will then be shown on the debugger panel located on the right side.
More information in the IoT Server Nodes documentation
Getting logs using DFM Logs application
Pre-requisite
- An IoT Server installed and onboarded
- An admin access to this IoT Server
Getting access
DFM Logs, for DataFlow Manager Logs, is an admin application running on the IoT Server. With an admin access you can open it from the homepage or your IoT Server
From there you can read live logs, change the settings, and export the latests logs.
Read live logs
Logs will refresh automatically, you can consult those logs at the same time as you work on your dataflow for example.
Logs displayed are non persistant, if you close and reopen DFM Log, items displayed will not reappear.
Change the settings
By clicking on the gear on the top-right corner you can open the settings pane.
From there you can set up the level of logs you desire between 6 options
-
fatal- record errors which make the application unusable -
error- record errors which are deemed fatal for a particular request -
warn- record problems which are non fatal -
info- record information about the general running of the application -
debug- record information which is more verbose than info -
trace- record very detailed logging for deep investigation
You can also set up some display settings in order to limit ressource consumption of the browser.
Finally, the latest options will help you set up the log level you wanna save on the log files of your IoT Server. This will be useful when you can't reproduce manually something and you want to catch it so you can download your logs file after it happens.
Download the logs
At every moment you will be able to play/pause the record of the live logs. When it is paused you can use the download button to get the file of what is on screen.
Getting logs using IoT Server Configuration
Pre-requisite
- An IoT Server installed and onboarded
- An admin access to this IoT Server
Getting access
IoT Configuration will give you the ability to download the latests logs of your IoT Server from the Braincube Cloud Platform. You can find more details about this solution here.
