aws s3_request metricset

edit

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 Permissions

edit

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

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

Dashboard

edit

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

metricbeat aws s3 overview

Configuration example

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

Fields

edit

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": {
            "bucket": {
                "name": "test-s3-ks-2"
            }
        },
        "s3_request": {
            "downloaded": {
                "bytes": 534
            },
            "errors": {
                "4xx": 0,
                "5xx": 0
            },
            "latency": {
                "first_byte.ms": 214,
                "total_request.ms": 533
            },
            "requests": {
                "list": 2,
                "put": 10,
                "total": 12
            },
            "uploaded": {
                "bytes": 13572
            }
        }
    },
    "cloud": {
        "account": {
            "id": "627959692251",
            "name": "elastic-test"
        },
        "provider": "aws",
        "region": "ap-southeast-1"
    },
    "event": {
        "dataset": "aws.s3_request",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "s3_request",
        "period": 10000
    },
    "service": {
        "type": "aws"
    }
}