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/vm/vminsights-workbooks.md
+31-31Lines changed: 31 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Create interactive reports VM insights with workbooks
2
+
title: Create interactive reports with VM insights workbooks
3
3
description: Simplify complex reporting with predefined and custom parameterized workbooks for VM insights.
4
4
ms.topic: conceptual
5
5
author: bwren
@@ -8,19 +8,19 @@ ms.date: 05/27/2022
8
8
9
9
---
10
10
11
-
# Create interactive reports VM insights with workbooks
11
+
# Create interactive reports with VM insights workbooks
12
12
13
-
Workbooks combine text, [log queries](/azure/data-explorer/kusto/query/), metrics, and parameters into rich interactive reports. Workbooks are editable by any other team members who have access to the same Azure resources.
13
+
Workbooks combine text, [log queries](/azure/data-explorer/kusto/query/), metrics, and parameters into rich interactive reports. Workbooks can be edited by any other team members who have access to the same Azure resources.
14
14
15
15
Workbooks help you to:
16
16
17
-
* Explore the usage of your virtual machine when you don't know the metrics of interest in advance, like CPU utilization, disk space, memory, and network dependencies. Unlike other usage analytics tools, workbooks let you combine multiple kinds of visualizations and analyses, which makes them great for this kind of freeform exploration.
17
+
* Explore the usage of your virtual machine (VM) when you don't know the metrics of interest in advance, like CPU utilization, disk space, memory, and network dependencies. Unlike other usage analytics tools, workbooks let you combine multiple kinds of visualizations and analyses, making them great for this kind of freeform exploration.
18
18
* Explain to your team how a recently provisioned VM is performing by showing metrics for key counters and other log events.
19
19
* Share the results of a resizing experiment of your VM with other members of your team. You can explain the goals for the experiment with text. Then you can show each usage metric and the analytics queries used to evaluate the experiment, along with clear call-outs for whether each metric was above or below target.
20
20
* Report the impact of an outage on the usage of your VM. You can combine data, text explanation, and a discussion of next steps to prevent outages in the future.
21
21
22
22
## VM insights workbooks
23
-
VM insights includes the following workbooks. You can use these workbooks or use them as a start to create custom workbooks to address your particular requirements.
23
+
VM insights includes the following workbooks. You can use these workbooks or use them as a starting point to create custom workbooks to address your particular requirements.
24
24
25
25
### Single virtual machine
26
26
@@ -49,7 +49,7 @@ A workbook is made up of sections that consist of independently editable charts,
49
49
50
50
1. Go to the **Monitor** menu in the Azure portal.
51
51
52
-
1. Select a virtual machine.
52
+
1. Select a VM.
53
53
54
54
1. On the VM insights page, select the **Performance** or **Map** tab and then select **View Workbooks** from the link on the page. From the dropdown list, select **Go To Gallery**.
55
55
@@ -69,7 +69,7 @@ Workbooks have two modes: editing and reading. A new workbook opens in editing m
69
69
70
70
1. After you finish editing a section, select **Done Editing** in the lower-left corner of the section.
71
71
72
-
1. To create a duplicate of a section, select the **Clone this section** icon. Creating duplicate sections is a great to way to iterate on a query without losing previous iterations.
72
+
1. To create a duplicate of a section, select the **Clone this section** icon. Creating duplicate sections is a great way to iterate on a query without losing previous iterations.
73
73
74
74
1. To move up a section in a workbook, select the **Move up** or **Move down** icon.
75
75
@@ -93,15 +93,15 @@ Query sections are highly flexible and can be used to answer questions like:
93
93
* What was the trend in available disk space over the last month?
94
94
* How many network connection failures did my VM experience over the last two weeks?
95
95
96
-
You also aren't limited to querying from the context of the virtual machine from which you opened the workbook. To query across multiple virtual machines and Log Analytics workspaces, you must have access permission to those resources.
96
+
You also aren't limited to querying from the context of the VM from which you opened the workbook. To query across multiple VMs and Log Analytics workspaces, you must have access permission to those resources.
97
97
98
-
To include data from other Log Analytics workspaces or from a specific Application Insights app, use the **workspace** identifier. To learn more about cross-resource queries, see the [official guidance](../logs/cross-workspace-query.md).
98
+
To include data from other Log Analytics workspaces or from a specific Application Insights app, use the workspace identifier. To learn more about cross-resource queries, see the [official guidance](../logs/cross-workspace-query.md).
99
99
100
100
### Advanced analytic query settings
101
101
102
102
Each section has its own advanced settings, which are accessible via the settings  icon located to the right of **Add parameters**.
103
103
104
-

