IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Azure compute_vm metricset
editAzure compute_vm metricset
editThis is the compute_vm metricset of the module azure.
This metricset allows users to retrieve all metrics from specified virtual machines.
Metricset-specific configuration notes
edit-
refresh_list_interval -
Resources will be retrieved at each fetch call (
periodinterval), this means a number of Azure REST calls will be executed each time. This will be helpful if the azure users will be adding/removing resources that could match the configuration options so they will not added/removed to the list. To reduce on the number of API calls we are executing to retrieve the resources each time, users can configure this setting and make sure the list or resources will not be refreshed as often. This is also beneficial for performance and rate/ cost reasons (https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits). -
resources - This will contain all options for identifying resources and configuring the desired metrics
Config options to identify resources
edit-
resource_id - ([]string) The fully qualified ID’s of the resource, including the resource name and resource type. Has the format /subscriptions/{guid}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}. Should return a list of resources.
-
resource_group - ([]string) This option will select all virtual machines inside the resource group.
If none of the options are entered then all virtual machine inside the subscription are taken in account. For each metric the primary aggregation assigned will be retrieved. A default non configurable timegrain of 5 min is set so users are advised to configure an interval of 300s or a multiply of it.
To populate the VM Guest Metrics Overview dashboard, users will have to enable the Virtual Machine Guest namespace for the monitored resources. More on sending guest OS metrics to Azure Monitor here https://docs.microsoft.com/en-us/azure/azure-monitor/platform/collect-custom-metrics-guestos-resource-manager-vm.
Fields
editFor a description of each field in the metricset, see the exported fields section.
Here is an example document generated by this metricset:
{
"@timestamp":"2020-08-05T10:36:00.000Z",
"cloud":{
"provider":"azure",
"region":"westeurope",
"instance":{
"id":"/subscriptions/fd675b6f-b5e5-426e-ac45-d1f876d0ffa6/resourceGroups/obs-infrastructure/providers/Microsoft.Compute/virtualMachines/obstestmemleak",
"name":"obstestmemleak"
},
"machine":{
"type":"Standard_B2ms"
}
},
"event":{
"dataset":"azure.compute_vm",
"module":"azure",
"duration":5364973100
},
"metricset":{
"name":"compute_vm",
"period":300000
},
"azure":{
"timegrain":"PT5M",
"resource":{
"type":"Microsoft.Compute/virtualMachines",
"group":"obs-infrastructure",
"tags":{
"vmtest":"value1, value 2",
"vmtest1":"value3"
}
},
"subscription_id":"fd675b6f-b5e5-426e-ac45-d1f876d0ffa6",
"namespace":"Microsoft.Compute/virtualMachines",
"compute_vm":{
"outbound_flows":{
"avg":291.2
},
"outbound_flows_maximum_creation_rate":{
"avg":6
},
"inbound_flows_maximum_creation_rate":{
"avg":6
},
"os_per_disk_read_bytes_per_sec":{
"avg":341.35875
},
"per_disk_read_bytes_per_sec":{
"avg":0
},
"os_disk_queue_depth":{
"avg":0
},
"os_per_disk_qd":{
"avg":0
},
"os_disk_read_bytes_per_sec":{
"avg":341.35875
},
"network_in":{
"total":3933481.0
},
"network_out":{
"total":7169752.0
},
"os_disk_write_operations_per_sec":{
"avg":4.994285714285715
},
"percentage_cpu":{
"avg":8.780625
},
"cpu_credits_remaining":{
"avg":864
},
"network_out_total":{
"total":9249694.0
},
"disk_read_operations_per_sec":{
"avg":0.022857142857142857
},
"disk_write_bytes":{
"total":1.759878456E7
},
"os_disk_write_bytes_per_sec":{
"avg":73050.70375
},
"cpu_credits_consumed":{
"avg":0.175
},
"per_disk_qd":{
"avg":0
},
"disk_write_operations_per_sec":{
"avg":2.5221428571428572
},
"os_per_disk_write_operations_per_sec":{
"avg":4.994285714285715
},
"per_disk_write_operations_per_sec":{
"avg":0.049999999999999996
},
"inbound_flows":{
"avg":291.2
},
"os_disk_read_operations_per_sec":{
"avg":0.045714285714285714
},
"disk_read_bytes":{
"total":81926.52
},
"network_in_total":{
"total":4920267.0
},
"per_disk_read_operations_per_sec":{
"avg":0
},
"per_disk_write_bytes_per_sec":{
"avg":277.56
},
"os_per_disk_write_bytes_per_sec":{
"avg":73050.70375
},
"os_per_disk_read_operations_per_sec":{
"avg":0.045714285714285714
}
}
},
"service":{
"type":"azure"
}
}