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 one.newrelic.com > All capabilities > APM & services > Applications > (select an app) > Events > Deployments.
Installation
Part of the installation process involves changing the app_name in your newrelic.yml file to a meaningful name. When you run the deployment upload script, it will use the app name to associate all of the instances of the app with the deployment. Each time you run the script, it will report a new deployment to New Relic.
For example, if you set the deployment marker and ran the script to push 100 instances of the app, the Deployments page will show one deployment for the 100 instances. If you ran the script again, it would show another deployment.
As part of the installation process, after changing the app_name, add this entry to newrelic.yml in the common section:
api_host: rpm.newrelic.comCustomers connecting to the EU region data center will need to use the following entry instead:
api_host: rpm.eu.newrelic.comCommand line
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_OPTIONSYou can include these optional values with the deployment command:
Deployment option | Description |
|---|---|
| Set the application name. Defaults to |
| Override the |
| 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: bash |
Proxy configurations
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.
REST API
In addition to using the command line, you can record deployments with the New Relic REST API v2.