[Issue #3127] Add a New Relic agent to the API #3130
Conversation
api/src/app.py
Outdated
| @@ -67,6 +68,8 @@ def create_app() -> APIFlask: | |||
| if os.getenv("ENVIRONMENT") == "local": | |||
| initialize_jwt_auth() | |||
|
|
|||
| init_newrelic() | |||
There was a problem hiding this comment.
Doesn't this need to happen before anything else? We did that before / the New Relic docs say that needs to happen.
https://docs.newrelic.com/install/python/?python-non-web=non-web-yes#integrating
It might be that this needs to be done for multi-threading purposes, which we only do non-locally unless you reconfigure some commands.
You'll need to swap out the command temporarily at https://github.com/HHS/simpler-grants-gov/blob/main/api/docker-compose.yml#L78 for what we use in prod to run via Gunicorn: https://github.com/HHS/simpler-grants-gov/blob/main/api/Dockerfile#L127
There was a problem hiding this comment.
@chouinar What if we just lift init_newrelic() out into app.py, like I did here? Would we still need to change the Docker command?
There was a problem hiding this comment.
I'm suggesting you adjust the docker command to test that it works in multi-threaded/multi-process mode, not as a permanent change
| [newrelic:staging] | ||
| app_name = SIMPLER-GRANTS-API-STAGING | ||
| monitor_mode = true | ||
|
|
||
| [newrelic:prod] | ||
| app_name = SIMPLER-GRANTS-API-PROD | ||
| monitor_mode = true | ||
|
|
||
| [newrelic:dev] | ||
| app_name = SIMPLER-GRANTS-API-DEV | ||
| monitor_mode = true |
There was a problem hiding this comment.
@coilysiren - I think we talked about this a few weeks ago, but what landing scheme did we land on for the API app in New Relic?
There was a problem hiding this comment.
this looks fine to me - the SIMPLER-GRANTS- bit is probably superfluous but if that matches the frontend then I'm down to keep it
Thanks, I added screenshots of the docker container running via gunicorn (see gthreads in screenshots) and added evidence of the messages created correctly in the fake NR collector. |
Summary
Fixes #3127
Time to review: 10 mins
Changes proposed
Add a New Relic ini file, dependency, and lightweight utilities to send custom events.
Context for reviewers
New Relic monitoring is needed for the application and the .ini file is the start place for configuration. Environment-specific configuration is available as well. The
NEW_RELIC_LICENSE_KEYwill be provided as an environment variable (command line?) to the application in non-local environments.Additional information
Local env reports to a fake collector. Other envs will report property to NR.
Local env running gunicorn showing NewRelic initializing and sending events to the fake collector:
