azure storage 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 storage metricset of the module azure.

This metricset allows users to retrieve all metrics from specified storage accounts.

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 of storage accounts we want to apply our metric configuration options on.
service_type
([]string) This configuration key can be used with any of the 2 options above, for example:
resources:
    - resource_id: ""
      service_type: ["blob", "table"]
    - resource_group: ""
      service_type: ["queue", "file"]

it will filter the metric values to be returned by specific metric namespaces. The supported metrics and namespaces can be found here https://docs.microsoft.com/en-us/azure/azure-monitor/platform/metrics-supported#microsoftstoragestorageaccounts. The service type values allowed are blob, table, queue, file based on the namespaces Microsoft.Storage/storageAccounts/blobServices,Microsoft.Storage/storageAccounts/tableServices,Microsoft.Storage/storageAccounts/fileServices,Microsoft.Storage/storageAccounts/queueServices. If no service_type is specified all values are applied.

Also, if the resources option is not specified, then all the storage accounts from the entire subscription will be selected. The primary aggregation value will be retrieved for all the metrics contained in the namespaces. The aggregation options are avg, sum, min, max, total, count.

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:

{
    "_index" : "metricbeat-8.0.0-2020.01.09-000001",
    "_type" : "_doc",
    "_id" : "XxYjjG8BQe78yNOEwING",
    "_score" : null,
    "_source" : {
        "@timestamp" : "2020-01-09T21:04:00.000Z",
        "event" : {
            "duration" : 122304420600,
            "dataset" : "azure.storage",
            "module" : "azure"
        },
        "metricset" : {
            "name" : "storage",
            "period" : 300000
        },
        "azure" : {
            "namespace" : "Microsoft.Storage/storageAccounts/blobServices",
            "dimensions" : {
                "apiname" : "DeleteBlob"
            },
            "storage" : {
                "successe2elatency" : {
                    "avg" : 9.1
                },
                "availability" : {
                    "avg" : 100
                },
                "transactions" : {
                    "total" : 10
                },
                "ingress" : {
                    "total" : 5330
                },
                "egress" : {
                    "total" : 1010
                },
                "successserverlatency" : {
                    "avg" : 9.1
                }
            },
            "resource" : {
                "name" : "obsdiaglinux",
                "type" : "Microsoft.Storage/storageAccounts",
                "group" : "obs-infrastructure"
            },
            "subscription_id" : "12345678-qwer-1234-5678-12345678"
        },
        "service" : {
            "type" : "azure"
        },
        "ecs" : {
            "version" : "1.2.0"
        },
        "host" : {
            "architecture" : "x86_64",
            "name" : "DESKTOP-RFOOE09",
            "os" : {
                "kernel" : "10.0.18362.535 (WinBuild.160101.0800)",
                "build" : "18362.535",
                "platform" : "windows",
                "version" : "10.0",
                "family" : "windows",
                "name" : "Windows 10 Pro"
            },
            "id" : "12345678-qwer-1234-5678-12345678",
            "hostname" : "DESKTOP-RFOOE09"
        },
        "agent" : {
            "hostname" : "DESKTOP-RFOOE09",
            "id" : "12345678-qwer-1234-5678-12345678",
            "version" : "8.0.0",
            "type" : "metricbeat",
            "ephemeral_id" : "12345678-qwer-1234-5678-12345678"
        },
        "cloud" : {
            "provider" : "azure",
            "region" : "westeurope"
        }
    },
    "sort" : [
        1578603840000
    ]
}