Skip to content

Commit bbc31c9

Browse files
committed
first draft vms
1 parent 385cc78 commit bbc31c9

File tree

3 files changed

+304
-107
lines changed

3 files changed

+304
-107
lines changed

articles/virtual-machines/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1919,9 +1919,9 @@
19191919
href: ./windows/tutorial-config-management.md
19201920
- name: Monitoring
19211921
items:
1922-
- name: Monitor virtual machines
1922+
- name: Monitor
19231923
href: monitor-vm.md?toc=/azure/virtual-machines/toc.json
1924-
- name: Monitor virtual machine reference
1924+
- name: Monitoring data reference
19251925
href: monitor-vm-reference.md?toc=/azure/virtual-machines/toc.json
19261926
- name: Availability with Resource Graph
19271927
href: resource-graph-availability.md
Lines changed: 151 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,76 @@
11
---
2-
title: 'Reference: Monitoring Azure virtual machine data'
3-
description: This article covers important reference material for monitoring Azure virtual machines.
4-
ms.service: virtual-machines
5-
ms.custom: subject-monitoring
6-
ms.date: 12/03/2022
2+
title: Monitoring data reference for Azure Virtual Machines
3+
description: This article contains important reference material you need when you monitor Azure Virtual Machines and Virtual Machine Scale Sets.
4+
ms.date: 02/20/2024
5+
ms.custom: horz-monitor
76
ms.topic: reference
7+
ms.service: virtual-machines
88
---
99

