Python agent compatibility

The Python agent is compatible with the most popular web frameworks, operating systems and web servers. Below you can find more details about specific version compatibility.

Refer to the installation steps to install Sqreen in your Python applications.

Other framework?

We are working on supporting more frameworks. Please, contact us if you are using a different framework. We are happy to revisit our roadmap!

Python versions

The Sqreen Python agent is fully compatible with:

  • Python 2.7
  • Python 3.4 and newer

Python frameworks

The Python agent is fully compatible with:

  • Django 1.6 and newer. Sqreen is not compatible with Django in ASGI mode yet.
  • Flask 0.10 and newer
  • Pyramid 1.6 and newer
  • aiohttp 2.2 to 2.3, 3.0 and 3.1
  • Pylons

The aiohttp server needs to use either the built-in asyncio event loop or uvloop.

Operating systems

Sqreen supports the Python agent on the following operating systems:

  • macOS
  • Linux

Servers

The Python agent is fully compatible with all the most popular WSGI Servers:

The Python agent is fully compatible with uWSGI servers. When using uWSGI, you need to include some options:

  • --enable-threads, by default uWSGI doesn't permit the creation of threads. The Python agent requires threads for performance reasons.
  • --single-interpreter, by default with uWSGI, every app loads in a new Python interpreter. The Python agent is only compatible when your application loads on the same Python VM.
  • --py-call-osafterfork, by default uWSGI doesn't execute cleanup code on threads after forking while its the default behavior. This option re-enable it.

Additionnaly, if you use the --master mode on uWSGI and see no data being reported to Sqreen, you should also enable the --lazy-apps option. In fact, by default uWSGI will preload your application in a master process and Sqreen could be prevented from starting properly in the worker processes. Alternatively, if you still want to use preloading, we recommend using uwsgidecorators.postfork in your WSGI script instead of using the sqreen-start CLI helper. It will delay starting Sqreen after the master process has forked:

from uwsgidecorators import postfork

@postfork
def delayed_start():
    try:
        import sqreen
        sqreen.start()
    except ImportError:
        pass

The Python agent is fully compatible with the aiohttp.web server. This feature is in beta mode.

Other server?

Please, contact us if you are using a different web server or a configuration we do not yet support. We are happy to revisit our roadmap!

Databases

Sqreen protects against SQL and NoSQL injections for the most common production databases:

  • MySQL
  • PostgreSQL
  • SQLite

Other database?

Please, contact us if you are using a different database. We are happy to revisit our roadmap!

Templating engines

Protection against cross-site scripting attacks (XSS) is available for the most widespread templating engines in Python:

  • Django templating engine
  • Jinja2 templating engine

Other templating engine?

Please, contact us if you are using a different templating engine. We are happy to revisit our roadmap!

Automatic user context in Python

Sqreen automatically detects and protects user accounts when your application uses the Django framework. For other frameworks or specific authentication methods, refer to advanced User Context in Python, using Python SDK for user monitoring.

To monitor and protect your users, the Python agent hooks the Django authenticate function. This allows the Sqreen Python agent to work with any authentication backend.

Django user identifiers

The Sqreen Python agent automatically detect the user identifier information. Sqreen accepts any of the following argument values as your users identifier:

  • username
  • email
  • user
  • mail
  • login
  • name
  • id
  • userid
  • user_id
  • identification

If you don't see any authentication attempt on your dashboard, check that your code is actually calling the standard Django authenticate function and that at least one keyword argument match the list above and its value is not None.

Other authentication backend?

Please, contact us if you are using an authentication backend that is not using one of those argument.

Sqreen and NewRelic agents

The Sqreen and NewRelic Python agents are compatible.

If you use the CLI helpers, put sqreen-start before newrelic-admin:

sqreen-start newrelic-admin gunicorn ...

If you modify the WSGI file, import Sqreen before NewRelic:

try:
    import sqreen
    sqreen.start()
except ImportError:
    pass

try:
    import newrelic.agent
    newrelic.agent.initialize('newrelic.ini')
except ImportError:
    pass

Sqreen usage for non-web applications

Sqreen detects non-web applications at launch time (application working without a web server). Sqreen doesn't automatically run in the following cases:

  • Tests launchers
  • iPython interpreters
  • Celery workers
  • RQ workers
  • Django and Flask interactive interpreter (manage.py shell).

If you want to disable Sqreen when launching an application, you can add the SQREEN_DISABLE=1 environment variable.