Azure Batch monitoring data reference

  • Article

This article contains all the monitoring reference information for this service.

See Monitor Azure Batch for details on the data you can collect for Azure Batch and how to use it.

Metrics

This section lists all the automatically collected platform metrics for this service. These metrics are also part of the global list of all platform metrics supported in Azure Monitor.

For information on metric retention, see Azure Monitor Metrics overview.

Supported metrics for Microsoft.Batch/batchaccounts

The following table lists the metrics available for the Microsoft.Batch/batchaccounts resource type.

Table headings

  • Metric - The metric display name as it appears in the Azure portal.
  • Name in Rest API - Metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average, Minimum, Maximum, Total, Count.
  • Dimensions - Dimensions available for the metric.
  • Time Grains - Intervals at which the metric is sampled. For example, PT1M indicates that the metric is sampled every minute, PT30M every 30 minutes, PT1H every hour, and so on.
  • DS Export- Whether the metric is exportable to Azure Monitor Logs via Diagnostic Settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
Metric Name in REST API Unit Aggregation Dimensions Time Grains DS Export
Dedicated Core Count

Total number of dedicated cores in the batch account		 CoreCount Count Total <none> PT1M No
Creating Node Count

Number of nodes being created		 CreatingNodeCount Count Total <none> PT1M No
Idle Node Count

Number of idle nodes		 IdleNodeCount Count Total <none> PT1M No
Job Delete Complete Events

Total number of jobs that have been successfully deleted.		 JobDeleteCompleteEvent Count Total jobId PT1M Yes
Job Delete Start Events

Total number of jobs that have been requested to be deleted.		 JobDeleteStartEvent Count Total jobId PT1M Yes
Job Disable Complete Events

Total number of jobs that have been successfully disabled.		 JobDisableCompleteEvent Count Total jobId PT1M Yes
Job Disable Start Events

Total number of jobs that have been requested to be disabled.		 JobDisableStartEvent Count Total jobId PT1M Yes
Job Start Events

Total number of jobs that have been successfully started.		 JobStartEvent Count Total jobId PT1M Yes
Job Terminate Complete Events

Total number of jobs that have been successfully terminated.		 JobTerminateCompleteEvent Count Total jobId PT1M Yes
Job Terminate Start Events

Total number of jobs that have been requested to be terminated.		 JobTerminateStartEvent Count Total jobId PT1M Yes
Leaving Pool Node Count

Number of nodes leaving the Pool		 LeavingPoolNodeCount Count Total <none> PT1M No
LowPriority Core Count

Total number of low-priority cores in the batch account		 LowPriorityCoreCount Count Total <none> PT1M No
Offline Node Count

Number of offline nodes		 OfflineNodeCount Count Total <none> PT1M No
Pool Create Events

Total number of pools that have been created		 PoolCreateEvent Count Total poolId PT1M Yes
Pool Delete Complete Events

Total number of pool deletes that have completed		 PoolDeleteCompleteEvent Count Total poolId PT1M Yes
Pool Delete Start Events

Total number of pool deletes that have started		 PoolDeleteStartEvent Count Total poolId PT1M Yes
Pool Resize Complete Events

Total number of pool resizes that have completed		 PoolResizeCompleteEvent Count Total poolId PT1M Yes
Pool Resize Start Events

Total number of pool resizes that have started		 PoolResizeStartEvent Count Total poolId PT1M Yes
Preempted Node Count

Number of preempted nodes		 PreemptedNodeCount Count Total <none> PT1M No
Rebooting Node Count

Number of rebooting nodes		 RebootingNodeCount Count Total <none> PT1M No
Reimaging Node Count

Number of reimaging nodes		 ReimagingNodeCount Count Total <none> PT1M No
Running Node Count

Number of running nodes		 RunningNodeCount Count Total <none> PT1M No
Starting Node Count

Number of nodes starting		 StartingNodeCount Count Total <none> PT1M No
Start Task Failed Node Count

Number of nodes where the Start Task has failed		 StartTaskFailedNodeCount Count Total <none> PT1M No
Task Complete Events

Total number of tasks that have completed		 TaskCompleteEvent Count Total poolId, jobId PT1M Yes
Task Fail Events

Total number of tasks that have completed in a failed state		 TaskFailEvent Count Total poolId, jobId PT1M Yes
Task Start Events

Total number of tasks that have started		 TaskStartEvent Count Total poolId, jobId PT1M Yes
Low-Priority Node Count

Total number of low-priority nodes in the batch account		 TotalLowPriorityNodeCount Count Total <none> PT1M No
Dedicated Node Count

Total number of dedicated nodes in the batch account		 TotalNodeCount Count Total <none> PT1M No
Unusable Node Count

Number of unusable nodes		 UnusableNodeCount Count Total <none> PT1M No
Waiting For Start Task Node Count

Number of nodes waiting for the Start Task to complete		 WaitingForStartTaskNodeCount Count Total <none> PT1M No

Metric dimensions

For information about what metric dimensions are, see Multi-dimensional metrics.

This service has the following dimensions associated with its metrics.

  • poolId
  • jobId

Resource logs

This section lists the types of resource logs you can collect for this service. The section pulls from the list of all resource logs category types supported in Azure Monitor.

Supported resource logs for Microsoft.Batch/batchaccounts

Category Category display name Log table Supports basic log plan Supports ingestion-time transformation Example queries Costs to export
AuditLog Audit Logs AzureDiagnostics

Logs from multiple Azure resources.

 No No Queries Yes
ServiceLog Service Logs AzureDiagnostics

Logs from multiple Azure resources.

 No No Queries No
ServiceLogs Service Logs No No Yes

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:

Each event emitted by Batch is logged in JSON format. The following example shows the body of a sample pool create event:

{
    "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
}

Azure Monitor Logs tables

This section lists the Azure Monitor Logs tables relevant to this service, which are available for query by Log Analytics using Kusto queries. The tables contain resource log data and possibly more depending on what is collected and routed to them.

Batch Accounts

microsoft.batch/batchaccounts

Activity log

The linked table lists the operations that may be recorded in the activity log for this service. This is a subset of all the possible resource provider operations in the activity log.

For more information on the schema of activity log entries, see Activity Log schema.

Related content