Merge pull request #267635 from v-thepet/datashare-monitor

Azure Monitor horizontals - Azure Data Share

Author: Stacyrch140

articles/data-share/TOC.yml

@@ -66,6 +66,8 @@
   - name: Revoke a share subscription
     href: how-to-revoke-share-subscription.md
   - name: Monitor
+    href: monitor-data-share.md
+  - name: Monitor share status and history
     href: how-to-monitor.md
   - name: Disaster recovery
     href: disaster-recovery.md
@@ -84,6 +86,8 @@
     href: /rest/api/datashare
   - name: Azure CLI
     href: /cli/azure/azure-cli-reference-for-data-share
+  - name: Monitoring data reference
+    href: monitor-data-share-reference.md
 - name: Resources
   items:
   - name: Microsoft Q&A question page

articles/data-share/how-to-monitor.md

@@ -1,18 +1,22 @@
 ---
-title: How to monitor Azure Data Share 
-description: Learn how to monitor invitation status, share subscriptions, and snapshot history in Azure Data Share 
+title: Monitor Azure Data Share status and history
+description: Learn how to monitor invitation status, share subscriptions, and snapshot history for Azure Data Share 
 author: sidontha
 ms.author: sidontha
 ms.service: data-share
 ms.topic: how-to
-ms.date: 12/19/2023
+ms.date: 02/29/2024
 ---
 
-# Monitor Azure Data Share  
+# Monitor Azure Data Share status and history
 
-This article explains how you can monitor your data shares using Azure Data Share. As a data provider, you're able to monitor various aspects of your data sharing relationships. Details such as whether your data consumers have accepted your invitation to the data share, and whether they have created a share subscription and started to use your data are all available to monitor.
+This article explains how you can monitor your Azure Data Share status and history.
 
-As a data consumer, you can monitor the snapshots that have been triggered into your Azure subscription.
+- As a data provider, you can monitor various aspects of your data sharing relationships. Details such as whether your data consumers have accepted your invitation to the data share, and whether they have created a share subscription and started to use your data, are all available to monitor.
+
+- As a data consumer, you can monitor the snapshots that have been triggered into your Azure subscription.
+
+You can also see Azure Monitor metrics, collect logs, analyze monitoring data, and create alerts for your Data Share shares. For information about all the monitoring options that are available for Data Share, see [Monitor Azure Data Share](monitor-data-share.md).
 
 ## Monitor invitation status
 
@@ -43,12 +47,8 @@ You can view more details about each snapshot run by selecting the run start dat
 
 Up to 30 days of snapshot history is displayed. If you need to save and see more than 30 days worth of history, you can use diagnostic setting.
 
-## Diagnostic setting
-
-You can configure diagnostic setting to save log data or events. Navigate to Monitoring -> Diagnostic settings and select **Add diagnostic setting**. Select the log data or events that you're interested in, and where you want to store or send them.
-
-![Screenshot shows the Diagnostic settings page in the Azure portal.](./media/diagnostic-settings.png "Diagnostic settings")
-
 ## Next steps
 
-Learn more about [Azure Data Share terminology](terminology.md)
+- Learn more about [Azure Data Share terminology](terminology.md).
+- See [Monitor Data Share](monitor-data-share.md) for more details about monitoring Data Share.
+

articles/data-share/monitor-data-share-reference.md

