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/insights/key-vault-insights-overview.md
+68-61Lines changed: 68 additions & 61 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,138 +10,145 @@ ms.date: 04/13/2019
10
10
---
11
11
12
12
# Monitoring your key vault service with Azure Monitor for Key Vaults (preview)
13
-
Azure Monitor for Key Vaults (preview) provides comprehensive monitoring of your Azure Key Vaults by delivering a unified view of your Azure Key Vaults requests, performance, failures, and latency.
14
-
This article will help you understand how to onboard and customize the experience of Azure Monitor for Key Vaults (preview).
13
+
Azure Monitor for Key Vaults (preview) provides comprehensive monitoring of your Azure Key Vaults by delivering a unified view of your Azure Key Vault requests, performance, failures, and latency.
14
+
This article will help you understand how to onboard and customize the experience of Azure Monitor for Key Vault (preview).
15
15
16
16
## Introduction to Azure Monitor for Key Vaults (preview)
17
17
18
18
Before jumping into the experience, you should understand how it presents and visualizes information.
19
-
-**At scale perspective** showing a snapshot view of their performance based on the requests, breakdown of failures, and an overview of the operations and latency.
20
-
-**Drill down analysis** of a particular key vault to perform detailed analysis
21
-
-**Customizable** where you can change which metrics you want to see, modify or set thresholds that align with your limits, and save your own workbook. Charts in the workbook can be pinned to Azure dashboard
19
+
-**At scale perspective** showing a snapshot view of performance based on the requests, breakdown of failures, and an overview of the operations and latency.
20
+
-**Drill down analysis** of a particular key vault to perform detailed analysis.
21
+
-**Customizable** where you can change which metrics you want to see, modify or set thresholds that align with your limits, and save your own workbook. Charts in the workbook can be pinned to Azure dashboards.
22
22
23
+
Azure Monitor for Key Vaults combines both logs and metrics to provide a global monitoring solution. All users can access the metrics based monitoring data, however the inclusion of logs based visualizations may require users to [enable logging of their Azure Key Vaults](https://docs.microsoft.com/azure/key-vault/key-vault-logging).
23
24
24
-
Azure Monitor for Key Vaults combines both logs and metrics to provide a global monitoring solution. All users can access the metrics based monitoring data, however the inclusion of logs based visualizations may require users to [enabling logging of their Azure Key Vaults](https://docs.microsoft.com/azure/key-vault/key-vault-logging).
25
+
## Configuring your Key Vaults for monitoring
25
26
26
-
## Configuring your Key Vaults for Monitoring
27
-
*Note that enabling logs is a paid-service for monitoring
27
+
> ![NOTE]
28
+
> Enabling logs is a paid-service that provides additional monitoring capabilities.
28
29
29
-
1. The Operations & Latency tab helps you determine how many and which key vaults are enabled. To begin collecting, select the 'Enable' button, which will bring you to a separate workbook that lists out the key vaults that require enabling diagnostic logs.
30
+
1. The Operations & Latency tab helps you determine how many and which key vaults are enabled. To begin collecting, select the **Enable** button, which will bring you to a separate workbook that lists out the key vaults that require enabling diagnostic logs.
32
33
33
-
2. To enable diagnostic logs, click on the 'Enable' link underneath the actions column, and create a new diagnostics setting that sends logs to a Log Analytics workspace. It is recommended to send all the log to the same workspace.
34
+
2. To enable diagnostic logs, click on the **Enable** link underneath the actions column, and create a new diagnostics setting that sends logs to a Log Analytics workspace. It is recommended to send all the logs to the same workspace.
34
35
35
-
3. Once the diagnostic settings are saved, you will be able to view all the logs based charts and visualizations underneath the Key Vault Insights. Please note that it may take several minutes to hours to begin populating the logs.
36
+
3. Once the diagnostic settings are saved, you will be able to view all the log-based charts and visualizations underneath the Key Vault Insights. Please note that it may take several minutes to hours to begin populating the logs.
36
37
37
38
4. For additional assistance on how to enable diagnostic logs for your Key Vault service, read the [full guide](https://docs.microsoft.com/azure/key-vault/key-vault-logging).
38
39
39
40
## View from Azure Monitor
41
+
40
42
From Azure Monitor, you can view request, latency, and failure details from multiple key vaults in your subscription, and help identify performance problems and throttling scenarios.
41
43
42
-
To view the utilization and operations of your storage accounts across all your subscriptions, perform the following steps.
44
+
To view the utilization and operations of your storage accounts across all your subscriptions, perform the following steps:
45
+
46
+
1. Sign into the [Azure portal](https://portal.azure.com/)
43
47
44
-
1. Sign into the [Azure portal](https://portal.azure.com/)
48
+
2. Select **Monitor** from the left-hand pane in the Azure portal, and under the Insights section, select **Key Vaults (preview)**.
45
49
46
-
2. Select Monitor from the left-hand pane in the Azure portal, and under the Insights section, select Key Vaults (preview).
50
+
On the Overview workbook for the selected subscription, the table displays interactive key vault metrics for key vaults grouped within the subscription. You can filter results based on the options you select from the following drop-down lists:
53
55
54
-
Subscriptions – only subscriptions that have key vaults are listed.
56
+
* Subscriptions – only subscriptions that have key vaults are listed.
57
+
58
+
* Key Vaults – by default only up to 5 key vaults are pre-selected. If you select all or multiple key vaults in the scope selector, up to 200 key vaults will be returned. For example, if you had a total of 573 key vaults across three subscriptions that you've selected, only 200 vaults will be displayed.
59
+
60
+
* Time Range – by default, displays the last 24 hours of information based on the corresponding selections made.
55
61
56
-
Key Vaults – by default only up to 5 key vaults are pre-selected. If you select all or multiple key vaults in the scope selector, up to 200 key vaults will be returned. For example, if you had a total of 573 key vaults across three subscriptions that you've selected, only 200 vaults be displayed.
62
+
The counter tile, under the drop-down list, rolls-up the total number of key vaults in the selected subscriptions and reflects how many are selected. There are conditional color-coded heatmaps for the columns of the workbook that report request, failures, and latency metrics. The deepest color has the highest value and a lighter color is based on the lowest values.
57
63
58
-
Time Range – by default, displays the last 24 hours of information based on the corresponding selections made.
64
+
## Failures workbook
59
65
60
-
The counter tile, under the drop-down list, rolls-up the total number of key vaults in the selected subscriptions and reflects how many are selected. There are conditional color-coded heatmaps for the columns of the workbook that report request, failures, and latency metrics. The deepest color has the highest value and a lighter color is based on the lowest values.
66
+
Select **Failures** at the top of the page and the Failures tab opens. It shows you the API hits, frequency over time, along with the amount of certain response codes.
61
67
62
-
## Failures Workbook
63
-
Select Failures at the top of the page and the Failures tab opens. It shows you the API hits, frequency over time, along with the amount of certain response codes.
68
+
There is conditional color-coding or heatmaps for columns in the workbook that report API hits metrics with a blue value. The deepest color has the highest value and a lighter color is based on the lowest values.
68
71
69
72
The workbook displays Successes (2xx status codes), Authentication Errors (401/403 status codes), Throttling (429 status codes), and Other Failures (4xx status codes).
70
73
71
74
To better understand what each of the status codes represent, we recommend reading through the documentation on [Azure Key Vault status and response codes](https://docs.microsoft.com/azure/key-vault/authentication-requests-and-responses).
72
75
73
-
## Operations & Latency Workbook
76
+
## Operations & latency workbook
74
77
75
-
Select Operations & Latency workbook at the top of the page and the Operations & Latency tab opens. This tab enables you to onboard your key vaults for monitoring. For more detailed steps see the "Configuring your Key Vaults for Monitoring" section.
78
+
Select **Operations & Latency**at the top of the page and the **Operations & Latency** tab opens. This tab enables you to onboard your key vaults for monitoring. For more detailed steps see the [Configuring your Key Vaults for Monitoring](#configuring-your-key-vaults-for-monitoring) section.
76
79
77
-
You can see how many of your key vaults are enabled for the logging process. If at least one vault has been configured properly, then you will be able to see tables that display the operations and status codes for each of your key vaults. You can click into the details section for a row to get additional information on the individual operation.
80
+
You can see how many of your key vaults are enabled for the logging. If at least one vault has been configured properly, then you will be able to see tables that display the operations and status codes for each of your key vaults. You can click into the details section for a row to get additional information on the individual operation.
78
81
79
-
82
+
80
83
81
84
If you are not seeing any data for this section, reference the top section on how to enable logs for Azure Key Vault, or check the troubleshooting section below.
85
+
82
86
## Pin and export
83
87
84
-
You can pin any one of the metric sections to an Azure Dashboard by selecting the pushpin icon at the top right of the section.
85
-
88
+
You can pin any one of the metric sections to an Azure dashboard by selecting the pushpin icon at the top right of the section.
89
+
86
90
The multi-subscription and key vaults overview or failures workbooks support exporting the results in Excel format by selecting the download icon to the left of the pushpin icon.
87
91
88
-
92
+
89
93
90
-
## Customize Azure Monitor for Key Vaults
94
+
## Customize Azure Monitor for Key Vault
91
95
92
96
This section highlights common scenarios for editing the workbook to customize in support of your data analytics needs:
93
-
- Scope the workbook to always select a particular subscription or key vault(s)
94
-
- Change metrics in the grid
95
-
- Change the requests threshold
96
-
- Change the color rendering
97
+
* Scope the workbook to always select a particular subscription or key vault(s)
98
+
* Change metrics in the grid
99
+
* Change the requests threshold
100
+
* Change the color rendering
101
+
102
+
You can begin customizations by enabling the editing mode, by selecting the **Customize** button from the top toolbar.
97
103
104
+
98
105
99
-
You can begin customizations by enabling the editing mode, by selecting the Customize button from the top toolbar.
106
+
Customizations are saved to a custom workbook to prevent overwriting the default configuration in our published workbook. Workbooks are saved within a resource group, either in the My Reports section that is private to you or in the Shared Reports section that's accessible to everyone with access to the resource group. After you save the custom workbook, you need to go to the workbook gallery to launch it.
The customizations are saved to a custom workbook to prevent overwriting the default configuration in our published workbook. Workbooks are saved within a resource group, either in the My Reports section that is private to you or in the Shared Reports section that's accessible to everyone with access to the resource group. After you save the custom workbook, you need to go to the workbook gallery to launch it.
108
+
You can configure the multi-subscription and key vault Overview or Failures workbooks to scope to a particular subscription(s) or key vault(s) on every run, perform the following steps.
110
+
### Specifying a subscription or key vault
109
111
110
-
1. Select **Monitor** from the portal and then select **Key Vaults (preview)** from the left-hand pane.
111
-
2. On the **Overview** workbook, from the command bar select **Edit**.
112
-
3. Select from the **Subscriptions** drop-down list one or more subscriptions you want it to default to. Remember, the workbook supports selecting up to a total of 10 subscriptions.
113
-
4. Select from the **Key Vaults** drop-down list one or more accounts you want it to default to. Remember, the workbook supports selecting up to a total of 200 storage accounts.
114
-
5. Select **Save as** from the command bar to save a copy of the workbook with your customizations, and then click **Done editing** to return to reading mode.
112
+
You can configure the multi-subscription and key vault Overview or Failures workbooks to scope to a particular subscription(s) or key vault(s) on every run, by performing the following steps:
113
+
114
+
1. Select **Monitor** from the portal and then select **Key Vaults (preview)** from the left-hand pane.
115
+
2. On the **Overview** workbook, from the command bar select **Edit**.
116
+
3. Select from the **Subscriptions** drop-down list one or more subscriptions you want yo use as the default. Remember, the workbook supports selecting up to a total of 10 subscriptions.
117
+
4. Select from the **Key Vaults** drop-down list one or more accounts you want it to use as the default. Remember, the workbook supports selecting up to a total of 200 storage accounts.
118
+
5. Select **Save as** from the command bar to save a copy of the workbook with your customizations, and then click **Done editing** to return to reading mode.
115
119
116
120
## Troubleshooting
117
121
118
-
This section will help you with the diagnosis and troubleshooting of some of the common issues you may encounter when using Azure Monitor for Key Vaults (preview). Use the list below to locate the information relevant to your specific issue.
122
+
This section will help you with the diagnosis and troubleshooting of some of the common issues you may encounter when using Azure Monitor for Key Vault (preview). Use the list below to locate the information relevant to your specific issue.
119
123
120
124
### Resolving performance issues or failures
121
125
122
-
To help troubleshoot any key vault related issues you identify with Azure Monitor for Key Vaults (preview), see the (Azure Key Vault documentation)[https://docs.microsoft.com/azure/key-vault/].
126
+
To help troubleshoot any key vault related issues you identify with Azure Monitor for Key Vaults (preview), see the [Azure Key Vault documentation](https://docs.microsoft.com/azure/key-vault/).
123
127
124
128
### Why can I only see 200 key vaults?
125
129
126
-
There is a limit of 200 key vaults that can be selected and viewed. Regardless of the number of selected subscriptions, the number of select key vaults has a limit of 200.
130
+
There is a limit of 200 key vaults that can be selected and viewed. Regardless of the number of selected subscriptions, the number of selected key vaults has a limit of 200.
127
131
128
132
### What will happen when a pinned item is clicked?
129
133
130
134
When a pinned item on the dashboard is clicked, it will open one of two things:
131
-
1.If the Insights were saved – it will open the insights instance that the pin was saved from
132
-
2.If the insights were unsaved – it will open a new default insights instance
135
+
*If the Insights were saved – it will open the insights instance that the pin was saved from.
136
+
*If the insights were unsaved – it will open a new default insights instance.
133
137
134
138
### Why don't I see all my subscriptions in the subscription picker?
135
139
136
-
We only show Subscriptions that contain key vaults, chosen from the selected subscription filter, which are selected in the "Directory + Subscription" in the Azure portal header.
140
+
We only show subscriptions that contain key vaults, chosen from the selected subscription filter, which are selected in the "Directory + Subscription" in the Azure portal header.
141
+
142
+
### I am getting an error message that the "query exceeds the maximum number of workspaces/regions allowed", what to do now?
145
+
141
146
Currently, there is a limit to 25 regions and 200 workspaces, to view your data, you will need to reduce the number of subscriptions and/or resource groups.
142
-
### I want to make changes or add additional visualizations to KVI, how do I do so?
147
+
148
+
### I want to make changes or add additional visualizations to Key Vault Insights, how do I do so?
143
149
144
150
To make changes, select the "Edit Mode" to modify the workbook, then you can save your work as a new workbook that is tied to a designated subscription and resource group.
151
+
145
152
### What is the time-grain once we pin any part of the Workbooks?
146
153
147
154
We utilize the "Auto" time grain, therefore it depends on what time range is selected.
@@ -162,6 +169,6 @@ Currently, diagnostic logs do not work retroactively, so the data will only star
162
169
163
170
You can edit the existing workbook, through the use of the edit mode, and then save your work as a new workbook that will have all your new changes.
164
171
165
-
166
172
## Next steps
173
+
167
174
Learn the scenarios workbooks are designed to support, how to author new and customize existing reports, and more by reviewing [Create interactive reports with Azure Monitor workbooks](https://docs.microsoft.com/azure/azure-monitor/app/usage-workbooks).
0 commit comments