Rediger

Azure Batch monitoring data reference

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.

  • All columns might not be present in every table.
  • Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.

Table headings

  • Category - The metrics group or classification.
  • Metric - The metric display name as it appears in the Azure portal.
  • Name in REST API - The metric name as referred to in the REST API.
  • Unit - Unit of measure.
  • Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), 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.

Category: API

Metric Name in REST API Advanced platform metrics Unit Aggregation Dimensions Time Grains DS Export
API Request Count

Number of API requests made to the service
ApiCount No Count Total (Sum) operation, result PT1M Yes
API Request Duration

Duration the server spends handling an API request in milliseconds - measured from the time a request is received to the time a response is sent
ApiDuration No MilliSeconds Average operation, result PT1M Yes

Category: Resource Allocation

Metric Name in REST API Advanced platform metrics Unit Aggregation Dimensions Time Grains DS Export
Dedicated Core Count

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

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

Number of idle nodes
IdleNodeCount No Count Total (Sum) <none> PT1M No
Leaving Pool Node Count

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

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

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

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

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

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

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

Total number of pool resizes that have started
PoolResizeStartEvent No Count Total (Sum) poolId PT1M Yes
Preempted Node Count

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

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

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

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

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

Number of nodes where the Start Task has failed
StartTaskFailedNodeCount No Count Total (Sum) <none> PT1M No
Low-Priority Node Count

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

Total number of dedicated nodes in the batch account
TotalNodeCount No Count Total (Sum) <none> PT1M No
Unknown State Node Count

Number of unknown state nodes
UnknownStateNodeCount No Count Total (Sum) <none> PT1M No
Unusable Node Count

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

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

Category: Scheduling

Metric Name in REST API Advanced platform metrics Unit Aggregation Dimensions Time Grains DS Export
Job Delete Complete Events

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

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

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

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

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

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

Total number of jobs that have been requested to be terminated.
JobTerminateStartEvent No Count Total (Sum) jobId PT1M Yes
Task Complete Events

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

Total number of tasks that have completed in a failed state
TaskFailEvent No Count Total (Sum) poolId, jobId PT1M Yes
Task Requeue Events

Total number of tasks that got requeued
TaskRequeueEvent No Count Total (Sum) poolId, jobId PT1M Yes
Task Schedule Fail Events

Total number of tasks failed to schedule
TaskScheduleFailEvent No Count Total (Sum) poolId, jobId PT1M Yes
Task Start Events

Total number of tasks that have started
TaskStartEvent No Count Total (Sum) poolId, jobId PT1M Yes

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 Costs to export Log table Supports basic log plan Supports ingestion-time transformation Example queries
Audit Logs Yes AzureDiagnostics

Logs from multiple Azure resources.

No No Queries
Service Logs No AzureDiagnostics

Logs from multiple Azure resources.

No No Queries

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 can be recorded in the activity log for this service. These operations are 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.