Skip to content

Commit 8937693

Browse files
authored
Merge pull request #205278 from paulth1/overview-get-started-data-sources-visualizations-renderers
edit pass: Overview get started data sources visualizations renderers
2 parents 944d87f + 3efb3b7 commit 8937693

File tree

5 files changed

+165
-147
lines changed

5 files changed

+165
-147
lines changed
Lines changed: 45 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure Workbooks data sources | Microsoft docs
3-
description: Simplify complex reporting with prebuilt and custom parameterized Azure Workbooks built from multiple data sources.
3+
description: Simplify complex reporting with prebuilt and custom parameterized workbooks built from multiple data sources.
44
services: azure-monitor
55
author: AbbyMSFT
66
ms.author: abbyweisberg
@@ -25,75 +25,76 @@ Workbooks can extract data from these data sources:
2525
- [Azure resource health](#azure-resource-health)
2626
- [Azure RBAC](#azure-rbac)
2727
- [Change Analysis (preview)](#change-analysis-preview)
28+
2829
## Logs
2930

30-
Workbooks allow querying logs from the following sources:
31+
With workbooks, you can query logs from the following sources:
3132

32-
* Azure Monitor Logs (Application Insights Resources and Log Analytics Workspaces.)
33-
* Resource-centric data (Activity logs)
33+
* Azure Monitor Logs (Application Insights resources and Log Analytics workspaces)
34+
* Resource-centric data (activity logs)
3435

35-
Workbook authors can use KQL queries that transform the underlying resource data to select a result set that can visualized as text, charts, or grids.
36+
You can use Kusto query language (KQL) queries that transform the underlying resource data to select a result set that can be visualized as text, charts, or grids.
3637

37-
![Screenshot of workbooks logs report interface.](./media/workbooks-data-sources/logs.png)
38+
![Screenshot that shows a workbook logs report interface.](./media/workbooks-data-sources/logs.png)
3839

39-
Workbook authors can easily query across multiple resources creating a truly unified rich reporting experience.
40+
You can easily query across multiple resources to create a unified rich reporting experience.
4041

4142
## Metrics
4243

43-
Azure resources emit [metrics](../essentials/data-platform-metrics.md) that can be accessed via workbooks. Metrics can be accessed in workbooks through a specialized control that allows you to specify the target resources, the desired metrics, and their aggregation. This data can then be plotted in charts or grids.
44+
Azure resources emit [metrics](../essentials/data-platform-metrics.md) that can be accessed via workbooks. Metrics can be accessed in workbooks through a specialized control that allows you to specify the target resources, the desired metrics, and their aggregation. You can then plot this data in charts or grids.
4445

45-
![Screenshot of workbook metrics charts of cpu utilization.](./media/workbooks-data-sources/metrics-graph.png)
46+
![Screenshot that shows workbook metrics charts of CPU utilization.](./media/workbooks-data-sources/metrics-graph.png)
4647

47-
![Screenshot of workbook metrics interface.](./media/workbooks-data-sources/metrics.png)
48+
![Screenshot that shows a workbook metrics interface.](./media/workbooks-data-sources/metrics.png)
4849

4950
## Azure Resource Graph
5051

51-
Workbooks support querying for resources and their metadata using Azure Resource Graph (ARG). This functionality is primarily used to build custom query scopes for reports. The resource scope is expressed via a KQL-subset that ARG supports – which is often sufficient for common use cases.
52+
Workbooks support querying for resources and their metadata by using Azure Resource Graph. This functionality is primarily used to build custom query scopes for reports. The resource scope is expressed via a KQL subset that Resource Graph supports, which is often sufficient for common use cases.
5253

53-
To make a query control use this data source, use the Query type drop-down to choose Azure Resource Graph and select the subscriptions to target. Use the Query control to add the ARG KQL-subset that selects an interesting resource subset.
54+
To make a query control that uses this data source, use the **Query type** dropdown and select **Azure Resource Graph**. Then select the subscriptions to target. Use **Query control** to add the Resource Graph KQL subset that selects an interesting resource subset.
5455

55-
![Screenshot of Azure Resource Graph KQL query.](./media/workbooks-data-sources/azure-resource-graph.png)
56+
![Screenshot that shows an Azure Resource Graph KQL query.](./media/workbooks-data-sources/azure-resource-graph.png)
5657

5758
## Azure Resource Manager
5859

59-
Workbook supports Azure Resource Manager REST operations. This allows the ability to query management.azure.com endpoint without the need to provide your own authorization header token.
60+
Azure Workbooks supports Azure Resource Manager REST operations so that you can query the management.azure.com endpoint without providing your own authorization header token.
6061

61-
To make a query control use this data source, use the Data source drop-down to choose Azure Resource Manager. Provide the appropriate parameters such as Http method, url path, headers, url parameters and/or body.
62+
To make a query control that uses this data source, use the **Data source** dropdown and select **Azure Resource Manager**. Provide the appropriate parameters, such as **Http method**, **url path**, **headers**, **url parameters**, and **body**.
6263

6364
> [!NOTE]
6465
> Only GET, POST, and HEAD operations are currently supported.
6566
6667
## Azure Data Explorer
6768

6869
Workbooks now have support for querying from [Azure Data Explorer](/azure/data-explorer/) clusters with the powerful [Kusto](/azure/kusto/query/index) query language.
69-
For the **Cluster Name** field, you should add the region name following the cluster name. For example: *mycluster.westeurope*.
70+
For the **Cluster Name** field, add the region name following the cluster name. An example is *mycluster.westeurope*.
7071

71-
![Screenshot of Kusto query window.](./media/workbooks-data-sources/data-explorer.png)
72+
![Screenshot that shows Kusto query window.](./media/workbooks-data-sources/data-explorer.png)
7273

7374
## JSON
7475

75-
The JSON provider allows you to create a query result from static JSON content. It is most commonly used in Parameters to create dropdown parameters of static values. Simple JSON arrays or objects will automatically be converted into grid rows and columns. For more specific behaviors, you can use the Results tab and JSONPath settings to configure columns.
76+
The JSON provider allows you to create a query result from static JSON content. It's most commonly used in parameters to create dropdown parameters of static values. Simple JSON arrays or objects will automatically be converted into grid rows and columns. For more specific behaviors, you can use the **Results** tab and JSONPath settings to configure columns.
7677

7778
> [!NOTE]
78-
> Do not include any sensitive information in any fields (headers, parameters, body, url), since they will be visible to all of the Workbook users.
79+
> Do *not* include sensitive information in fields like headers, parameters, body, and URL, because they'll be visible to all the workbook users.
7980
8081
This provider supports [JSONPath](workbooks-jsonpath.md).
8182

8283
## Merge
8384

84-
Merging data from different sources can enhance the insights experience. An example is augmenting active alert information with related metric data. This allows users to see not just the effect (an active alert), but also potential causes (for example, high CPU usage). The monitoring domain has numerous such correlatable data sources that are often critical to the triage and diagnostic workflow.
85+
Merging data from different sources can enhance the insights experience. An example is augmenting active alert information with related metric data. Merging data allows users to see not just the effect (an active alert) but also potential causes, for example, high CPU usage. The monitoring domain has numerous such correlatable data sources that are often critical to the triage and diagnostic workflow.
8586

86-
Workbooks allow not just the querying of different data sources, but also provides simple controls that allow you to merge or join the data to provide rich insights. The **merge** control is the way to achieve it.
87+
With workbooks, you can query different data sources. Workbooks also provide simple controls that you can use to merge or join data to provide rich insights. The *merge* control is the way to achieve it.
8788

88-
### Combining alerting data with Log Analytics VM performance data
89+
### Combine alerting data with Log Analytics VM performance data
8990

90-
The example below combines alerting data with Log Analytics VM performance data to get a rich insights grid.
91+
The following example combines alerting data with Log Analytics VM performance data to get a rich insights grid.
9192

92-
![Screenshot of a workbook with a merge control that combines alert and log analytics data.](./media/workbooks-data-sources/merge-control.png)
93+
![Screenshot that shows a workbook with a merge control that combines alert and Log Analytics data.](./media/workbooks-data-sources/merge-control.png)
9394

94-
### Using merge control to combine Azure Resource Graph and Log Analytics data
95+
### Use merge control to combine Resource Graph and Log Analytics data
9596

96-
Here is a tutorial on using the merge control to combine Azure Resource Graph and Log Analytics data:
97+
Watch this tutorial on using the merge control to combine Resource Graph and Log Analytics data:
9798

9899
[![Combining data from different sources in workbooks](https://img.youtube.com/vi/7nWP_YRzxHg/0.jpg)](https://www.youtube.com/watch?v=7nWP_YRzxHg "Video showing how to combine data from different sources in workbooks.")
99100

@@ -113,31 +114,35 @@ Workbooks support these merges:
113114

114115
## Custom endpoint
115116

116-
Workbooks support getting data from any external source. If your data lives outside Azure you can bring it to Workbooks by using this data source type.
117+
Workbooks support getting data from any external source. If your data lives outside Azure, you can bring it to workbooks by using this data source type.
117118

118-
To make a query control use this data source, use the **Data source** drop-down to choose **Custom Endpoint**. Provide the appropriate parameters such as **Http method**, **url**, **headers**, **url parameters**, and/or **body**. Make sure your data source supports [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) otherwise the request will fail.
119+
To make a query control that uses this data source, use the **Data source** dropdown and select **Custom Endpoint**. Provide the appropriate parameters, such as **Http method**, **url**, **headers**, **url parameters**, and **body**. Make sure your data source supports [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS). Otherwise, the request will fail.
119120

120-
To avoid automatically making calls to untrusted hosts when using templates, the user needs to mark the used hosts as trusted. This can be done by either selecting the **Add as trusted** button, or by adding it as a trusted host in Workbook settings. These settings will be saved in [browsers that support IndexDb with web workers](https://caniuse.com/#feat=indexeddb).
121+
To avoid automatically making calls to untrusted hosts when you use templates, you need to mark the used hosts as trusted. You can either select **Add as trusted** or add it as a trusted host in workbook settings. These settings will be saved in [browsers that support IndexDb with web workers](https://caniuse.com/#feat=indexeddb).
121122

122123
This provider supports [JSONPath](workbooks-jsonpath.md).
124+
123125
## Workload health
124126

125-
Azure Monitor has functionality that proactively monitors the availability and performance of Windows or Linux guest operating systems. Azure Monitor models key components and their relationships, criteria for how to measure the health of those components, and which components alert you when an unhealthy condition is detected. Workbooks allow users to use this information to create rich interactive reports.
127+
Azure Monitor has functionality that proactively monitors the availability and performance of Windows or Linux guest operating systems. Azure Monitor models key components and their relationships, criteria for how to measure the health of those components, and which components alert you when an unhealthy condition is detected. With workbooks, you can use this information to create rich interactive reports.
126128

127-
To make a query control use this data source, use the **Query type** drop-down to choose Workload Health and select subscription, resource group or VM resources to target. Use the health filter drop downs to select an interesting subset of health incidents for your analytic needs.
129+
To make a query control that uses this data source, use the **Query type** dropdown to select **Workload Health**. Then select subscription, resource group, or VM resources to target. Use the health filter dropdowns to select an interesting subset of health incidents for your analytic needs.
128130

129-
![Screenshot of alerts query.](./media/workbooks-data-sources/workload-health.png)
131+
![Screenshot that shows an alerts query.](./media/workbooks-data-sources/workload-health.png)
130132

131133
## Azure resource health
132134

133-
Workbooks support getting Azure resource health and combining it with other data sources to create rich, interactive health reports
135+
Workbooks support getting Azure resource health and combining it with other data sources to create rich, interactive health reports.
134136

135-
To make a query control use this data source, use the **Query type** drop-down to choose Azure health and select the resources to target. Use the health filter drop downs to select an interesting subset of resource issues for your analytic needs.
137+
To make a query control that uses this data source, use the **Query type** dropdown and select **Azure health**. Then select the resources to target. Use the health filter dropdowns to select an interesting subset of resource issues for your analytic needs.
136138

137-
![Screenshot of alerts query that shows the health filter lists.](./media/workbooks-data-sources/resource-health.png)
139+
![Screenshot that shows an alerts query that shows the health filter lists.](./media/workbooks-data-sources/resource-health.png)
138140

139141
## Azure RBAC
140-
The Azure RBAC provider allows you to check permissions on resources. It is most commonly used in parameter to check if the correct RBAC are set up. A use case would be to create a parameter to check deployment permission and then notify the user if they don't have deployment permission. Simple JSON arrays or objects will automatically be converted into grid rows and columns or text with a 'hasPermission' column with either true or false. The permission is checked on each resource and then either 'or' or 'and' to get the result. The [operations or actions](../../role-based-access-control/resource-provider-operations.md) can be a string or an array.
142+
143+
The Azure role-based access control (RBAC) provider allows you to check permissions on resources. It's most commonly used in parameters to check if the correct RBACs are set up. A use case would be to create a parameter to check deployment permission and then notify the user if they don't have deployment permission.
144+
145+
Simple JSON arrays or objects will automatically be converted into grid rows and columns or text with a `hasPermission` column with either true or false. The permission is checked on each resource and then either `or` or `and` to get the result. The [operations or actions](../../role-based-access-control/resource-provider-operations.md) can be a string or an array.
141146

142147
**String:**
143148
```
@@ -151,12 +156,12 @@ The Azure RBAC provider allows you to check permissions on resources. It is most
151156

152157
## Change Analysis (preview)
153158

154-
To make a query control using [Application Change Analysis](../app/change-analysis.md) as the data source, use the **Data source** drop-down and choose *Change Analysis (preview)* and select a single resource. Changes for up to the last 14 days can be shown. The *Level* drop-down can be used to filter between "Important", "Normal", and "Noisy" changes, and this drop down supports workbook parameters of type [drop down](workbooks-dropdowns.md).
159+
To make a query control that uses [Application Change Analysis](../app/change-analysis.md) as the data source, use the **Data source** dropdown and select **Change Analysis (preview)**. Then select a single resource. Changes for up to the last 14 days can be shown. Use the **Level** dropdown to filter between **Important**, **Normal**, and **Noisy** changes. This dropdown supports workbook parameters of the type [drop down](workbooks-dropdowns.md).
155160

156161
> [!div class="mx-imgBorder"]
157-
> ![A screenshot of a workbook with Change Analysis.](./media/workbooks-data-sources/change-analysis-data-source.png)
162+
> ![A screenshot that shows a workbook with Change Analysis.](./media/workbooks-data-sources/change-analysis-data-source.png)
158163
159164
## Next steps
160165

161-
- [Getting started with Azure Workbooks](workbooks-getting-started.md)
162-
- [Create an Azure Workbook](workbooks-create-workbook.md).
166+
- [Get started with Azure Workbooks](workbooks-getting-started.md)
167+
- [Create an Azure workbook](workbooks-create-workbook.md)

0 commit comments

Comments
 (0)