aws ebs 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.

Amazon Elastic Block Store (Amazon EBS) sends data points to CloudWatch for several metrics. Most EBS volumes automatically send five-minute metrics to CloudWatch only when the volume is attached to an instance. This aws ebs metricset collects these Cloudwatch metrics for monitoring purposes.

AWS Permissions

Some specific AWS permissions are required for IAM user to collect AWS EBS metrics.

ec2:DescribeRegions
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:getResources
sts:GetCallerIdentity
iam:ListAccountAliases

Dashboard

The aws ebs metricset comes with a predefined dashboard. For example:

metricbeat aws ebs overview

Configuration example

- module: aws
  period: 300s
  metricsets:
    - ebs
  # This module uses the aws cloudwatch metricset, all
  # the options for this metricset are also available here.

Metrics

Please see more details for each metric in ebs-cloudwatch-metric.

Metric Name

Statistic Method

VolumeReadBytes

Average

VolumeWriteBytes

Average

VolumeReadOps

Average

VolumeWriteOps

Average

VolumeQueueLength

Average

VolumeThroughputPercentage

Average

VolumeConsumedReadWriteOps

Average

BurstBalance

Average

VolumeTotalReadTime

Sum

VolumeTotalWriteTime

Sum

VolumeIdleTime

Sum

This is a default metricset. If the host module is unconfigured, this metricset is enabled by default.

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": "2017-10-12T08:05:34.853Z",
    "aws": {
        "cloudwatch": {
            "dimensions": {
                "VolumeId": "vol-6ae467c0"
            },
            "namespace": "AWS/EBS"
        },
        "metrics": {
            "BurstBalance": {
                "avg": 100
            },
            "VolumeIdleTime": {
                "sum": 299.97
            },
            "VolumeQueueLength": {
                "avg": 0.0001
            },
            "VolumeReadOps": {
                "avg": 0
            },
            "VolumeTotalWriteTime": {
                "sum": 0.03
            },
            "VolumeWriteBytes": {
                "avg": 10330.79802955665
            },
            "VolumeWriteOps": {
                "avg": 203
            }
        }
    },
    "cloud": {
        "account": {
            "id": "627959692251",
            "name": "elastic-test"
        },
        "provider": "aws",
        "region": "us-east-1"
    },
    "event": {
        "dataset": "aws.ebs",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "ebs",
        "period": 10000
    },
    "service": {
        "type": "aws"
    }
}