Debugging a Flask app running in Gunicorn

by

The accepted solution doesn’t work for me.

Gunicorn is a pre-forking environment and apparently the Flask debugger doesn’t work in a forking environment.

Attention

Even though the interactive debugger does not work in
forking environments (which makes it nearly impossible to use on
production servers) […]

Even if you set app.debug = True, you will still only get an empty page with the message Internal Server Error if you run with gunicorn testserver:app. The best you can do with gunicorn is to run it with gunicorn --debug testserver:app. That gives you the trace in addition to the Internal Server Error message. However, this is just the same text trace that you see in the terminal and not the Flask debugger.

Adding the if __name__ ... section to the testserver.py and running python testserver.py to start the server in development gets you the Flask debugger. In other words, don’t use gunicorn in development if you want the Flask debugger.

app = Flask(__name__)
app.config['DEBUG'] = True

if __name__ == '__main__':
    app.run()

## Tip for Heroku users:
Personally I still like to use `foreman start`, instead of `python testserver.py` since [it sets up all the env variables for me](https://devcenter.heroku.com/articles/config-vars#using-foreman). To get this to work:

Contents of Procfile

web: bin/web

Contents of bin/web, file is relative to project root

#!/bin/sh

if [ "$FLASK_ENV" == "development" ]; then
        python app.py
else
        gunicorn app:app -w 3
fi

In development, create a .env file relative to project root with the following contents (docs here)

FLASK_ENV=development
DEBUG=True

Also, don’t forget to change the app.config['DEBUG']... line in testserver.py to something that won’t run Flask in debug mode in production.

app.config['DEBUG'] = os.environ.get('DEBUG', False)

More Related Contents:

  1. How many concurrent requests does a single Flask process receive?
  2. Flask Gunicorn app can’t get __name__ to equal ‘__main__’
  3. How to run Flask with Gunicorn in multithreaded mode
  4. Gunicorn can’t find app when name changed from “application”
  5. How to use Flask-Script and Gunicorn
  6. Sharing a lock between gunicorn workers
  7. How to pass a variable between Flask pages?
  8. Why does running the Flask dev server run itself twice?
  9. How can I add a background thread to flask?
  10. Python Flask Intentional Empty Response
  11. Display image stored as binary blob in template
  12. Why does the session cookie work when serving from a domain but not when using an IP?
  13. Running a Dash app within a Flask app
  14. Passing a matplotlib figure to HTML (flask)
  15. How do I set response headers in Flask?
  16. Restrict static file access to logged in users
  17. Remove unnecessary whitespace from Jinja rendered template
  18. Flask sqlalchemy many-to-many insert data
  19. How to delete a record by id in Flask-SQLAlchemy
  20. How to send image generated by PIL to browser?
  21. How to schedule a function to run every hour on Flask?
  22. Method Not Allowed flask error 405
  23. How to obtain values of request variables using Python and Flask [duplicate]
  24. Clear valid form after it is submitted
  25. Python Flask, TypeError: ‘dict’ object is not callable
  26. Make a Python asyncio call from a Flask route
  27. Returning rendered template with Flask-Restful shows HTML in browser
  28. How to generate dynamic urls in flask?
  29. How to install Flask on Windows?
  30. Global variables in Flask templates

Leave a Comment