nativeInstalleredx

Debug Open edX errors

Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and Mac OS X) or by clicking the shortcut in the Start Menu under “Start -> Bitnami APPNAME Stack -> Application console” (Windows). Learn more.

Locate log files

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

  • edX Platform log files are stored at installdir/apps/edx/var/log.
  • XQueue log files are stored at installdir/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 installdir/apps/edx/conf/cms.env.json and installdir/apps/edx/conf/lms.env.json with an editor, and substitute the value:

    "LOCAL_LOGLEVEL": "INFO",
    

    with this:

    "LOCAL_LOGLEVEL": "DEBUG",
    
  • Open the XQueue configuration file installdir/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 installdir/ctlscript.sh restart apache
    $ sudo installdir/ctlscript.sh restart edx
    $ sudo installdir/ctlscript.sh restart xqueue
    

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