Skip to content

Commit 2b8c6a4

Browse files
Apoorvkudesia-sumologicjpipkin1amee-sumo
authored
Add Azure Key Vaults Doc changes with Dashboards and alerts (#5188)
* Add Azure Key Vaults Doc changes with Dashboards and alerts * Updates from review * Fix typo * Remove duplicate step * Fixes for PR comments * Fixing PR comments on Metrics collection * Minor fixes for wrong names * Update azure-key-vault.md --------- Co-authored-by: John Pipkin <[email protected]> Co-authored-by: Amee Lepcha <[email protected]>
1 parent 5d0ab5c commit 2b8c6a4

File tree

2 files changed

+88
-16
lines changed

2 files changed

+88
-16
lines changed

docs/integrations/microsoft-azure/azure-key-vault.md

Lines changed: 88 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
88

99
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-key-vault.png')} alt="Thumbnail icon" width="50"/>
1010

11-
[Azure Key Vault](https://learn.microsoft.com/en-us/azure/iot-hub/iot-concepts-and-iot-hub) is a managed service hosted in the cloud that acts as a central message hub for communication between an IoT application and its attached devices. This integration helps in comprehensive monitoring of your key vaults requests, performance, failures, and latency.
11+
[Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/general/overview) is a managed service hosted in the cloud that acts as a central message hub for communication between an IoT application and its attached devices. This integration helps in comprehensive monitoring of your key vaults requests, performance, failures, and latency.
1212

1313
## Log and metric types
1414

1515
For Azure Key Vault, you can collect the following logs and metrics:
1616

17-
* **Resource logs**. To learn more about the different resource log category types and schemas collected for Azure Key Vault, refer to [Azure documentation](https://learn.microsoft.com/en-gb/azure/key-vault/general/monitor-key-vault-reference#resource-logs).
18-
* **Key Vault Metrics**. These metrics are available in [Microsoft.KeyVault/vaults](https://learn.microsoft.com/en-gb/azure/azure-monitor/essentials/metrics-supported#microsoftkeyvaultvaults) namespace.
19-
* **Managed HSM Metrics**. These metrics are available in [Microsoft.KeyVault/managedhsms](https://learn.microsoft.com/en-gb/azure/azure-monitor/essentials/resource-logs-categories#microsoftkeyvaultmanagedhsms) namespace.
17+
* **Resource logs**. To learn more about the different resource log category types and schemas collected for Azure Key Vault, refer to [Azure documentation](https://learn.microsoft.com/en-us/azure/key-vault/general/monitor-key-vault-reference#resource-logs).
18+
* **Key Vault Metrics**. These metrics are available in [Microsoft.KeyVault/vaults](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-keyvault-vaults-metrics) namespace.
19+
* **Managed HSM Metrics**. These metrics are available in [Microsoft.KeyVault/managedhsms](https://learn.microsoft.com/en-us/azure/azure-monitor/reference/supported-metrics/microsoft-keyvault-managedhsms-metrics) namespace.
2020

2121
For more information on supported metrics and their units, refer to the [Azure documentation](https://learn.microsoft.com/en-gb/azure/key-vault/general/monitor-key-vault-reference#key-vault-metrics).
2222

@@ -33,24 +33,96 @@ When you configure the event hubs source or HTTP source, plan your source catego
3333

3434
### Configure metrics collection
3535

36-
In this section, you will configure a pipeline for shipping metrics from Azure Monitor to an Event Hub, on to an Azure Function, and finally to an HTTP Source on a hosted collector in Sumo Logic.
36+
:::note
37+
Sumo Logic Metrics source is currently in Beta, to participate, contact your Sumo Logic account executive.
38+
:::
3739

38-
1. [Configure an HTTP Source](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-1-configure-an-http-source).
39-
2. [Configure and deploy the ARM Template](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-2-configure-azure-resources-using-arm-template).
40-
3. [Export metrics to Event Hub](/docs/send-data/collect-from-other-data-sources/azure-monitoring/collect-metrics-azure-monitor/#step-3-export-metrics-for-a-particular-resource-to-event-hub). Perform below steps for each Key Vault that you want to monitor.
41-
* Choose `Stream to an event hub` as destination.
42-
* Select `AllMetrics`.
43-
* Use the Event hub namespace created by the ARM template in Step 2 above. You can create a new Event hub or use the one created by ARM template. You can use the default policy `RootManageSharedAccessKey` as the policy name.
40+
1. To set up the Azure Metrics source in Sumo Logic, refer to the shared beta documentation.
41+
1. In the Sumo Logic Azure Metrics source configuration, configure namespaces as `Microsoft.KeyVault/vaults` and `Microsoft.KeyVault/managedhsms`.
42+
<img src={useBaseUrl('img/integrations/microsoft-azure/azure-key-vaults-namespaces.png')} alt="Azure Key Vaults Namespaces" style={{border: '1px solid gray'}} width="500" />
4443

4544
### Configure logs collection
4645

4746
In this section, you will configure a pipeline for shipping diagnostic logs from Azure Monitor to an Event Hub.
48-
47+
#### Diagnostic logs
4948
1. To set up the Azure Event Hubs source in Sumo Logic, refer to [Azure Event Hubs Source for Logs](/docs/send-data/collect-from-other-data-sources/azure-monitoring/ms-azure-event-hubs-source/).
50-
2. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#create-diagnostic-settings) for Key Vault resource. Perform below steps for each Key Vault that you want to monitor.
51-
* Choose `Stream to an event hub` as the destination.
52-
* Select `allLogs`.
53-
* Use the Event hub namespace and Event hub name configured in previous step in destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.
49+
1. To create the Diagnostic settings in Azure portal, refer to the [Azure documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/essentials/diagnostic-settings?tabs=portal#create-diagnostic-settings). Perform the steps below for each Azure Key Vault namespace that you want to monitor.
50+
1. Choose `Stream to an event hub` as the destination.
51+
1. Select `allLogs`.
52+
1. Use the Event Hub namespace and Event Hub name configured in the previous step in the destination details section. You can use the default policy `RootManageSharedAccessKey` as the policy name.<br/><img src={useBaseUrl('img/send-data/azure-eventgrid-logs.png')} alt="Azure Event Grid logs" style={{border: '1px solid gray'}} width="800" />
53+
1. Tag the location field in the source with the right location value. <br/><img src={useBaseUrl('img/integrations/microsoft-azure/Azure-Storage-Tag-Location.png')} alt="Azure Key Vaults Tag Location" style={{border: '1px solid gray'}} width="400" />
54+
55+
#### Activity Logs
56+
57+
To collect activity logs, refer to the [Collecting Logs for the Azure Audit App from Event Hub](/docs/integrations/microsoft-azure/audit) section in the Azure Audit documentation. Do not perform this step in case you are already collecting activity logs for a subscription.
58+
:::note
59+
Since this source contains logs from multiple regions, make sure that you do not tag this source with the location tag.
60+
:::
61+
62+
## Viewing the Azure Key Vault dashboards
63+
64+
import ViewDashboards from '../../reuse/apps/view-dashboards.md';
65+
66+
<ViewDashboards/>
67+
68+
### Overview
69+
70+
**Azure Key Vaults - Overview** dashboard allows you to monitor and analyze your key vault's usage metrics, including API hits, vault usage, and average latencies. Gain insights into the performance of your vaults.
71+
72+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Overview.png')} alt="Azure Key Vault - Overview dashboard" style={{border: '1px solid gray'}} width="800" />
73+
74+
### Operations Overview
75+
76+
**Azure Key Vaults - Operations** Overview dashboard provides insights of operational logs for your key vaults. Monitor key, secret, and certificate operations, including creation, storage, deletion, retrieval, setting, and recovery. Gain insights into key activities for effective management.
77+
78+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Operations-Overview.png')} alt="Azure Key Vault - Operations Overview dashboard" style={{border: '1px solid gray'}} width="800" />
79+
80+
### Operations Detailed
81+
82+
**Azure Key Vaults - Operations Detailed** dashboard provides insights of operational logs for your key vaults. Monitor key, secret, and certificate operations, including creation, storage, deletion, retrieval, setting, and recovery in detailed views. Gain insights into key activities for effective management.
83+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Operations-Detailed.png')} alt="Azure Key Vault - Operations Detailed dashboard" style={{border: '1px solid gray'}} width="800" />
84+
85+
### Errors and Failures
86+
87+
**Azure Key Vaults - Errors and Failures** dashboard provides detailed information on what is happening (errors or recent failure events) in a Key Vault.
88+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Errors-and-Failures.png')} alt="Azure Key Vault - Errors and Failures dashboard" style={{border: '1px solid gray'}} width="800" />
89+
90+
### Administrative Operations
91+
92+
**Azure Key Vaults - Administrative Operations** dashboard provides details on the operational activities and status of your Azure Key Vaults resources Use this dashboard to monitor the distribution of operation types and their success rates to ensure proper functioning of your Key Vaults. Identify potential issues by analyzing the top operations causing errors and correlating them with specific users or applications. Track recent write and delete operations to maintain an audit trail of changes made to your Key Vaults.
93+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Administrative-Operations.png')} alt="Azure Key Vault - Administrative Operations dashboard" style={{border: '1px solid gray'}} width="800" />
94+
95+
### Policy and Recommendations
96+
97+
**Azure Key Vaults - Policy and Recommendations** dashboard provides details on policy events and recommendations for your Azure Key Vaults resources. Use this dashboard to monitor the success and failure rates of policy events to ensure proper configuration and compliance. Track and analyse recent recommendations to improve the performance and security of your Vaults setup. Identify trends in policy events and recommendations over time to proactively address potential issues.
98+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Policy-and-Recommendations.png')} alt="Azure Key Vault - Policy and Recommendations dashboard" style={{border: '1px solid gray'}} width="800" />
99+
100+
### Vault Health
101+
102+
**Azure Key Vaults - Vault Health** dashboard allows you to monitor and analyze your key vault's usage metrics, including API hits, vault usage, and average latencies. Gain insights into the health of your vaults.
103+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Vault-Health.png')} alt="Azure Key Vault - Vault Health dashboard" style={{border: '1px solid gray'}} width="800" />
104+
105+
### Compliance
106+
107+
**Azure Key Vaults - Compliance** dashboard provides detailed information on what is happening with polices and compliance related events in a Key Vault and gives an overview of the objects (Keys, Secrets, etc) are adhering to specific compliance and policies in Azure.
108+
<img src={useBaseUrl('https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/AzureKeyVaults/Azure-Key-Vaults-Compliance.png')} alt="Azure Key Vault - Compliance dashboard" style={{border: '1px solid gray'}} width="800" />
109+
110+
## Create monitors for Azure Key Vaults app
111+
112+
import CreateMonitors from '../../reuse/apps/create-monitors.md';
113+
114+
<CreateMonitors/>
115+
116+
### Azure Key Vaults alerts
117+
These alerts are metric based and will work for all Key Vaults.
118+
119+
| Alert Name | Alert Description and Conditions | Alert Condition | Recover Condition |
120+
|:-------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------|:----------------|:------------------|
121+
| `Azure Key Vaults - Availability drops below 100%` | This alert is triggered when availability drops under 100% are detected for any Key Vaults. | Count < 100 | Count = 100 |
122+
| `Azure Key Vaults - Keys, Secrets, Certificates Expired Alert` | This alert triggers when any Keys, Secrets, or Certificates have expired for any Key Vaults. | Count >= 1 | Count < 1 |
123+
| `Azure Key Vaults - Keys, Secrets, Certificates Near Expiry Alert` | This alert triggers when any Keys, Secrets, or Certificates are near expiry for any Key Vaults. | Count >= 1 | Count < 1 |
124+
| `Azure Key Vaults - Latency is greater than 1000 ms` | This alert is triggered when latency of Vaults goes above 1000ms. | Count >= 1000 | Count < 1000 |
125+
| `Azure Key Vaults - Overall Vault Saturation is greater than 75%` | This alert is triggered when Overall vault saturation of any vaults is greater than 75%. | Count >= 75 | Count < 75 |
54126

55127
## Troubleshooting
56128

50.9 KB
Loading

0 commit comments

Comments
 (0)