|
1 | 1 | ---
|
2 |
| -title: Tutorial - Collect guest logs and metrics from Azure virtual machine |
3 |
| -description: Create data collection rule to collect guest logs and metrics from Azure virtual machine. |
| 2 | +title: 'Tutorial: Collect guest logs and metrics from an Azure virtual machine' |
| 3 | +description: Create a data collection rule to collect guest logs and metrics from Azure virtual machine. |
4 | 4 | ms.service: azure-monitor
|
5 | 5 | ms.topic: article
|
6 | 6 | ms.custom: subject-monitoring
|
7 | 7 | ms.date: 12/03/2022
|
8 | 8 | ms.reviewer: Xema Pathak
|
9 | 9 | ---
|
10 | 10 |
|
11 |
| -# Tutorial: Collect guest logs and metrics from Azure virtual machine |
12 |
| -To monitor the guest operating system and workloads on an Azure virtual machine, you need to install the [Azure Monitor agent](../agents/azure-monitor-agent-overview.md) and create a [data collection rule (DCR)](../essentials/data-collection-rule-overview.md) that specifies which data to collect. VM insights will install the agent and collection performance data, but you need to create additional data collection rules to collect log data such as Windows event log and syslog. VM insights also doesn't send guest performance data to Azure Monitor Metrics where it can be analyzed with metrics explorer and used with metrics alerts. |
| 11 | +# Tutorial: Collect guest logs and metrics from an Azure virtual machine |
| 12 | +To monitor the guest operating system and workloads on an Azure virtual machine, install [Azure Monitor Agent](../agents/azure-monitor-agent-overview.md) and create a [data collection rule (DCR)](../essentials/data-collection-rule-overview.md) that specifies which data to collect. VM insights installs the agent and collection performance data, but you need to create more DCRs to collect log data such as Windows event logs and Syslog. VM insights also doesn't send guest performance data to Azure Monitor Metrics where it can be analyzed with metrics explorer and used with metrics alerts. |
13 | 13 |
|
14 | 14 | In this tutorial, you learn how to:
|
15 | 15 |
|
16 | 16 | > [!div class="checklist"]
|
17 |
| -> * Create a data collection rule that sends guest performance data to Azure Monitor Metrics and log events to Azure Monitor Logs. |
| 17 | +> * Create a DCR that sends guest performance data to Azure Monitor Metrics and log events to Azure Monitor Logs. |
18 | 18 | > * View guest logs in Log Analytics.
|
19 | 19 | > * View guest metrics in metrics explorer.
|
20 | 20 |
|
21 | 21 | ## Prerequisites
|
22 |
| -To complete this tutorial you need the following: |
23 |
| - |
24 |
| -- An Azure virtual machine to monitor. |
| 22 | +To complete this tutorial, you need an Azure virtual machine to monitor. |
25 | 23 |
|
26 | 24 | > [!IMPORTANT]
|
27 |
| -> This tutorial does not require VM insights to be enabled for the virtual machine. The Azure Monitor agent will be installed on the VM if it isn't already installed. |
| 25 | +> This tutorial doesn't require VM insights to be enabled for the virtual machine. Azure Monitor Agent is installed on the VM if it isn't already installed. |
28 | 26 |
|
29 |
| -## Create data collection rule |
30 |
| -[Data collection rules](../essentials/data-collection-rule-overview.md) in Azure Monitor define data to collect and where it should be sent. When you define the data collection rule using the Azure portal, you specify the virtual machines it should be applied to. The Azure Monitor agent will automatically be installed on any virtual machines that don't already have it. |
| 27 | +## Create a data collection rule |
| 28 | +[Data collection rules](../essentials/data-collection-rule-overview.md) in Azure Monitor define data to collect and where it should be sent. When you define the DCR by using the Azure portal, you specify the virtual machines it should be applied to. Azure Monitor Agent is automatically installed on any virtual machines that don't already have it. |
31 | 29 |
|
32 | 30 | > [!NOTE]
|
33 |
| -> You must currently install the Azure Monitor agent from **Monitor** menu in the Azure portal. This functionality is not yet available from the virtual machine's menu. |
| 31 | +> You must currently install Azure Monitor Agent from the **Monitor** menu in the Azure portal. This functionality isn't yet available from the virtual machine's menu. |
34 | 32 |
|
35 |
| -From the **Monitor** menu in the Azure portal, select **Data Collection Rules** and then **Create** to create a new data collection rule. |
| 33 | +On the **Monitor** menu in the Azure portal, select **Data Collection Rules**. Then select **Create** to create a new DCR. |
36 | 34 |
|
37 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-create.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-create.png" alt-text="Create data collection rule"::: |
| 35 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-create.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-create.png" alt-text="Screenshot that shows creating a data collection rule."::: |
38 | 36 |
|
39 |
| -On the **Basics** tab, provide a **Rule Name** which is the name of the rule displayed in the Azure portal. Select a **Subscription**, **Resource Group**, and **Region** where the DCR and its associations will be stored. These do not need to be the same as the resources being monitored. The **Platform Type** defines the options that are available as you define the rest of the DCR. Select *Windows* or *Linux* if it will be associated only those resources or *Custom* if it will be associated with both types. |
| 37 | +On the **Basics** tab, enter a **Rule Name**, which is the name of the rule displayed in the Azure portal. Select a **Subscription**, **Resource Group**, and **Region** where the DCR and its associations are stored. These items don't need to be the same as the resources being monitored. The **Platform Type** defines the options that are available as you define the rest of the DCR. Select **Windows** or **Linux** if the rule is associated only with those resources or **Custom** if it's associated with both types. |
40 | 38 |
|
41 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-basics.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-basics.png" alt-text="Data collection rule basics"::: |
| 39 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-basics.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-basics.png" alt-text="Screenshot that shows data collection rule basics."::: |
42 | 40 |
|
43 | 41 | ## Select resources
|
44 |
| -On the **Resources** tab, identify one or more virtual machines that the data collection rule will apply to. The Azure Monitor agent will be installed on any that don't already have it. Click **Add resources** and select either your virtual machines or the resource group or subscription where your virtual machine is located. The data collection rule will apply to all virtual machines in the selected scope. |
| 42 | +On the **Resources** tab, identify one or more virtual machines that the DCR applies to. Azure Monitor Agent is installed on any VMs that don't already have it. Select **Add resources** and select either your virtual machines or the resource group or subscription where your virtual machine is located. The DCR applies to all virtual machines in the selected scope. |
45 | 43 |
|
46 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-resources.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-resources.png" alt-text="Data collection rule resources"::: |
| 44 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-resources.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-resources.png" alt-text="Screenshot that shows data collection rule resources."::: |
47 | 45 |
|
48 | 46 | ## Select data sources
|
49 |
| -A single data collection rule can have multiple data sources. For this tutorial, we'll use the same rule to collect both guest metrics and guest logs. We'll send metrics to both to Azure Monitor Metrics and to Azure Monitor Logs so that they can be analyzed both with metrics explorer and Log Analytics. |
| 47 | +A single DCR can have multiple data sources. For this tutorial, we use the same rule to collect both guest metrics and guest logs. We send metrics to both to Azure Monitor Metrics and to Azure Monitor Logs so that they can be analyzed both with metrics explorer and Log Analytics. |
50 | 48 |
|
51 |
| -On the **Collect and deliver** tab, click **Add data source**. For the **Data source type**, select **Performance counters**. Leave the **Basic** setting and select the counters that you want to collect. **Custom** allows you to select individual metric values. |
| 49 | +On the **Collect and deliver** tab, select **Add data source**. For the **Data source type**, select **Performance counters**. Leave the **Basic** setting and select the counters that you want to collect. Use **Custom** to select individual metric values. |
52 | 50 |
|
53 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-data-source-metric.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-data-source-metric.png" alt-text="Data collection rule metric data source"::: |
| 51 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-data-source-metric.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-data-source-metric.png" alt-text="Screenshot that shows the data collection rule metric data source."::: |
54 | 52 |
|
55 |
| -Select the **Destination** tab. **Azure Monitor Metrics** should already be listed. Click **Add destination** to add another. Select **Azure Monitor Logs** for the **Destination type**. Select your Log Analytics workspace for the **Account or namespace**. Click **Add data source** to save the data source. |
| 53 | +Select the **Destination** tab. **Azure Monitor Metrics** should already be listed. Select **Add destination** to add another. Select **Azure Monitor Logs** for the **Destination type**. Select your Log Analytics workspace for the **Account or namespace**. Select **Add data source** to save the data source. |
56 | 54 |
|
57 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-destination-metric.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-destination-metric.png" alt-text="Data collection rule destination"::: |
| 55 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-destination-metric.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-destination-metric.png" alt-text="Screenshot that shows the data collection rule destination."::: |
58 | 56 |
|
59 |
| -Click **Add data source** again to add logs to the data collection rule. For the **Data source type**, select **Windows event logs** or **Linux syslog**. Select the types of log data that you want to collect. |
| 57 | +Select **Add data source** again to add logs to the DCR. For the **Data source type**, select **Windows event logs** or **Linux syslog**. Select the types of log data that you want to collect. |
60 | 58 |
|
61 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-windows.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-windows.png" alt-text="Data collection rule Windows log data source"::: |
| 59 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-windows.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-windows.png" alt-text="Screenshot that shows the data collection rule Windows log data source."::: |
62 | 60 |
|
63 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-linux.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-linux.png" alt-text="Data collection rule Linux log data source"::: |
| 61 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-linux.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-data-source-logs-linux.png" alt-text="Screenshot that shows the data collection rule Linux log data source."::: |
64 | 62 |
|
65 |
| -Select the **Destination** tab. **Azure Monitor Logs** should already be selected for the **Destination type**. Select your Log Analytics workspace for the **Account or namespace**. If you don't already have a workspace, then you can select the default workspace for your subscription, which will automatically be created. Click **Add data source** to save the data source. |
| 63 | +Select the **Destination** tab. **Azure Monitor Logs** should already be selected for the **Destination type**. Select your Log Analytics workspace for the **Account or namespace**. If you don't already have a workspace, you can select the default workspace for your subscription, which is automatically created. Select **Add data source** to save the data source. |
66 | 64 |
|
67 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-destination-logs.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-destination-logs.png" alt-text="Data collection rule Logs destination"::: |
| 65 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-destination-logs.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-destination-logs.png" alt-text="Screenshot that shows the data collection rule Logs destination."::: |
68 | 66 |
|
69 |
| -Click **Review + create** to create the data collection rule and install the Azure Monitor agent on the selected virtual machines. |
| 67 | +Select **Review + create** to create the DCR and install the Azure Monitor agent on the selected virtual machines. |
70 | 68 |
|
71 |
| -:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-save.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-save.png" alt-text="Save data collection rule"::: |
| 69 | +:::image type="content" source="media/tutorial-monitor-vm/data-collection-rule-save.png" lightbox="media/tutorial-monitor-vm/data-collection-rule-save.png" alt-text="Screenshot that shows saving the data collection rule."::: |
72 | 70 |
|
73 |
| -## Viewing logs |
74 |
| -Data is retrieved from a Log Analytics workspace using a log query written in Kusto Query Language (KQL). While a set of pre-created queries are available for virtual machines, we'll use a simple query to have a look at the events that we're collecting. |
| 71 | +## View logs |
| 72 | +Data is retrieved from a Log Analytics workspace by using a log query written in Kusto Query Language (KQL). Although a set of precreated queries are available for virtual machines, we use a simple query to have a look at the events that we're collecting. |
75 | 73 |
|
76 |
| -Select **Logs** from your virtual machines's menu. Log Analytics opens with an empty query window with the scope set to that machine. Any queries will include only records collected from that machine. |
| 74 | +Select **Logs** from your virtual machine's menu. Log Analytics opens with an empty query window with the scope set to that machine. Any queries include only records collected from that machine. |
77 | 75 |
|
78 | 76 | > [!NOTE]
|
79 |
| -> The **Queries** window may open when you open Log Analytics. This includes pre-created queries that you can use. For now, close this window since we're going to manually create a simple query. |
80 |
| -
|
81 |
| -:::image type="content" source="media/tutorial-monitor-vm/log-analytics.png" lightbox="media/tutorial-monitor-vm/log-analytics.png" alt-text="Log Analytics"::: |
| 77 | +> The **Queries** window might open when you open Log Analytics. This includes pre-created queries that you can use. For now, close this window because we're going to manually create a simple query. |
82 | 78 |
|
| 79 | +:::image type="content" source="media/tutorial-monitor-vm/log-analytics.png" lightbox="media/tutorial-monitor-vm/log-analytics.png" alt-text="Screenshot that shows Log Analytics."::: |
83 | 80 |
|
84 |
| -In the empty query window, type either `Event` or `Syslog` depending on whether your machine is running Windows or Linux and then click **Run**. The events collected within the **Time range** are displayed. |
| 81 | +In the empty query window, enter either `Event` or `Syslog` depending on whether your machine is running Windows or Linux. Then select **Run**. The events collected within the **Time range** are displayed. |
85 | 82 |
|
86 | 83 | > [!NOTE]
|
87 |
| -> If the query doesn't return any data, then you may need wait a few minutes until events are created on the virtual machine to be collected. You may also need to modify the data source in the data collection rule to include additional categories of events. |
| 84 | +> If the query doesn't return any data, you might need to wait a few minutes until events are created on the virtual machine to be collected. You might also need to modify the data source in the DCR to include other categories of events. |
88 | 85 |
|
89 |
| -:::image type="content" source="media/tutorial-monitor-vm/log-analytics-query.png" lightbox="media/tutorial-monitor-vm/log-analytics-query.png" alt-text="Log Analytics with query results"::: |
| 86 | +:::image type="content" source="media/tutorial-monitor-vm/log-analytics-query.png" lightbox="media/tutorial-monitor-vm/log-analytics-query.png" alt-text="Screenshot that shows Log Analytics with query results."::: |
90 | 87 |
|
91 | 88 | For a tutorial on using Log Analytics to analyze log data, see [Log Analytics tutorial](../logs/log-analytics-tutorial.md). For a tutorial on creating alert rules from log data, see [Tutorial: Create a log query alert for an Azure resource](../alerts/tutorial-log-alert.md).
|
92 | 89 |
|
93 | 90 | ## View guest metrics
|
94 |
| -You can view metrics for your host virtual machine with metrics explorer without a data collection rule just like [any other Azure resource](../essentials/tutorial-metrics.md). With the data collection rule though, you can use metrics explorer to view guest metrics in addition to host metrics. |
| 91 | +You can view metrics for your host virtual machine with metrics explorer without a DCR like [any other Azure resource](../essentials/tutorial-metrics.md). With the DCR, you can use metrics explorer to view guest metrics and host metrics. |
95 | 92 |
|
96 |
| -Select **Metrics** from your virtual machines's menu. Metrics explorer opens with the scope set to your virtual machine. Click **Metric Namespace**, and select **Virtual Machine Guest**. |
| 93 | +Select **Metrics** from your virtual machine's menu. Metrics explorer opens with the scope set to your virtual machine. Select **Metric Namespace** > **Virtual Machine Guest**. |
97 | 94 |
|
98 | 95 | > [!NOTE]
|
99 |
| -> If you don't see **Virtual Machine Guest**, you may just need to wait a few more minutes for the agent to be deployed and data to begin collecting. |
| 96 | +> If you don't see **Virtual Machine Guest**, you might need to wait a few minutes for the agent to deploy and data to begin collecting. |
100 | 97 |
|
101 |
| - |
102 |
| -:::image type="content" source="media/tutorial-monitor-vm/metrics-explorer.png" lightbox="media/tutorial-monitor-vm/metrics-explorer.png" alt-text="Metrics explorer"::: |
| 98 | +:::image type="content" source="media/tutorial-monitor-vm/metrics-explorer.png" lightbox="media/tutorial-monitor-vm/metrics-explorer.png" alt-text="Screenshot that shows metrics explorer."::: |
103 | 99 |
|
104 | 100 | The available guest metrics are displayed. Select a **Metric** to add to the chart.
|
105 | 101 |
|
106 |
| -:::image type="content" source="media/tutorial-monitor-vm/metrics-explorer-guest-metrics.png" lightbox="media/tutorial-monitor-vm/metrics-explorer-guest-metrics.png" alt-text="Metrics explorer with guest metrics"::: |
107 |
| - |
108 |
| -You can get a complete tutorial on viewing and analyzing metric data using metrics explorer in [Tutorial: Analyze metrics for an Azure resource](../essentials/tutorial-metrics.md) and on creating metrics alerts in [Tutorial: Create a metric alert for an Azure resource](../alerts/tutorial-metric-alert.md). |
109 |
| - |
| 102 | +:::image type="content" source="media/tutorial-monitor-vm/metrics-explorer-guest-metrics.png" lightbox="media/tutorial-monitor-vm/metrics-explorer-guest-metrics.png" alt-text="Screenshot that shows metrics explorer with guest metrics."::: |
110 | 103 |
|
| 104 | +For a tutorial on how to view and analyze metric data by using metrics explorer, see [Tutorial: Analyze metrics for an Azure resource](../essentials/tutorial-metrics.md). For a tutorial on how to create metrics alerts, see [Tutorial: Create a metric alert for an Azure resource](../alerts/tutorial-metric-alert.md). |
111 | 105 |
|
112 | 106 | ## Next steps
|
113 | 107 | [Recommended alerts](tutorial-monitor-vm-alert-recommended.md) and the [VM Availability metric](tutorial-monitor-vm-alert-availability.md) alert from the virtual machine host but don't have any visibility into the guest operating system and its workloads. Now that you're collecting guest metrics for the virtual machine, you can create metric alerts based on guest metrics such as logical disk space.
|
114 | 108 |
|
115 | 109 | > [!div class="nextstepaction"]
|
116 | 110 | > [Create a metric alert in Azure Monitor](../alerts/tutorial-metric-alert.md)
|
117 |
| -
|
118 |
| - |
0 commit comments