104
+

105
105
106
106
| Setting | Description |
107
107
| ---------------- |:-----|
@@ -123,7 +123,7 @@ The behavior is possible through use of the **When an item is selected, export a
123
123
124
124

125
125
126
-
The second log query then utilizes the exported values when a row is selected to create a set of values that are then used by the section heading and charts. If no row is selected, it hides the section heading and charts.
126
+
The second log query then utilizes the exported values when a row is selected to create a set of values that are used by the section heading and charts. If no row is selected, it hides the section heading and charts.
127
127
128
128
For example, the hidden parameter in the second section uses the following reference from the row selected in the grid:
129
129
@@ -136,34 +136,34 @@ VMConnection
136
136
137
137
## Add metrics sections
138
138
139
-
Metrics sections give you full access to incorporate Azure Monitor metrics data into your interactive reports. In VM insights, the prebuilt workbooks typically contain analytic query data rather than metric data. You may choose to create workbooks with metric data, which allows you to take full advantage of the best of both features all in one place. You also have the ability to pull in metric data from resources in any of the subscriptions to which you have access.
139
+
Metrics sections give you full access to incorporate Azure Monitor metrics data into your interactive reports. In VM insights, the prebuilt workbooks typically contain analytic query data rather than metric data. You can create workbooks with metric data, which allows you to take full advantage of the best of both features all in one place. You also have the ability to pull in metric data from resources in any of the subscriptions to which you have access.
140
140
141
-
Here's an example of virtual machine data being pulled into a workbook to provide a grid visualization of CPU performance:
141
+
Here's an example of VM data being pulled into a workbook to provide a grid visualization of CPU performance.
142
142
143
143

144
144
145
145
## Add parameter sections
146
146
147
147
Workbook parameters allow you to change values in the workbook without having to manually edit the query or text sections. This removes the requirement of needing to understand the underlying analytics query language and greatly expands the potential audience of workbook-based reporting.
148
148
149
-
The values of parameters are replaced in query, text, or other parameter sections by putting the name of the parameter in braces, like ``{parameterName}``. Parameter names are limited to similar rules as JavaScript identifiers, alphabetic characters or underscores, followed by alphanumeric characters or underscores. For example, **a1** is allowed, but **1a** isn't allowed.
149
+
The values of parameters are replaced in query, text, or other parameter sections by putting the name of the parameter in braces, like ``{parameterName}``. Parameter names are limited to similar rules as JavaScript identifiers, alphabetic characters, or underscores, followed by alphanumeric characters or underscores. For example, *a1* is allowed but *1a* isn't allowed.
150
150
151
-
Parameters are linear, starting from the top of a workbook and flowing down to later steps. Parameters declared later in a workbook can override parameters that were declared earlier. This also lets parameters that use queries to access the values from parameters defined earlier. Within a parameter's step itself, parameters are also linear, left to right, where parameters to the right can depend on a parameter declared earlier in that same step.
151
+
Parameters are linear, starting from the top of a workbook and flowing down to later steps. Parameters declared later in a workbook can override parameters that were declared earlier. Parameters that use queries can access the values from parameters defined earlier. Within a parameter's step itself, parameters are also linear, left to right, where parameters to the right can depend on a parameter declared earlier in that same step.
152
152
153
-
four different types of parameters are currently supported:
153
+
Four different types of parameters are currently supported:
154
154
155
155
| Parameter | Description |
156
156
| ---------------- |:-----|
157
-
| Text | Allows the user to edit a text box, and you can optionally supply a query to fill in the default value. |
157
+
| Text | Allows the user to edit a text box. You can optionally supply a query to fill in the default value. |
158
158
| Drop down | Allows the user to choose from a set of values. |
159
159
| Time range picker| Allows the user to choose from a predefined set of time range values or pick from a custom time range.|
160
160
| Resource picker | Allows the user to choose from the resources selected for the workbook.|
161
161
162
162
### Use a text parameter
163
163
164
-
The value a user types in the text box is replaced directly in the query, with no escaping or quoting. If the value you need is a string, the query should have quotes around the parameter. An example is **'{parameter}'**).
164
+
The value a user enters in the text box is replaced directly in the query, with no escaping or quoting. If the value you need is a string, the query should have single quotation marks around the parameter. An example is **'{parameter}'**.
165
165
166
-
The text parameter allows the value in a text box to be used anywhere. It can be a table name, column name, function name, or operator. The text parameter type has a setting **Get default value from analytics query**, which allows the workbook author to use a query to populate the default value for that text box.
166
+
The text parameter allows the value in a text box to be used anywhere. It can be a table name, column name, function name, or operator. The text parameter type has a setting **Get default value from analytics query**, which allows the workbook author to use a query to populate the default value for that text box.
167
167
168
168
When the default value is used from a log query, only the first value of the first row (row 0, column 0) is used as the default value. For this reason, we recommend that you limit your query to return only one row and one column. Any other data returned by the query is ignored.
169
169
@@ -181,9 +181,9 @@ Let's look at the parameters present in the Connections Overview report. Select
181
181
182
182

