virtualMachineedx

Debug Open edX errors

NOTE: We are in the process of modifying the file structure and configuration for many Bitnami stacks. On account of these changes, the file paths stated in this guide may change depending on whether your Bitnami stack uses native Linux system packages (Approach A), or if it is a self-contained installation (Approach B). To identify your Bitnami installation type and what approach to follow, run the command below:

 $ test ! -f "/opt/bitnami/common/bin/openssl" && echo "Approach A: Using system packages." || echo "Approach B: Self-contained installation."

The output of the command indicates which approach (A or B) is used by the installation, and will allow you to identify the paths, configuration and commands to use in this guide. Refer to the FAQ for more information on these changes.

Locate log files

The Open edX log files are stored in the following paths, depending on your installation type:

* Approach A (Bitnami installations using system packages):

    * edX Platform (LMS, Studio CMS and workers): */opt/bitnami/edx/var/log/edx*.
    * XQueue: */opt/bitnami/edx/var/log/xqueue*.

* Approach B (Self-contained Bitnami installations):

    * edX Platform (LMS, Studio CMS and workers): */opt/bitnami/apps/edx/var/log*.
    * XQueue: */opt/bitnami/apps/xqueue/var/log*.

Increase the log level

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 for LMS and Studio CMS, and substitute the value:

    NOTE: Depending on your installation type, the LMS and Studio CMS configuration files will be located in the following paths, respectively:

    • Approach A (Bitnami installations using system packages): /opt/bitnami/edx/etc/lms.yml and /opt/bitnami/edx/etc/studio.yml.

    • Approach B (Self-contained Bitnami installations): /opt/bitnami/apps/edx/conf/lms.yml and /opt/bitnami/apps/edx/conf/cms.yml.

      LOCAL_LOGLEVEL: INFO,
    

    with this:

      LOCAL_LOGLEVEL: DEBUG,
    
  • Open the XQueue configuration file and change the following value:

    NOTE: Depending on your installation type, the XQueue configuration file will be located in the following paths:

    • Approach A (Bitnami installations using system packages): /opt/bitnami/edx/etc/xqueue.yml.

    • Approach B (Self-contained Bitnami installations): /opt/bitnami/apps/xqueue/conf/xqueue.yml.

      LOCAL_LOGLEVEL: INFO
    

    With:

      LOCAL_LOGLEVEL: DEBUG
    
  • Restart all services to reload the changes.

      $ sudo /opt/bitnami/ctlscript.sh restart
    

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:

    $ sudo apt-get install lynx
Last modification May 10, 2022