New Relic allows you to send information about application deployments from the command line. Then, you can view deployment information on the Deployments page in the UI: Go to rpm.newrelic.com/apm > Applications > (select an app) > Events > Deployments.
Access to this feature depends on your subscription level.
Part of the installation process involves changing the
app_name in your
newrelic.yml file to a meaningful name. The deployment upload script will use this name to associate all of the instances for the app with the deployment. For example, if you set the deployment marker and push 100 instances of the app, the Deployments page will show one deployment for the 100 instances.
As part of the installation process, after changing the
app_name, add this entry to
newrelic.yml in the
To send deployment information to New Relic from the Java agent jar, execute the following command from the command line:
java -jar newrelic.jar deployment DEPLOYMENT_OPTIONS
You can include these optional values with the deployment command:
||Set the application name. Defaults to
||Specify the user who is deploying the change.|
||Specify the revision being deployed.|
Read in a change log from the standard input. For example, you can pipe the change log:
echo "get SHA-1 34837888734" | java -jar newrelic.jar deployment DEPLOYMENT_OPTIONS --changes
The Java agent does not pick up proxy configurations from the
newrelic.yml file. Recommendation: If you use a proxy in your application, use either of these options to record deployments:
- Manually pass the proxy configuration in the Java command.
- Use the New Relic REST API v2.
In addition to using the command line, you can record deployments with the New Relic REST API v2.