Banner: Turn It Up
Sunday, October 20, 2019

DEBUG LOGGING

From time to time, as part of testing, you might be asked to submit LMS logs. These logs help track down particular problems when a basic description does not suffice.

The LMS and, in turn, the Alexa plugin, support several levels of logging. Normally, you want these set to a low level to ensure that the (quite) verbose debug output does not clog up your log files. If requested to submit details logs, here's how to turn them on;

 

1. Set up extended logging in the plugin

In the LMS settings interface, access the Alexa plugin settings page and scroll to the bottom. Here you will see the 'Extended Debugging' checkbox. Ensure it's enabled and click 'Apply' to save the setting.


2. Configure LMS Logging

Next, still in LMS settings, click on the 'Advanced' tab and choose 'Logging' from the drop-down menu.

First, ensure that the 'save logging settings' is checked at the top of the 'Advanced Log Settings' section;

 

Then, scroll down the page to find the '(plugin alexa) - Alexa' line item. Here, in the drop-down, change the logging level to 'Debug' as follows;

 

Once everything is set, hit 'Apply' to save.

 

3. Finding your Log File

Ultimately, you will need to send your log file for analysis. It's best to have a 'clean' file. That is, one that contains  a fresh LMS session and includes logs of the issue at hand, but nothing else. To achieve this, you will need to;

a) Clear Your Log File

b) Restart LMS

c) Conduct the test

d) Close LMS

e) Submit the log file

 

Your log file will be in a different location depending on your LMS host platform. There are a few ways of finding it. On all platforms,. you can open LMS Settings->Advanced->Logging. At the top of this page, you will see the path to your log file and can even open it in your browser;

 

 

If your LMS is running on Windows, you can access the LMS Control panel, click on the 'Advanced; tab and find a link to the server log files as highlighted here;

 

 

 

In either case, you should shut down your LMS, open the log file in a text editor, clear all contents and save the file. You are then ready to conduct the test.

 

4. Conclusion

It's worth restating: it's best to submit a clean log file that includes LMS startup and the error only. Therefore, before each test, please clean the log file and launch LMS. Save each log individually for submission.

Once your testing is done, revert the logging changes to ensure your log file does not fill unnecessarily.

 

Login Form