We recommend that you use the change tracking feature instead of the older deployment markers. If you've been using deployment markers feature, you can still use it, but keep in mind that the change tracking feature is available for browser and mobile, as well as APM.
Deploying an app can be a risky event—when your app breaks, and a bad deployment is often the cause. New Relic allows you to track deployments so you can correlate deployments with changes in your app's performance. Tracking deployments creates deployment markers that appear in APM charts and dashboards.
See how deployment markers work in this short video (4:30 minutes):
You can use the New Relic REST API v2 to record new deployments and retrieve a list of past deployments. In addition, some APM agents have agent-specific methods to record deployments automatically.
You can use your Slack integration with New Relic, or a simple webhook, to notify your team in real time of deployments for applications monitored by APM. Slack provides a webhook URL that allows you to post generic JSON that will appear formatted in a chosen Slack channel.
There are a few places where you can view deployments in the New Relic UI after they have been recorded:
- In the activity feed on the APM Summary, Service summary, and entity summary pages.
- On APM performance charts as chart markers (vertical lines with pinheads).
- On dashboard charts as chart markers.
- On the Deployments page for summary performance.
Deployment markers are not available for browser applications, but you can try these alternatives:
You can use the New Relic REST API v2 to record deployments and get a list of past deployments.
- The examples in this document use
curlas a command line tool. However, you can use any method to make your REST requests. You can also create and view deployments with the API Explorer.
- JSON uses double quotes
"for element names and content. Using single quotes
'will cause errors.
- The examples use
X-Api-Keywhich can be used for either a user key or a REST API key. User keys are now the preferred way of accessing our REST APIs, and you may use
Api-Keyheaders when using them.
Some agents have additional methods to record deployments:
- All agents: Use the New Relic REST API v2.
- C: No SDK-specific methods. Use the REST API.
- Go: No agent-specific methods. Use the REST API.
- Java: Call the Java agent
- .NET: Use PowerShell and the REST API.
- Node.js: No agent-specific methods. Use the REST API.
- PHP: Use a PHP script.
- Python: Use the
record-deploysubcommand of the
- Ruby: Use a Capistrano recipe.
After you configure the deployment information, you can view and drill down into details in the UI. For tips, see our change tracking document How to view and analyze your changes in New Relic.