• /
  • Log in
  • Free account

Advanced install of New Relic Python agent

This is a detailed guide showing how to install New Relic's Python agent for application performance monitoring. For simpler install instructions that will work for the majority of Python frameworks (including Django), see the standard installation guide. Read this advanced guide if you cannot use the standard install, or if you want more detailed information about the installation steps.

Requirements

Before you install the Python agent:

Summary of install process

Here's a summary of how to install the Python agent:

  1. Download and install the Python agent package.
  2. Create config file.
  3. Integrate the agent with your app.
  4. Restart your app.

You can also install the Python agent in a Google App Engine flexible environment or use other hosting services, such as Heroku.

1. Download and install

Download and install the agent package using your preferred procedure. For example:

2. Create config file

The config file is the primary method to customize the agent's behavior. You can also use server-side configuration or environment variables.

After you install the package, the newrelic-admin script will be in the same directory as the Python executable. To create the agent config file, run this command in the Python executable's directory and include your license key:

newrelic-admin generate-config YOUR_LICENSE_KEY newrelic.ini

The generate-config command creates the newrelic.ini config file.

3. Integrate the agent

You need to integrate the Python agent with your application so that your app's major functions and web requests are received by the agent. To integrate the Python agent with your app, run the newrelic-admin script in front of your usual app startup command.

If you use any of the following services, follow these guidelines before continuing to the admin script procedure.

To run the newrelic-admin script via the command line, place the following in front of your standard app startup command:

  1. The path to the New Relic config file
  2. The newrelic-admin run-program script command

For example, here are instructions for a Bourne-style shell. You may need to adjust these instructions for a different shell. If you use a Python gunicorn web server and your startup command is:

gunicorn -w 3 wsgi:application

Then use this command:

NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program gunicorn -w 3 wsgi:application

For more details about using the admin script, see Running the admin script from command line. If you cannot use the admin script method or don't want to, see the manual integration method.

4. Restart app and check for data

When you finish the integration procedure:

  1. Restart your app server.
  2. Wait five minutes.
  3. View your app's data in APM's Summary page.

If data does not appear after five minutes, follow the troubleshooting procedures.

Additional steps

Here are some suggested next steps after installing the Python agent for your app:

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.