How to generate debug log

Modified on Tue, 7 Sep, 2021 at 12:44 PM

If you face an issue in running Skedler, the support team will request you to run Skedler in debug mode and upload the log files. The steps to generate debug log files depend upon your Skedler version

Skedler v5

The easiest way to download the log files is from the Skedler UI using the steps below:

Click on the user profile image in the top right corner of Skedler UI.
Click Account Setting
Click Enable Debug Mode and Save
Reproduce the error scenario such as report creation or generation.
Go back to the Account Settings page.
Click Download Logs button situated on the right side of the UI
The log files will be downloaded as a zip file.

If you are unable to download the log files from the Skedler UI, you can access them from the following location:

Linux or Docker: /var/opt/skedler-xg/log
Windows: C:/skedler-xg-system-files

Please send the log files to the Skedler team at [email protected]. Alternatively, upload them to http://skedler.freshdesk.com.

Skedler v4

To generate debug log files for Skedler Reports v4.7.0 to 4.8.1, use the following method

Here is how you can enable Skedler Reports in debug mode and collect the log files. Go to Skedler Reports Configuration Page-> Advanced Settings then edit Other settings. By default, the value is set as false. You can modify the value as true and click the Save icon.

Note: To generate debug log files for Skedler Reports v4.6.2 and below, use the following method

Here is how you can run Skedler manually in debug mode and collect the log files.

If you're running Skedler manually, then use the following command,

bin/skedler debug

If you're running Skedler as service, then use the following command,

sudo service skedler start debug

If you have already started Skedler manually as bin/skedler or as service sudo service skedler, then you can dynamically turn on the debug mode without restarting Skedler using the following curl command,

To turn ON set the variable debugMode value to true

sudo curl -XPOST <skedlerURL>/loggerMode -d "debugMode=true"

To turn OFF set the variable debugMode value to false

sudo curl -XPOST <skedlerURL>/loggerMode -d "debugMode=false"

Location of the log files in Skedler v4

Once you have turned the debug mode, reproduce the issue and collect the log files from the following location,

You can find the log files in:

Skedler reports log files from the following directory. Look for skedler.log, debuglog.txt and skedler-elasticsearch.log.
- For Linux/Windows in skedler_home/log/ directory.
- For Debain/RPM in /var/log/skedler-reports/ directory.
- For Docker in /var/lib/skedler/log/ directory.
- For AMI in /skedler/log/ directory.
Skedler license log file skedler_home/log/license.log (For Windows: skedler_home/bin/lexlog.txt)

Send the three log files to [email protected] . Alternatively, upload them to http://skedler.freshdesk.com.