New Relic for Python

You will find links to detailed information about the Python agent here. For additional information about general issues and details of any missing features in this document, see Status of Python agent.

System requirements

Resource Requirements
Operating systems UNIX-like operating systems including Linux, Solaris, FreeBSD and Mac OS X.
Python Versions 2.6, 2.7, 3.3 (CPython/PyPy)
Web frameworks Supported WSGI web frameworks include Bottle, CherryPy, Django, Flask, Pylons, Pyramid, and Web2Py.
Hosting Web hosting mechanisms compliant with WSGI 1.0 (PEP 333).
Security requirements As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.

Instrumentation is also provided for a range of other Python packages and modules. Such instrumentation covers areas such as database queries, memcache requests and external service requests. Results from these will also show up automatically within web transaction performance breakdowns and transaction traces for slow transactions.

Unsupported WSGI frameworks

Although a specific Python WSGI web framework may not be supported, the agent can still be used.

For unsupported frameworks, a breakout of time spent in key parts of the framework will not be available by default in Web transaction performance breakdowns and transaction traces for slow transactions. Web transactions handled by specific handlers in your code, which make it more useful and targeted, will not be meaningfully grouped. In these cases you can use our agent API to name web transactions or add custom instrumentation.

Downloading the agent

The most recent Python agent package is available for users who are logged in to New Relic or from our agent repository. Find information about the latest release in the Python agent release notes.

The package can also be installed using Python packaging tools such as pip, easy_install, distribute or buildout via the Python Package Index.

Installation instructions

To use the Python agent, you first need to have a New Relic account.

For supported WSGI servers and web frameworks, follow the Python agent quick start guide. If you use Heroku, see the Heroku quick start guide. If the quick start guides don't cover your web stack, or if you have special requirements around how the package needs to be installed, see the detailed Python agent installation instructions.

See further details about specific WSGI servers, web frameworks or web hosting services.

Agent configuration

The Python agent is configured in the agent configuration file. For detailed information about available options, see Python agent configuration and Python agent logging.

Troubleshooting

If your web application is receiving requests, data should appear in the New Relic UI within 2 to 3 minutes. If not, see No data appears.

For more help

Additional documentation resources include:

Join the discussion about Python in the New Relic Community Forum! The Community Forum is a public platform to discuss and troubleshoot your New Relic toolset.

If you need additional help, get support at support.newrelic.com.