azure compute_vm_scaleset metricset

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

This is the compute_vm_scaleset metricset of the module azure.

This metricset allows users to retrieve all metrics from specified virtual machine scalesets.

Metricset-specific configuration notes

refresh_list_interval
Resources will be retrieved at each fetch call (period interval), 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

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 should return a list virtual machine scalesets we want to apply our metric configuration options on.

If none of the options are entered then we will select all virtual machine scalesets from the entire subscription For each metric the primary aggregation assigned will be retrieved. If vmname dimensions apply to these metrics then we will separate values per vm. 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.

Fields

For a description of each field in the metricset, see the exported fields section.

Here is an example document generated by this metricset:

{
    "@timestamp" : "2019-09-20T11:13:00.000Z",
    "azure" : {
        "resource" : {
            "name" : "winvmss",
            "type" : "Microsoft.Compute/virtualMachineScaleSets",
            "group" : "resource-group"
        },
        "subscription_id" : "123456-qwer-1234-5678-12345678",
        "namespace" : "Microsoft.Compute/virtualMachineScaleSets",
        "dimensions" : {
            "vmname" : "winvmss_3"
        },
        "compute_vm_scaleset" : {
            "outbound_flows" : {
                "avg" : 10.6
            },
            "disk_write_bytes" : {
                "total" : 2.838777151E7
            },
            "disk_read_operations_per_sec" : {
                "avg" : 3.53
            },
            "outbound_flows_maximum_creation_rate" : {
                "avg" : 0.2
            },
            "data_disk_read_bytes_per_sec" : {
                "avg" : 5051.38125
            },
            "os_disk_read_bytes_per_sec" : {
                "avg" : 122285.5025
            },
            "data_disk_write_bytes_per_sec" : {
                "avg" : 0
            },
            "data_disk_read_operations_per_sec" : {
                "avg" : 0.495
            },
            "disk_read_bytes" : {
                "total" : 4.081481671E7
            },
            "disk_write_operations_per_sec" : {
                "avg" : 3.132
            },
            "network_out_total" : {
                "total" : 1509069.0
            },
            "inbound_flows" : {
                "avg" : 10.6
            },
            "os_disk_read_operations_per_sec" : {
                "avg" : 1.805
            },
            "data_disk_queue_depth" : {
                "avg" : 0
            },
            "inbound_flows_maximum_creation_rate" : {
                "avg" : 0.2
            },
            "data_disk_write_operations_per_sec" : {
                "avg" : 0
            },
            "os_disk_write_bytes_per_sec" : {
                "avg" : 95619.85625
            },
            "percentage_cpu" : {
                "avg" : 1.592
            },
            "os_disk_write_operations_per_sec" : {
                "avg" : 3.045
            },
            "network_in_total" : {
                "total" : 794397
            },
            "os_disk_queue_depth" : {
                "avg" : 0.005
            }
        }
    },
    "service" : {
        "type" : "azure"
    },
    "ecs" : {
        "version" : "1.1.0"
    },
    "host" : {
        "architecture" : "x86_64",
        "os" : {
            "build" : "17134.1006",
            "platform" : "windows",
            "version" : "10.0",
            "family" : "windows",
            "name" : "Windows 10 Pro",
            "kernel" : "10.0.17134.1006 (WinBuild.160101.0800)"
        },
        "id" : "123456-qwer-1234-5678-12345678",
        "hostname" : "DESKTOP-RFOOE09",
        "name" : "DESKTOP-RFOOE09"
    },
    "agent" : {
        "version" : "8.0.0",
        "type" : "metricbeat",
        "ephemeral_id" : "123456-qwer-1234-5678-12345678",
        "hostname" : "DESKTOP-RFOOE09",
        "id" : "123456-qwer-1234-5678-12345678"
    },
    "cloud" : {
        "provider" : "azure",
        "region" : "westeurope"
    },
    "event" : {
        "dataset" : "azure.compute_vm_scaleset",
        "module" : "azure",
        "duration" : 69629063400
    },
    "metricset" : {
        "name" : "compute_vm_scaleset",
        "period" : 300000
    }
}