Track deployments with annotations

edit

[preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.

Required role

The Admin role or higher is required to create and manage annotations. To learn more, refer to Assign user roles and privileges.

Example view of transactions annotation in the Applications UI

For enhanced visibility into your deployments, we offer deployment annotations on all transaction charts. This feature enables you to easily determine if your deployment has increased response times for an end-user, or if the memory/CPU footprint of your application has changed. Being able to quickly identify bad deployments enables you to rollback and fix issues without causing costly outages.

By default, automatic deployment annotations are enabled. This means APM will create an annotation on your data when the service.version of your application changes.

Alternatively, you can explicitly create deployment annotations with our annotation API. The API can integrate into your CI/CD pipeline, so that each time you deploy, a POST request is sent to the annotation API endpoint:

See the Annotation API reference for more information.

If custom annotations have been created for the selected time period, any derived annotations, i.e., those created automatically when service.version changes, will not be shown.