10-
# Reference: Monitoring Azure virtual machine data
11-
12-
For more information about collecting and analyzing monitoring data for Azure virtual machines (VMs), see [Monitoring Azure virtual machines](monitor-vm.md).
13-
14-
## Metrics
15-
16-
This section lists the platform metrics that are collected for Azure virtual machines and Virtual Machine Scale Sets.
17-
18-
| Metric type | Resource provider / type namespace<br/> and link to individual metrics |
19-
|-------|-----|
20-
| Virtual machines | [Microsoft.Compute/virtualMachines](../azure-monitor/essentials/metrics-supported.md#microsoftcomputevirtualmachines) |
21-
| Virtual Machine Scale Sets | [Microsoft.Compute/virtualMachineScaleSets](../azure-monitor/essentials/metrics-supported.md#microsoftcomputevirtualmachinescalesets)|
22-
| Virtual Machine Scale Sets and virtual machines | [Microsoft.Compute/virtualMachineScaleSets/virtualMachines](../azure-monitor/essentials/metrics-supported.md#microsoftcomputevirtualmachinescalesetsvirtualmachines)|
23-
24-
For more information, see a list of [platform metrics that are supported in Azure Monitor](/azure/azure-monitor/platform/metrics-supported).
25-
26-
## Metric dimensions
27-
28-
For more information about metric dimensions, see [Multi-dimensional metrics](../azure-monitor/essentials/data-platform-metrics.md#multi-dimensional-metrics).
29-
30-
Azure virtual machines and Virtual Machine Scale Sets have the following dimensions that are associated with their metrics.
31-
32-
| Dimension name | Description |
33-
| ------------------- | ----------------- |
34-
| LUN | Logical unit number |
35-
| VMName | Used with Virtual Machine Scale Sets |
36-
37-
## VM availability metric (preview)
10+
<!--
11+
IMPORTANT
12+
To make this template easier to use, first:
13+
1. Search and replace Virtual Machines with the official name of your service.
14+
2. Search and replace virtual-machines with the service name to use in GitHub filenames.-->
15+
16+
<!-- VERSION 3.0 2024_01_01
17+
For background about this template, see https://review.learn.microsoft.com/en-us/help/contribute/contribute-monitoring?branch=main -->
18+
19+
<!-- Most services can use the following sections unchanged. All headings are required unless otherwise noted.
20+
The sections use #included text you don't have to maintain, which changes when Azure Monitor functionality changes. Add info into the designated service-specific places if necessary. Remove #includes or template content that aren't relevant to your service.
21+
22+
At a minimum your service should have the following two articles:
23+
24+
1. The primary monitoring article (based on the template monitor-service-template.md)
25+
- Title: "Monitor Virtual Machines"
26+
- TOC title: "Monitor"
27+
- Filename: "monitor-virtual-machines.md"
28+
29+
2. A reference article that lists all the metrics and logs for your service (based on this template).
30+
- Title: "Virtual Machines monitoring data reference"
31+
- TOC title: "Monitoring data reference"
32+
- Filename: "monitor-virtual-machines-reference.md".
33+
-->
34+
35+
# Azure Virtual Machines monitoring data reference
36+
37+
<!-- Intro. Required. -->
38+
[!INCLUDE [horz-monitor-ref-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
39+
40+
See [Monitor Azure Virtual Machines](monitor-virtual-machines.md) for details on the data you can collect for Azure Virtual Machines and Virtual Machine Scale Sets and how to use it.
41+
42+
<!-- ## Metrics. Required section. -->
43+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
44+
<!-- Repeat the following section for each resource type/namespace in your service. -->
45+
46+
>[!IMPORTANT]
47+
>Metrics for the guest operating system (guest OS) that runs in Azure Virtual Machines aren't listed here. Guest OS metrics must be collected through one or more agents that run on or as part of the guest operating system. Guest OS metrics include performance counters that track guest CPU percentage or memory usage, both of which are frequently used for autoscaling or alerting.
48+
>
49+
>Host OS metrics are available and listed in the tables. Host OS metrics relate to the Hyper-V session that's hosting your guest OS session. For more information, see [Guest OS and host OS metrics](/azure/azure-monitor/reference/supported-metrics/metrics-index#guest-os-and-host-os-metrics).
50+
51+
### Supported metrics for Microsoft.Compute/virtualMachines
52+
The following table lists the metrics available for the Microsoft.Compute/virtualMachines resource type.
53+
<!-- For each ### section:
54+
1. Replace the <ResourceType/namespace> placeholder in the heading and introductory sentence. Example: ### Supported metrics for Microsoft.Storage/storageAccounts/blobServices
55+
2. Find the metrics for the resource type at https://learn.microsoft.com/azure/azure-monitor/reference/supported-metrics/metrics-index#supported-metrics-per-resource-type, which is autogenerated from underlying systems.
56+
3. Either link to the listed metrics page(s), OR #include the metrics table(s), starting with the tableheader #include.
57+
4. Add any further information after each metrics table #include or link.
58+
Example link to metrics page: - [Microsoft.Storage/storageAccounts/blobServices](/azure/azure-monitor/reference/supported-metrics/microsoft-storage-storageaccounts-blobservices-metrics)
59+
Example #include. Start with the metrics tableheader: -->
60+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
61+
[!INCLUDE [Microsoft.Compute/virtualMachines](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-compute-virtualmachines-metrics-include.md)]
62+
63+
### Supported metrics for Microsoft.Compute/virtualmachineScaleSets
64+
The following table lists the metrics available for the Microsoft.Compute/virtualmachineScaleSets resource type.
65+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
66+
[!INCLUDE [Microsoft.Compute/virtualmachineScaleSets](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-compute-virtualmachinescalesets-metrics-include.md)]
67+
68+
### Supported metrics for Microsoft.Compute/virtualMachineScaleSets/virtualMachines
69+
The following table lists the metrics available for the Microsoft.Compute/virtualMachineScaleSets/virtualMachines resource type.
70+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
71+
[!INCLUDE [Microsoft.Compute/virtualMachineScaleSets/virtualMachines](~/azure-reference-other-repo/azure-monitor-ref/supported-metrics/includes/microsoft-compute-virtualmachinescalesets-virtualmachines-metrics-include.md)]
72+
73+
### VM availability metric (preview)
3874
The VM availability metric is currently in public preview. This metric value indicates whether a machine is currently running and available. You can use the metric to trend availability over time and to alert if the machine is stopped. VM availability has the values in the following table.
3975

4076
| Value | Description |
@@ -43,21 +79,85 @@ The VM availability metric is currently in public preview. This metric value ind
4379
| 0 | VM is unavailable. The VM could be stopped or rebooting. If you shutdown a VM from within the VM, it will emit this value. |
4480
| Null | State of the VM is unknown. If you stop a VM from the Azure portal, CLI, or PowerShell, it will immediately stop emitting the availability metric, and you will see null values. |
4581

82+
<!-- ## Metric dimensions. Required section. -->
83+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
84+
<!-- Use one of the following includes, depending on whether you have metrics with dimensions.
85+
- If you have metrics with dimensions, use the following include and list the metrics with dimensions after the include. For an example, see https://learn.microsoft.com/azure/storage/common/monitor-storage-reference#metrics-dimensions. Questions: email [email protected]. -->
86+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
4687

47-
## Azure Monitor Logs tables
48-
49-
This section refers to all the Azure Monitor Logs tables that are relevant to virtual machines and Virtual Machine Scale Sets and available for query by Log Analytics.
50-
51-
|Resource type | Notes |
52-
|-------|-----|
53-
| [Virtual machines](/azure/azure-monitor/reference/tables/tables-resourcetype#virtual-machines) | |
54-
| [Virtual Machine Scale Sets](/azure/azure-monitor/reference/tables/tables-resourcetype#virtual-machine-scale-sets) | |
88+
Virtual Machines and Virtual Machine Scale Sets have the following dimensions that are associated with their metrics:
5589

56-
For reference documentation about Azure Monitor Logs and Log Analytics tables, see the [Azure Monitor Logs table reference](/azure/azure-monitor/reference/tables/tables-resourcetype).
57-
58-
## Activity log
90+
| Dimension name | Description |
91+
| ------------------- | ----------------- |
92+
| LUN | Logical unit number |
93+
| VMName | Used with Virtual Machine Scale Sets |
5994

60-
The following table lists a few example operations that relate to creating virtual machines in the activity log. For a complete list of possible log entries, see [Microsoft.Compute Resource Provider options](../role-based-access-control/resource-provider-operations.md#compute).
95+
<!-- If you DON'T have metrics with dimensions, use the following include:
96+
[!INCLUDE [horz-monitor-ref-no-metrics-dimensions](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-no-metrics-dimensions.md)] -->
97+
98+
<!-- ## Resource logs. Required section. -->
99+
[!INCLUDE [horz-monitor-ref-resource-logs](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
100+
101+
<!-- Add at least one resource provider/resource type here. Repeat this section for each resource type/namespace in your service. Example: ### Supported resource logs for Microsoft.Storage/storageAccounts/blobServices -->
102+
### Supported resource logs for Microsoft.Compute/virtualMachines
103+
[!INCLUDE [Microsoft.Compute/virtualMachines](~/azure-reference-other-repo/azure-monitor-ref/supported-logs/includes/microsoft-compute-virtualmachines-logs-include.md)]
104+
105+
<!-- ## Azure Monitor Logs tables. Required section. -->
106+
[!INCLUDE [horz-monitor-ref-logs-tables](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
107+
### Virtual Machines
108+
|Microsoft.Compute/VirtualMachines|Microsoft.Compute/virtualMachineScaleSets|
109+
--------------|------------------------|
110+
[Heartbeat](/azure/azure-monitor/reference/tables/Heartbeat#columns)|[AzureActivity](/azure/azure-monitor/reference/tables/AzureActivity#columns)
111+
[W3CIISLog](/azure/azure-monitor/reference/tables/W3CIISLog#columns)|[AzureMetrics](/azure/azure-monitor/reference/tables/AzureMetrics#columns)
112+
[AzureActivity](/azure/azure-monitor/reference/tables/AzureActivity#columns)|[ConfigurationChange](/azure/azure-monitor/reference/tables/ConfigurationChange#columns)
113+
[AzureMetrics](/azure/azure-monitor/reference/tables/AzureMetrics#columns)|[ConfigurationData](/azure/azure-monitor/reference/tables/ConfigurationData#columns)
114+
[ADAssessmentRecommendation#columns)|[ADAssessmentRecommendation](/azure/azure-monitor/reference/tables/ContainerLog](/azure/azure-monitor/reference/tables/ContainerLog#columns)
115+
[ADReplicationResult](/azure/azure-monitor/reference/tables/ADReplicationResult#columns)|[Event](/azure/azure-monitor/reference/tables/Event#columns)
116+
[ComputerGroup](/azure/azure-monitor/reference/tables/ComputerGroup#columns)|[Heartbeat](/azure/azure-monitor/reference/tables/Heartbeat#columns)
117+
[ContainerLog](/azure/azure-monitor/reference/tables/ContainerLog#columns)|[Perf](/azure/azure-monitor/reference/tables/Perf#columns)
118+
[DnsEvents](/azure/azure-monitor/reference/tables/DnsEvents#columns)|[ProtectionStatus](/azure/azure-monitor/reference/tables/ProtectionStatus#columns)
119+
[DnsInventory](/azure/azure-monitor/reference/tables/DnsInventory#columns)|[SecurityBaseline](/azure/azure-monitor/reference/tables/SecurityBaseline#columns)
120+
[SecurityBaselineSummary](/azure/azure-monitor/reference/tables/SecurityBaselineSummary#columns)|[SecurityEvent](/azure/azure-monitor/reference/tables/SecurityEvent#columns)
121+
[SQLAssessmentRecommendation#columns)|[SQLAssessmentRecommendation](/azure/azure-monitor/reference/tables/Syslog](/azure/azure-monitor/reference/tables/Syslog#columns)
122+
[ConfigurationChange](/azure/azure-monitor/reference/tables/ConfigurationChange#columns)|[Update](/azure/azure-monitor/reference/tables/Update#columns)
123+
[ConfigurationData](/azure/azure-monitor/reference/tables/ConfigurationData#columns)|[UpdateRunProgress](/azure/azure-monitor/reference/tables/UpdateRunProgress#columns)
124+
[Event](/azure/azure-monitor/reference/tables/Event#columns)|[UpdateSummary](/azure/azure-monitor/reference/tables/UpdateSummary#columns)
125+
[Perf](/azure/azure-monitor/reference/tables/Perf#columns)|[VMBoundPort](/azure/azure-monitor/reference/tables/VMBoundPort#columns)
126+
[ProtectionStatus](/azure/azure-monitor/reference/tables/ProtectionStatus#columns)|[VMConnection](/azure/azure-monitor/reference/tables/VMConnection#columns)
127+
[SecurityBaseline](/azure/azure-monitor/reference/tables/SecurityBaseline#columns)|[VMComputer](/azure/azure-monitor/reference/tables/VMComputer#columns)
128+
[SecurityEvent](/azure/azure-monitor/reference/tables/SecurityEvent#columns)|[VMProcess](/azure/azure-monitor/reference/tables/VMProcess#columns)
129+
[Syslog](/azure/azure-monitor/reference/tables/Syslog#columns)|[W3CIISLog](/azure/azure-monitor/reference/tables/W3CIISLog#columns)
130+
[Update](/azure/azure-monitor/reference/tables/Update#columns)|[WindowsFirewall](/azure/azure-monitor/reference/tables/WindowsFirewall#columns)
131+
[UpdateRunProgress](/azure/azure-monitor/reference/tables/UpdateRunProgress#columns)|[WireData](/azure/azure-monitor/reference/tables/WireData#columns)
132+
[UpdateSummary](/azure/azure-monitor/reference/tables/UpdateSummary#columns)|[InsightsMetrics](/azure/azure-monitor/reference/tables/InsightsMetrics#columns)
133+
[VMBoundPort](/azure/azure-monitor/reference/tables/VMBoundPort#columns)|[CommonSecurityLog](/azure/azure-monitor/reference/tables/CommonSecurityLog#columns)
134+
[VMConnection](/azure/azure-monitor/reference/tables/VMConnection#columns)||
135+
[VMComputer](/azure/azure-monitor/reference/tables/VMComputer#columns)||
136+
[VMProcess](/azure/azure-monitor/reference/tables/VMProcess#columns)||
137+
[WindowsFirewall](/azure/azure-monitor/reference/tables/WindowsFirewall#columns)||
138+
[WireData](/azure/azure-monitor/reference/tables/WireData#columns)||
139+
[InsightsMetrics](/azure/azure-monitor/reference/tables/InsightsMetrics#columns)||
140+
[HealthStateChangeEvent](/azure/azure-monitor/reference/tables/HealthStateChangeEvent#columns)||
141+
[CommonSecurityLog](/azure/azure-monitor/reference/tables/CommonSecurityLog#columns)||
142+
143+
<!-- Example:
144+
### Storage Accounts
145+
Microsoft.Storage/storageAccounts
146+
- [StorageBlobLogs](/azure/azure-monitor/reference/tables/storagebloblogs#columns)
147+
148+
Find the table(s) for your service at https://learn.microsoft.com/azure/azure-monitor/reference/tables/tables-resourcetype. These files are auto generated from the REST API.
149+
Also refer to https://learn.microsoft.com/azure/azure-monitor/reference/tables/azurediagnostics#azure-diagnostics-mode to see whether your service uses the AzureDiagnostics table in Azure Monitor Logs / Log Analytics.
150+
Link to the service-specific tables. If your service uses the AzureDiagnostics table, list the fields you use and what they're for. If your service uses both tables, list both types of information. Add any further information after each table link, such as descriptions and usage, or information not found in the tables.
151+
152+
IMPORTANT: Field names for Log Analytics may vary from the same field names for Storage. Many services need a mapping table to map the two sets of fields. -->
153+
154+
<!-- ## Activity log. Required section. -->
155+
[!INCLUDE [horz-monitor-ref-activity-log](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
156+
<!-- Refer to https://learn.microsoft.com/azure/role-based-access-control/resource-provider-operations and link to the possible operations for your service, using the format - [<Namespace> resource provider operations](/azure/role-based-access-control/resource-provider-operations#<namespace>).
157+
Example: - [Microsoft.Storage resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftstorage).
158+
If there are other operations not in the link, list them here in table form. -->
159+
160+
The following table lists a few example operations that relate to creating VMs in the activity log. For a complete list of operations, see [Microsoft.Compute resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftcompute).
61161

62162
| Operation | Description |
63163
|:---|:---|
@@ -68,9 +168,11 @@ The following table lists a few example operations that relate to creating virtu
68168
| Microsoft.Compute/virtualMachines/extensions/write | Creates a new virtual machine extension or updates an existing one |
69169
| Microsoft.Compute/virtualMachineScaleSets/write | Starts the instances of the virtual machine scale set |
70170

71-
For more information about the schema of activity log entries, see [Activity log schema](../azure-monitor/essentials/activity-log-schema.md).
72-
171+
<!-- ## Other schemas. Optional section. Please keep heading in this order. If your service uses other schemas, add the following include and information.
172+
[!INCLUDE [horz-monitor-ref-other-schemas](~/articles/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-other-schemas.md)]
173+
List other schemas and their usage here. These can be resource logs, alerts, event hub formats, etc. depending on what you think is important. You can put JSON messages, API responses not listed in the REST API docs, and other similar types of info here. -->
73174

74-
## See also
175+
## Related content
75176

76-
For a description of monitoring Azure virtual machines, see [Monitoring Azure virtual machines](../virtual-machines/monitor-vm.md).
177+
- See [Monitor Virtual Machines](monitor-virtual-machines.md) for a description of monitoring Virtual Machines.
178+
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.

0 commit comments

Comments
 (0)