You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-monitor/visualize/workbooks-overview.md
+38-17Lines changed: 38 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,6 @@
1
1
---
2
2
title: Azure Monitor Workbooks Overview
3
3
description: Learn how workbooks provide a flexible canvas for data analysis and the creation of rich visual reports within the Azure portal.
4
-
manager: carmonm
5
4
services: azure-monitor
6
5
7
6
ms.tgt_pltfrm: ibiza
@@ -11,7 +10,7 @@ ms.date: 07/23/2020
11
10
12
11
# Azure Monitor Workbooks
13
12
14
-
Workbooks provide a flexible canvas for data analysis and the creation of rich visual reports within the Azure portal. They allow you to tap into multiple data sources from across Azure, and combine them into unified interactive experiences.
13
+
Workbooks provide a flexible canvas for data analysis and the creation of rich visual reports within the Azure portal. They allow you to tap into multiple data sources from across Azure, and combine them into unified interactive experiences.
15
14
16
15
Here is a video walkthrough on creating workbooks.
17
16
@@ -35,7 +34,7 @@ Workbooks are currently compatible with the following data sources:
35
34
36
35
## Visualizations
37
36
38
-
Workbooks provide a rich set of capabilities for visualizing your data. For detailed examples of each visualization type you can consult the example links below:
37
+
Workbooks provide a rich set of capabilities for visualizing your data. For detailed examples of each visualization type, you can consult the links below:
:::image type="content" source="./media/workbooks-overview/visualizations.png" alt-text="Example of workbook visualizations" border="false" lightbox="./media/workbooks-overview/visualizations.png":::
49
48
50
49
## Getting started
51
50
52
51
To explore the workbooks experience, first navigate to the Azure Monitor service. This can be done by typing **Monitor** into the search box in the Azure portal.
53
52
54
53
Then select **Workbooks**.
55
54
56
-
55
+
:::image type="content" source="./media/workbooks-overview/workbooks.png" alt-text="Screenshot of Workbooks button highlighted in a red box" border="false":::
57
56
58
57
### Gallery
59
58
60
-
This takes you to the workbooks gallery:
59
+
The gallery makes it convenient to organize, sort, and manage workbooks of all types.
61
60
62
-
61
+
:::image type="content" source="./media/workbooks-overview/gallery-all-tab.png" alt-text="Screenshot of the gallery on the all tab." lightbox="media/workbooks-overview/gallery-all-tab.png":::
62
+
63
+
#### Gallery tabs
64
+
65
+
There are four tabs in the gallery to help organize workbook types.
| All | Shows the top four items for each type - workbooks, public templates, and my templates. Workbooks are sorted by modified date so you will see the most recent eight modified workbooks.|
70
+
| Workbooks | Shows the list of all the available workbooks that you created or are shared with you. |
71
+
| Public Templates | Shows the list of all the available ready to use, get started functional workbook templates published by Microsoft. Grouped by category. |
72
+
| My Templates | Shows the list of all the available deployed workbook templates that you created or are shared with you. Grouped by category. |
73
+
74
+
#### Features
75
+
76
+
* In each tab, there is a grid with info on the workbooks. It includes description, last modified date, tags, subscription, resource group, region, and shared state. You can also sort the workbooks by this information.
77
+
* Filter by resource group, subscriptions, workbook/template name, or template category.
78
+
* Select multiple workbooks to delete or bulk delete.
79
+
* Each Workbook has a context menu (ellipsis/three dots at the end), selecting it will open a list of quick actions.
80
+
* View resource - Access workbook resource tab to see the resource ID of the workbook, add tags, manage locks etc.
81
+
* Delete or rename workbook.
82
+
* Pin workbook to dashboard.
63
83
64
84
### Workbooks versus workbook templates
65
85
66
-
You can see a _workbook_ in green and a number of _workbook templates_ in purple. Templates serve as curated reports that are designed for flexible reuse by multiple users and teams. Opening a template creates a transient workbook populated with the content of the template.
86
+
You can see a _workbook_ in green and a number of _workbook templates_ in purple. Templates serve as curated reports that are designed for flexible reuse by multiple users and teams. Opening a template creates a transient workbook populated with the content of the template.
67
87
68
-
You can adjust the template-based workbook's parameters and perform analysis without fear of breaking the future reporting experience for colleagues. If you open a template, make some adjustments, and then select the save icon you will be saving the template as a workbook which would then show in green leaving the original template untouched.
88
+
You can adjust the template-based workbook's parameters and perform analysis without fear of breaking the future reporting experience for colleagues. If you open a template, make some adjustments, and then select the save icon you will be saving the template as a workbook which would then show in green leaving the original template untouched.
69
89
70
90
Under the hood, templates also differ from saved workbooks. Saving a workbook creates an associated Azure Resource Manager resource, whereas the transient workbook created when just opening a template has no unique resource associated with it. To learn more about how access control is managed in workbooks consult the [workbooks access control article](../visualize/workbooks-access-control.md).
71
91
72
92
### Exploring a workbook template
73
93
74
94
Select **Application Failure Analysis** to see one of the default application workbook templates.
75
95
76
-
As stated previously, opening the template creates a temporary workbook for you to be able to interact with. By default, the workbook opens in reading mode which displays only the information for the intended analysis experience that was created by the original template author.
79
99
@@ -83,34 +103,35 @@ In the case of this particular workbook, the experience is interactive. You can
83
103
84
104
To understand how this workbook template is put together you need to swap to editing mode by selecting **Edit**.
85
105
86
-
106
+
:::image type="content" source="./media/workbooks-overview/edit.png" alt-text="Screenshot of edit button in workbooks." border="false" :::
87
107
88
108
Once you have switched to editing mode you will notice a number of **Edit** boxes appear to the right corresponding with each individual aspect of your workbook.
89
109
90
-
110
+
:::image type="content" source="./media/workbooks-overview/edit-mode.png" alt-text="Screenshot of Edit button" border="false" lightbox="./media/workbooks-overview/edit-mode.png":::
91
111
92
112
If we select the edit button immediately under the grid of request data we can see that this part of our workbook consists of a Kusto query against data from an Application Insights resource.
93
113
94
-
114
+
:::image type="content" source="./media/workbooks-overview/kusto.png" alt-text="Screenshot of underlying Kusto query" border="false" lightbox="./media/workbooks-overview/kusto.png":::
115
+
95
116
96
-
Clicking the other **Edit** buttons on the right will reveal a number of the core components that make up workbooks like markdown-based [text boxes](../visualize/workbooks-text-visualizations.md), [parameter selection](../visualize/workbooks-parameters.md) UI elements, and other [chart/visualization types](#visualizations).
117
+
Clicking the other **Edit** buttons on the right will reveal a number of the core components that make up workbooks like markdown-based [text boxes](../visualize/workbooks-text-visualizations.md), [parameter selection](../visualize/workbooks-parameters.md) UI elements, and other [chart/visualization types](#visualizations).
97
118
98
119
Exploring the pre-built templates in edit-mode and then modifying them to fit your needs and save your own custom workbook is an excellent way to start to learn about what is possible with Azure Monitor workbooks.
99
120
100
121
## Pinning Visualizations
101
122
102
-
Text, query, and metrics steps in a workbook can be pinned by using the pin button on those items while the workbook is in pin mode, or if the workbook author has enabled settings for that element to make the pin icon visible.
123
+
Text, query, and metrics steps in a workbook can be pinned by using the pin button on those items while the workbook is in pin mode, or if the workbook author has enabled settings for that element to make the pin icon visible.
103
124
104
125
To access pin mode, click **Edit** to enter editing mode, and select the blue pin icon in the top bar. An individual pin icon will then appear above each corresponding workbook part's *Edit* box on the right-hand side of your screen.
:::image type="content" source="./media/workbooks-overview/pin-experience.png" alt-text="Screenshot of the pin experience." border="false":::
107
128
108
129
> [!NOTE]
109
130
> The state of the workbook is saved at the time of the pin, and pinned workbooks on a dashboard will not update if the underlying workbook is modified. In order to update a pinned workbook part, you will need to delete and re-pin that part.
110
131
111
132
## Dashboard time ranges
112
133
113
-
Pinned workbook query parts will respect the dashboard's time range if the pinned item is configured to use a *Time Range* parameter. The dashboard's time range value will be used as the time range parameter's value, and any change of the dashboard time range will cause the pinned item to update. If a pinned part is using the dashboard's time range, you will see the subtitle of the pinned part update to show the dashboard's time range whenever the time range changes.
134
+
Pinned workbook query parts will respect the dashboard's time range if the pinned item is configured to use a *Time Range* parameter. The dashboard's time range value will be used as the time range parameter's value, and any change of the dashboard time range will cause the pinned item to update. If a pinned part is using the dashboard's time range, you will see the subtitle of the pinned part update to show the dashboard's time range whenever the time range changes.
114
135
115
136
Additionally, pinned workbook parts using a time range parameter will auto refresh at a rate determined by the dashboard's time range. The last time the query ran will appear in the subtitle of the pinned part.
0 commit comments