Description

<a href="https://opensource.newrelic.com/oss-category/#community-project"><picture> <source media="(prefers-color-scheme: dark)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/dark/Community_Plus.png"> <source media="(prefers-color-scheme: light)" srcset="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"> <img alt="New Relic Open Source community project banner." src="https://github.com/newrelic/opensource-website/raw/main/src/images/categories/Community_Plus.png"> </picture></a> # New Relic Python Agent [](https://github.com/newrelic/newrelic-python-agent/releases) [](https://pypi.python.org/pypi/newrelic) [](https://pypi.python.org/pypi/newrelic) [](https://pepy.tech/projects/newrelic) [](https://github.com/newrelic/newrelic-python-agent/actions/workflows/tests.yml) [](https://github.com/astral-sh/ruff) [](https://github.com/newrelic/newrelic-python-agent/actions/workflows/mega-linter.yml) [](https://codecov.io/gh/newrelic/newrelic-python-agent) [](https://github.com/aquasecurity/trivy) The `newrelic` package instruments your application for performance monitoring and advanced performance analytics with [New Relic](http://newrelic.com). Pinpoint and solve Python application performance issues down to the line of code. [New Relic APM](http://newrelic.com/application-monitoring) is the only tool you\'ll need to see everything in your Python application, from the end user experience to server monitoring. Trace problems down to slow database queries, slow 3rd party APIs and web services, caching layers, and more. Monitor your app in a production environment and make sure your app can stand a big spike in traffic by running scalability reports. Visit [Python Application Performance Monitoring with New Relic](http://newrelic.com/python) to learn more. ## Usage This package can be installed via pip: ```bash pip install newrelic ``` (These instructions can also be found online: [Python Agent Installation Guide](https://docs.newrelic.com/install/python/).) 1. Generate the agent configuration file with your [license key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/). ```bash newrelic-admin generate-config $YOUR_LICENSE_KEY newrelic.ini ``` 2. Validate the agent configuration and test the connection to our data collector service. ```bash newrelic-admin validate-config newrelic.ini ``` 3. Integrate the agent with your web application. If you control how your web application or WSGI server is started, the recommended way to integrate the agent is to use the `newrelic-admin` [wrapper script](https://docs.newrelic.com/docs/agents/python-agent/installation-configuration/python-agent-integration#wrapper-script). Modify the existing startup script, prefixing the existing startup command and options with `newrelic-admin run-program`. Also, set the **NEW_RELIC_CONFIG_FILE** environment variable to the name of the configuration file you created above: ```bash NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program $YOUR_COMMAND_OPTIONS ``` Examples: ```bash NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program gunicorn -c config.py test_site.wsgi $ NEW_RELIC_CONFIG_FILE=newrelic.ini newrelic-admin run-program uwsgi uwsgi_config.ini ``` Alternatively, you can also [manually integrate the agent](https://docs.newrelic.com/docs/agents/python-agent/installation-configuration/python-agent-integration#manual-integration) by adding the following lines at the very top of your python WSGI script file. (This is useful if you\'re using `mod_wsgi`.) ``` python import newrelic.agent newrelic.agent.initialize('/path/to/newrelic.ini') ``` 4. Start or restart your Python web application or WSGI server. 5. Done! Check your application in the [New Relic UI](https://rpm.newrelic.com) to see the real time statistics generated from your application. Additional resources may be found here: - [N