bchedx

Debug Open edX errors

Locate log files

The Open edX log files are stored at different paths depending on the service:

  • edX Platform log files are stored at /opt/bitnami/apps/edx/var/log.
  • XQueue log files are stored at /opt/bitnami/apps/xqueue/var/log.

Increase the log level in Open edX Hawthorn.2 and later

By default, both services are configured with an “info” log level. To increase the log level on each service in order to debug your application, follow the steps below:

  • Open the edX Platform configuration files /opt/bitnami/apps/edx/conf/cms.yml and /opt/bitnami/apps/edx/conf/lms.yml with an editor, and substitute the value:

      LOCAL_LOGLEVEL: INFO,
    

    with this:

      LOCAL_LOGLEVEL: DEBUG,
    
  • Open the XQueue configuration file /opt/bitnami/apps/xqueue/conf/xqueue.yml, change the following value:

      LOCAL_LOGLEVEL: INFO
    
  • with:

      LOCAL_LOGLEVEL: DEBUG
    
  • Restart the Apache server and edX services to load the changes.

      $ sudo /opt/bitnami/ctlscript.sh restart apache
      $ sudo /opt/bitnami/ctlscript.sh restart edx
      $ sudo /opt/bitnami/ctlscript.sh restart xqueue
    

Enable tracking logs in Koa.1

To enable tracking logs in Koa, update the log format string in the /opt/bitnami/apps/edx/edx-platform/openedx/core/lib/logsettings.py file so that it looks like this:

logger_config = {
    'version': 1,
    'disable_existing_loggers': False,
    'formatters': {
        'standard': {
            'format': u'%(asctime)s %(levelname)s %(process)d '
                      '[%(name)s]  %(filename)s:%(lineno)d - %(message)s',
        },

Troubleshoot errors sending bulk email

You may encounter errors sending bulk email from the instructor tab. This is usually because the bulk email subsystem requires the Lynx plaintext browser to convert HTML email to plaintext (discussed at https://github.com/edx/edx-platform/wiki/Bulk-Email#required-packages).

To resolve this, install the Lynx browser using the command below:

  • Debian:

      $ sudo apt-get install lynx
    
  • CentOS:

      $ sudo yum install lynx
    
Last modification March 25, 2021