183
183
184
-
This action opens the **Edit Parameter**menu item.
184
+
This action opens the **Edit Parameter**pane.
185
185
186
-

186
+

187
187
188
188
The JSON lets you generate an arbitrary table populated with content. For example, the following JSON generates two values in the dropdown:
189
189
@@ -207,7 +207,7 @@ The query shows the following results:
207
207
208
208

209
209
210
-
Dropdown lists are incredibly powerful tools you can use to customize and create interactive reports.
210
+
Dropdown lists are powerful tools you can use to customize and create interactive reports.
211
211
212
212
### Time range parameters
213
213
@@ -223,23 +223,23 @@ The resource picker parameter type gives you the ability to scope your report to
223
223
224
224
## Save and share workbooks with your team
225
225
226
-
Workbooks are saved within a Log Analytics workspace or a virtual machine resource, depending on how you access the workbooks gallery. The workbook can be saved to the **My Reports** section that's private to you or in the **Shared Reports** section that's accessible to everyone with access to the resource. To view all the workbooks in the resource, select **Open** in the action bar.
226
+
Workbooks are saved within a Log Analytics workspace or a VM resource, depending on how you access the workbooks gallery. The workbook can be saved to the **My Reports** section that's private to you or in the **Shared Reports** section that's accessible to everyone with access to the resource. To view all the workbooks in the resource, select **Open**.
227
227
228
228
To share a workbook that's currently in **My Reports**:
229
229
230
-
1. Select **Open** in the action bar.
231
-
1. Select the "..." button beside the workbook you want to share.
230
+
1. Select **Open**.
231
+
1. Select the ellipsis (**...**) next to the workbook you want to share.
232
232
1. Select **Move to Shared Reports**.
233
233
234
-
To share a workbook with a link or via email, click**Share** in the action bar. Keep in mind that recipients of the link need access to this resource in the Azure portal to view the workbook. To make edits, recipients need at least Contributor permissions for the resource.
234
+
To share a workbook with a link or via email, select**Share**. Keep in mind that recipients of the link need access to this resource in the Azure portal to view the workbook. To make edits, recipients need at least Contributor permissions for the resource.
235
235
236
-
To pin a link to a workbook to an Azure Dashboard:
236
+
To pin a link to a workbook to an Azure dashboard:
237
237
238
-
1. Select **Open** in the action bar.
239
-
1. Select the "..." button beside the workbook you want to pin.
238
+
1. Select **Open**.
239
+
1. Select the ellipsis (**...**) next to the workbook you want to pin.
240
240
1. Select **Pin to dashboard**.
241
241
242
242
## Next steps
243
243
244
-
- To identify limitations and overall VM performance, see [View Azure VM Performance](vminsights-performance.md).
245
-
- To learn about discovered application dependencies, see [View VM insights Map](vminsights-maps.md).
244
+
- To identify limitations and overall VM performance, see [View Azure VM performance](vminsights-performance.md).
245
+
- To learn about discovered application dependencies, see [View VM insights map](vminsights-maps.md).
0 commit comments