Troubleshooting Ignition Issues
Here we have compiled a few helpful Troubleshooting Guides to help you diagnose and troubleshoot issues you may have with your Ignition software. They typically include various scenarios that you may find yourself in, and what to do in those situations, as well as some loggers that will be helpful in figuring out what is going wrong.
The loggers that are supplied with each guide are used to find and set loggers to a higher logging level, to give more detail to the issue. To use them, you will first want to navigate to the Gateway Status page. Once there, go to the the Logs page under Diagnostics.
On this page, you can then click the Settingsbutton on the right side of the page. This will bring up the Log Configuration window. Here, you can enter in one of the loggers that are listed on the troubleshooting page into the filter, and then change its logging level to either DEBUG or TRACE. This will cause that specific logger to report more detailed logs to the Logs page, allowing you to better diagnose the issue. If you set a parent logger to a specific level, it will set all children of that logger to the same level.
You may find that some of the loggers listed on the Troubleshooting Guide pages are not listed in your gateway. This is normal. The Gateway will add the appropriate loggers as you set systems in your Gateway up.
MDC Keys were introduced in 7.8.0, and allow you to quickly set all loggers that are related to a specific part of your Gateway. Instead of setting individual loggers to DEBUG, using the MDC key will set a group of loggers to the level you select all at once. Each guide will list out any MDC Keys that will relate to what the guide is covering.
Using MDC Keys is very simple. Again, you will want to navigate to the Gateway Status page, and go to the logs page under Diagnostics. Click on the settings button to bring up the Log Configuration but this time click on the 'Context' tab. Here, there are a few fields where you can enter in information. The first field, Key is where you will enter in the appropriate MDC Key. The field will list out appropriate Keys for you as you type, making it easier to find what you are looking for. For the Value field, you will want to enter in a value that is appropriate for the given MDC Key. This field also will list appropriate values for you to enter. In the example in the image below, with the Key being database, the value field has listed out all of the database connection names, making it easy to select which database you want to troubleshoot. Finally, you set the appropriate logging level in the Set Level field, typically to DEBUG or TRACE, and then hit the Add Level button. You can add as many of these as you would like, even with the same Key. So in the example below, you can first add my database called MSSQL, and then using the database Key again, add in the database called MySQL.This allows you to quickly and easily set the appropriate loggers to find out more information of the system you are trying to troubleshoot.
Each guide will also include one or more scenarios that you may find yourself in, and some steps you can take to troubleshoot. These can be as simple as determining where the problem actually is, making things run a little smoother when you contact support, to walking you through the problem and how to diagnose and fix it. These can be very useful, but it is important to understand that these are generic troubleshooting guides, and these scenarios might not apply to all systems, nor are they guaranteed to fix all problems.