aws s3_request metricsetedit

Warning

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.

The s3_request metricset of aws module allows you to monitor your AWS S3 buckets. s3_request metricset fetches Cloudwatch daily storage metrics for each S3 bucket from S3 CloudWatch Request Metrics for Buckets.

AWS Permissionsedit

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

ec2:DescribeRegions
cloudwatch:GetMetricData
cloudwatch:ListMetrics

Dashboardedit

The aws s3_request metricset and s3_daily_storage metricset shares one predefined dashboard. For example:

metricbeat aws s3 overview

Configuration exampleedit

- module: aws
  period: 86400s
  metricsets:
    - s3_request
  access_key_id: '<access_key_id>'
  secret_access_key: '<secret_access_key>'
  session_token: '<session_token>'

Fieldsedit

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": {
        "s3_request": {
            "bucket": {
                "name": "test-s3-ks-2"
            },
            "downloaded": {
                "bytes": 123653
            },
            "errors": {
                "4xx": 0,
                "5xx": 0
            },
            "latency": {
                "first_byte.ms": 7975,
                "total_request.ms": 9005
            },
            "requests": {
                "delete": 2,
                "get": 80,
                "head": 3,
                "list": 37,
                "put": 34,
                "total": 156
            },
            "uploaded": {
                "bytes": 2644
            }
        }
    },
    "cloud": {
        "provider": "aws",
        "region": "ap-southeast-1"
    },
    "event": {
        "dataset": "aws.s3_request",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "s3_request"
    },
    "service": {
        "type": "aws"
    }
}