Skip to content

Commit 99e4715

Browse files
authored
Merge pull request #110834 from mrbullwinkle/mrb_04_09_2020_release_annotations
update release annotations
2 parents 223b373 + 20e348a commit 99e4715

File tree

4 files changed

+20
-9
lines changed

4 files changed

+20
-9
lines changed

articles/azure-monitor/app/annotations.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,14 @@ ms.date: 07/01/2019
88

99
# Annotations on metric charts in Application Insights
1010

11-
Annotations on [Metrics Explorer](../../azure-monitor/app/metrics-explorer.md) charts show where you deployed a new build, or other significant events. Annotations make it easy to see whether your changes had any effect on your application's performance. They can be automatically created by the [Azure Pipelines](https://docs.microsoft.com/azure/devops/pipelines/tasks/) build system. You can also create annotations to flag any event you like by creating them from PowerShell.
12-
13-
> [!NOTE]
14-
> This article reflects the deprecated **classic metrics experience**. Annotations are only currently available in the classic experience and in **[workbooks](../../azure-monitor/app/usage-workbooks.md)**. To learn more about the current metrics experience, see [Advanced features of Azure Metrics Explorer](../../azure-monitor/platform/metrics-charts.md).
15-
16-
![Example of annotations](./media/annotations/0-example.png)
11+
Annotations show where you deployed a new build, or other significant events. Annotations make it easy to see whether your changes had any effect on your application's performance. They can be automatically created by the [Azure Pipelines](https://docs.microsoft.com/azure/devops/pipelines/tasks/) build system. You can also create annotations to flag any event you like by creating them from PowerShell.
1712

1813
## Release annotations with Azure Pipelines build
1914

2015
Release annotations are a feature of the cloud-based Azure Pipelines service of Azure DevOps.
2116

2217
### Install the Annotations extension (one time)
18+
2319
To be able to create release annotations, you'll need to install one of the many Azure DevOps extensions available in the Visual Studio Marketplace.
2420

2521
1. Sign in to your [Azure DevOps](https://azure.microsoft.com/services/devops/) project.
@@ -70,11 +66,26 @@ Create a separate API key for each of your Azure Pipelines release templates.
7066
1. Select **Save** in the main release template window to save the template.
7167

7268
## View annotations
73-
Now, whenever you use the release template to deploy a new release, an annotation is sent to Application Insights. The annotations appear on charts in **Metrics Explorer**.
7469

75-
Select any annotation marker (light gray arrow) to open details about the release, including requestor, source control branch, release pipeline, and environment.
7670

77-
![Select a release annotation marker.](./media/annotations/8-release.png)
71+
> [!NOTE]
72+
> Release annotations are not currently available in the Metrics pane of Application Insights
73+
74+
Now, whenever you use the release template to deploy a new release, an annotation is sent to Application Insights. The annotations can be viewed in the following locations:
75+
76+
The usage pane where you also have the ability to manually create release annotations:
77+
78+
![Screenshot of bar chart with number of user visits displayed over a period of hours. Release annotations appear as green checkmarks above the chart indicating the moment in time that a release occurred](./media/annotations/usage-pane.png)
79+
80+
In any log-based workbook query where the visualization displays time along the x-axis.
81+
82+
![Screenshot of workbooks pane with time series log-based query with annotations displayed](./media/annotations/workbooks-annotations.png)
83+
84+
To enable annotations in your workbook go to **Advanced Settings** and select **Show annotations**.
85+
86+
![Screenshot of Advanced Settings menu with the words show annotations highlighted with a checkmark next to the setting to enable it.](./media/annotations/workbook-show-annotations.png)
87+
88+
Select any annotation marker to open details about the release, including requestor, source control branch, release pipeline, and environment.
7889

7990
## Create custom annotations from PowerShell
8091
You can use the [CreateReleaseAnnotation](https://github.com/Microsoft/ApplicationInsights-Home/blob/master/API/CreateReleaseAnnotation.ps1) PowerShell script from GitHub to create annotations from any process you like, without using Azure DevOps.
86.8 KB
Loading
73.5 KB
Loading
171 KB
Loading

0 commit comments

Comments
 (0)