Python agent and Waitress web server

This documentation contains requirements and tips for integrating the New Relic Python agent with an app that uses Waitress. To return to the general install instructions, go to Install New Relic for Python.

The New Relic Python agent provides support for the Waitress WSGI server. This includes automatically instrumenting the WSGI application entry point supplied to the Waitress server. The automatic instrumentation will work if the waitress.serve() API function is used directly, or if egg:waitress#main is specified as the server to use when starting up the web application using PasteDeploy.

Admin script integration method

You can use the recommended admin script integration method, as described in the general installation documentation.

Using PasteDeploy

If rather than manually integrating the call to startup the Waitress WSGI server in your application code, you are using PasteDeploy with a configuration similar to:

[server:main]
use = egg:waitress#main
host = 127.0.0.1
port = 8080

all you instead need to do to start up your WSGI application is wrap the running of the paster command:

NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program paster serve production.ini

For more help

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

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