@@ -0,0 +1,54 @@
+---
+title: Monitoring data reference for Azure Data Share
+description: This article contains important reference material you need when you monitor Azure Data Share.
+ms.date: 02/28/2024
+ms.custom: horz-monitor
+ms.topic: reference
+author: sidontha
+ms.author: sidontha
+ms.service: data-share
+---
+
+# Azure Data Share monitoring data reference
+
+[!INCLUDE [horz-monitor-ref-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
+
+See [Monitor Data Share](monitor-data-share.md) for details on the data you can collect for Azure Data Share and how to use it.
+
+[!INCLUDE [horz-monitor-ref-metrics-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
+
+### Supported metrics for Microsoft.DataShare/accounts
+The following table lists the metrics available for the Microsoft.DataShare/accounts resource type.
+[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
+[!INCLUDE [Microsoft.DataShare/accounts](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-datashare-accounts-metrics-include.md)]
+
+[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
+[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
+
+- **Sent Shares:** ShareName
+- **Received Shares:** ShareSubscriptionName
+
+[!INCLUDE [horz-monitor-ref-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
+
+### Supported resource logs for Microsoft.DataShare/accounts
+[!INCLUDE [Microsoft.DataShare/accounts](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-datashare-accounts-logs-include.md)]
+
+[!INCLUDE [horz-monitor-ref-logs-tables](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
+
+### Data Share
+
+Microsoft.DataShare/accounts
+
+- [AzureActivity](/azure/azure-monitor/reference/tables/AzureActivity#columns)
+- [AzureMetrics](/azure/azure-monitor/reference/tables/AzureMetrics#columns)
+- [MicrosoftDataShareSentSnapshotLog](/azure/azure-monitor/reference/tables/MicrosoftDataShareSentSnapshotLog#columns)
+- [MicrosoftDataShareReceivedSnapshotLog](/azure/azure-monitor/reference/tables/MicrosoftDataShareReceivedSnapshotLog#columns)
+- [MicrosoftDataShareShareLog](/azure/azure-monitor/reference/tables/MicrosoftDataShareShareLog#columns)
+
+[!INCLUDE [horz-monitor-ref-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
+- [Microsoft.DataShare resource provider operations](/azure/role-based-access-control/permissions/storage#microsoftdatashare)
+
+## Related content
+
+- See [Monitor Data Share](monitor-data-share.md) for a description of monitoring Data Share.
+- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.

articles/data-share/monitor-data-share.md

@@ -0,0 +1,93 @@
+---
+title: Monitor Azure Data Share
+description: Start here to learn how to monitor Azure Data Share.
+ms.date: 03/05/2024
+ms.custom: horz-monitor
+ms.topic: conceptual
+author: sidontha
+ms.author: sidontha
+ms.service: data-share
+---
+
+# Monitor Azure Data Share
+
+[!INCLUDE [horz-monitor-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-intro.md)]
+
+[!INCLUDE [horz-monitor-resource-types](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-resource-types.md)]
+For more information about the resource types for Azure Data Share, see [Data Share monitoring data reference](monitor-data-share-reference.md).
+
+[!INCLUDE [horz-monitor-data-storage](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-data-storage.md)]
+
+[!INCLUDE [horz-monitor-platform-metrics](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-platform-metrics.md)]
+
+To view charts for Data Share metrics, select **Metrics** under **Monitoring** in the left navigation of your Data Share page in the Azure portal.
+
+For a full listing and descriptions of the available metrics for Data Share, see [Data Share monitoring data reference](monitor-data-share-reference.md#metrics).
+
+[!INCLUDE [horz-monitor-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-resource-logs.md)]
+
+You can configure diagnostic settings to save log data or events. Select **Diagnostic settings** under **Monitoring** in the left navigation of your Azure portal Data Share page, and then select the appropriate resource log categories to collect.
+
+:::image type="content" source="./media/diagnostic-settings.png" alt-text="Screenshot that shows the Diagnostic settings page in the Azure portal.":::
+
+For more information about the available resource log categories, their associated Log Analytics tables, and the logs schemas for Data Share, see [Data Share monitoring data reference](monitor-data-share-reference.md#resource-logs).
+
+[!INCLUDE [horz-monitor-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-activity-log.md)]
+
+## Data Share status and history
+
+To track Data Share invitation status, share subscription status, and snapshot history, select **Sent Shares** under **Data Share** in the left navigation of your Data Share page in the Azure portal. For more information and instructions, see [Monitor Data Share status and history](how-to-monitor.md).
+
+[!INCLUDE [horz-monitor-analyze-data](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-analyze-data.md)]
+[!INCLUDE [horz-monitor-external-tools](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-external-tools.md)]
+
+[!INCLUDE [horz-monitor-kusto-queries](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-kusto-queries.md)]
+
+To write queries and access example queries, select **Logs** under **Monitoring** in the left navigation of your Data Share page in the Azure portal, and then select the **Queries** tab. Here are a couple of example queries.
+
+List of sent snapshots sorted by duration over the last seven days:
+
+```kusto
+// List sent snapshots by duration 
+MicrosoftDataShareSentSnapshotLog
+| where TimeGenerated > ago(7d) 
+| where StartTime != "" and EndTime  != "" 
+| project StartTime , EndTime , DurationSeconds =(todatetime(EndTime)-todatetime(StartTime))/1s , ResourceName = split(_ResourceId,"/accounts/",1) 
+| sort by DurationSeconds desc nulls last
+```
+
+Top 10 most frequent errors over the last seven days:
+
+```kusto
+// Frequent errors in received snapshots 
+MicrosoftDataShareReceivedSnapshotLog 
+| where TimeGenerated > ago(7d)  
+| where Status == "Failed" 
+| summarize count() by _ResourceId, DataSetType // Counting failed logs per datasettype
+| top 10 by count_ desc nulls last
+```
+
+For more example queries, see:
+
+- [Queries for the MicrosoftDataShareReceivedSnapshotLog table](/azure/azure-monitor/reference/queries/microsoftdatasharereceivedsnapshotlog)
+- [Queries for the MicrosoftDataShareSentSnapshotLog table](/azure/azure-monitor/reference/queries/microsoftdatasharesentsnapshotlog)
+
+[!INCLUDE [horz-monitor-alerts](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-alerts.md)]
+
+### Data Share alert rules
+
+To create alerts for your Data Share monitoring data, select **Alerts** under **Monitoring** in the left navigation of your Data Share page in the Azure portal, and then select **Create alert rule**. You can select a signal and configure all the details to trigger and route the alert.
+
+The following table lists some alert rules for Data Share. This is just a suggested list. You can set alerts for any metric, log entry, or activity log entry that's listed in the [Data Share monitoring data reference](monitor-data-share-reference.md).
+
+| Alert type | Condition | Description  |
+|:---|:---|:---|
+|Metrics |Received Share Failed Snapshots |Whenever the count Received Share Failed Snapshots is greater than 0|
+|Activity log |Delete Data Share Account (Data Share Account) |Whenever the Activity Log has an event with Category='Administrative', Signal name='Delete Data Share Account (Data Share Account)'
+
+[!INCLUDE [horz-monitor-advisor-recommendations](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-advisor-recommendations.md)]
+
+## Related content
+
+- See [Data Share monitoring data reference](monitor-data-share-reference.md) for a reference of the metrics, logs, and other important values created for Data Share.
+- See [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for general details on monitoring Azure resources.