% This file is generated! See metricbeat/scripts/mage/docs_collector.go

AWS s3_daily_storage metricset [metricbeat-metricset-aws-s3_daily_storage]

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

AWS Permissions [_aws_permissions_11]

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

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

Dashboard [_dashboard_12]

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

Note: If only s3_daily_storage metricset is enabled or s3 request metrics are not enabled for the specific S3 bucket, some visualizations in this dashboard will be empty.

Configuration example [_configuration_example_11]

yaml

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

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

Fields [_fields]

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

Here is an example document generated by this metricset:

json

{
    "@timestamp": "2017-10-12T08:05:34.853Z",
    "aws": {
        "cloudwatch": {
            "namespace": "AWS/S3"
        },
        "dimensions": {
            "StorageType": "StandardStorage"
        },
        "s3": {
            "bucket": {
                "name": "filebeat-aws-elb-test"
            }
        },
        "s3_daily_storage": {
            "bucket": {
                "size": {
                    "bytes": 76353832
                }
            }
        }
    },
    "cloud": {
        "account": {
            "id": "428152502467",
            "name": "elastic-beats"
        },
        "provider": "aws",
        "region": "eu-central-1"
    },
    "event": {
        "dataset": "aws.s3_daily_storage",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "s3_daily_storage",
        "period": 10000
    },
    "service": {
        "type": "aws"
    }
}