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

ResourceRequirements
Operating systems UNIX like operating systems including as Linux, Solaris, FreeBSD and MacOS X.
Python Versions 2.6, 2.7, 3.3 (CPython/PyPy)
Web frameworks Specific targeted instrumentation is required for the different Python web frameworks. The supported WSGI web frameworks include Bottle, CherryPy, Django, Flask, Pylons, Pyramid, and Web2Py. New Relic also supports the Tornado web framework.
Hosting The agent should be able to be used with any WSGI 1.0 (PEP 333) compliant Python web hosting mechanism.

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 Wwb 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 software

The most recent Python agent package is available for users who are logged in to New Relic from our Help Center within the New Relic site or from our software download site.

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

To get to the Help Center:

  1. Log into http://rpm.newrelic.com
  2. From the New Relic title bar, select Help > Help Center.
  3. From the Help Center page, select the links to view the latest release information and download the agent.

Information on version change can be found in the Python agent release notes.

Installation instructions

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

For most supported WSGI servers and web frameworks follow the Python agent quick start guide.

If using Heroku, see the Heroku quick start guide.

If the quick start guides don't cover your specific web stack, or if you have special requirements around how the package needs to be installed, see Python agent installation.

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

Note: As part of the installation process, change the default application name to a meaningful name.

Agent configuration

The Python agent is configured in the agent configuration file. For details on the options which can be set see Python agent configuration.

Additional information on configuring agent logging can be found in Python agent logging.

Troubleshooting

If your web application is receiving requests, data should appear in New Relic's Applications Overview dashboard within 2-3 minutes.

If no data appears after a few minutes, check for errors within the Python agent log file. This log file will be located at the location specified in the Python agent configuration file. If the log file is not configured, enable it as described in documentation on Python agent logging.

If this does not show anything and you have not already performed the Python agent test, ensure you run the procedure described in the documentation on testing the Python agent.

If the Python agent test checks out okay, then increase the log_level to "debug" for your web application and capture about 5 minutes of logging output, ideally upon a re-start and after hitting the web application with requests continuously for 30 seconds so we see exactly what happens. Provide this information when logging a support request with us.

For more help

Additional documentation resources include:

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