Merge pull request #268343 from v-thepet/batch-monitor

Azure Monitor horizontals - Batch

Author: Jill Grant

.openpublishing.redirection.json

@@ -3899,6 +3899,16 @@
             "redirect_url": "/azure/operational-excellence/relocation-key-vault",
             "redirect_document_id": false
         },
+        {
+            "source_path_from_root": "/articles/batch/monitoring-overview.md",
+            "redirect_url": "/azure/batch/monitor-batch",
+            "redirect_document_id": false
+        },
+        {
+            "source_path_from_root": "/articles/batch/batch-diagnostics.md",
+            "redirect_url": "/azure/batch/monitor-batch",
+            "redirect_document_id": false
+        },
         {
             "source_path_from_root": "/articles/event-hubs/move-cluster-across-regions.md",
             "redirect_url": "/azure/operational-excellence/relocation-event-hub-cluster",

articles/batch/TOC.yml

@@ -251,20 +251,17 @@
       href: batch-task-output-files.md
     - name: Persist output with File Conventions library
       href: batch-task-output-file-conventions.md
-  - name: Monitor Batch solutions
-    href: monitoring-overview.md
+  - name: Monitor
+    href: monitor-batch.md
     items:
-    - name: Use metrics and diagnostic logs
-      displayName: alert, monitor
-      href: batch-diagnostics.md
     - name: Monitor with Application Insights
       displayName: debug
       href: monitor-application-insights.md
-    - name: Count resources by state
-      href: batch-get-resource-counts.md
-    - name: Query resources efficiently
+    - name: Create efficient query lists
       displayName: monitor, queries
       href: batch-efficient-list-queries.md
+    - name: Count resources by state
+      href: batch-get-resource-counts.md
   - name: Use scripting tools
     items:
     - name: Use Azure PowerShell
@@ -322,7 +319,9 @@
       href: /rest/api/batchmanagement/
   - name: Resource Manager template
     href: /azure/templates/microsoft.batch/allversions
-  - name: Batch Analytics
+  - name: Monitoring data reference
+    href: monitor-batch-reference.md
+  - name: Batch analytics
     href: batch-analytics.md
     items:
     - name: Pool create event

articles/batch/batch-diagnostics.md

@@ -0,0 +1,101 @@
+---
+title: Monitoring data reference for Azure Batch
+description: This article contains important reference material you need when you monitor Azure Batch.
+ms.date: 03/28/2024
+ms.custom: horz-monitor
+ms.topic: reference
+ms.service: batch
+---
+
+# Azure Batch monitoring data reference
+
+<!-- Intro. Required. -->
+[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
+
+See [Monitor Azure Batch](monitor-batch.md) for details on the data you can collect for Azure Batch and how to use it.
+
+[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
+
+### Supported metrics for Microsoft.Batch/batchaccounts
+The following table lists the metrics available for the Microsoft.Batch/batchaccounts resource type.
+[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
+[!INCLUDE [Microsoft.Batch/batchaccounts](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-batch-batchaccounts-metrics-include.md)]
+
+[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
+
+[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
+
+- poolId
+- jobId
+
+[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
+
+### Supported resource logs for Microsoft.Batch/batchaccounts
+[!INCLUDE [Microsoft.Batch/batchaccounts](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-batch-batchaccounts-logs-include.md)]
+
+### Service log events
+
+Batch service logs contain events emitted by the Batch service during the lifetime of an individual Batch resource, such as a pool or task. The Batch service emits the following log events:
+
+- [Pool create](batch-pool-create-event.md)
+- [Pool delete start](batch-pool-delete-start-event.md)
+- [Pool delete complete](batch-pool-delete-complete-event.md)
+- [Pool resize start](batch-pool-resize-start-event.md)
+- [Pool resize complete](batch-pool-resize-complete-event.md)
+- [Pool autoscale](batch-pool-autoscale-event.md)
+- [Task start](batch-task-start-event.md)
+- [Task complete](batch-task-complete-event.md)
+- [Task fail](batch-task-fail-event.md)
+- [Task schedule fail](batch-task-schedule-fail-event.md)
+
+Each event emitted by Batch is logged in JSON format. The following example shows the body of a sample **pool create event**:
+
+```json
+{
+    "id": "myPool1",
+    "displayName": "Production Pool",
+    "vmSize": "Standard_F1s",
+    "imageType": "VirtualMachineConfiguration",
+    "cloudServiceConfiguration": {
+        "osFamily": "3",
+        "targetOsVersion": "*"
+    },
+    "networkConfiguration": {
+        "subnetId": " "
+    },
+    "virtualMachineConfiguration": {
+          "imageReference": {
+            "publisher": " ",
+            "offer": " ",
+            "sku": " ",
+            "version": " "
+          },
+          "nodeAgentId": " "
+        },
+    "resizeTimeout": "300000",
+    "targetDedicatedNodes": 2,
+    "targetLowPriorityNodes": 2,
+    "taskSlotsPerNode": 1,
+    "vmFillType": "Spread",
+    "enableAutoScale": false,
+    "enableInterNodeCommunication": false,
+    "isAutoPool": false
+}
+```
+
+[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
+### Batch Accounts
+microsoft.batch/batchaccounts
+
+- [AzureActivity](/azure/azure-monitor/reference/tables/AzureActivity#columns)
+- [AzureMetrics](/azure/azure-monitor/reference/tables/AzureMetrics#columns)
+- [AzureDiagnostics](/azure/azure-monitor/reference/tables/AzureDiagnostics#columns)
+
+[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
+- [Microsoft.Batch resource provider operations](/azure/role-based-access-control/permissions/compute#microsoftbatch)
+
+## Related content
+
+- See [Monitor Batch](monitor-batch.md) for a description of monitoring Batch.
+- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.
+- Learn about the [Batch APIs and tools](batch-apis-tools.md) available for building Batch solutions.