aws rds metricset

The rds metricset of aws module allows you to monitor your AWS RDS service. rds metricset fetches a set of values from Amazon RDS Metrics. Amazon RDS sends metrics and dimensions to Amazon CloudWatch every minute.

AWS Permissions

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

cloudwatch:GetMetricData
ec2:DescribeRegions
rds:DescribeDBInstances
sts:GetCallerIdentity
iam:ListAccountAliases

Dashboard

The aws rds metricset comes with a predefined dashboard.

metricbeat aws rds overview

Configuration example

- module: aws
  period: 60s
  metricsets:
    - rds
  access_key_id: '<access_key_id>'
  secret_access_key: '<secret_access_key>'
  session_token: '<session_token>'

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": {
        "rds": {
            "cpu": {
                "total": {
                    "pct": 0.999999999997575
                }
            },
            "database_connections": 0,
            "db_instance": {
                "arn": "arn:aws:rds:ap-southeast-1:627959692251:db:database-1",
                "class": "db.t2.micro",
                "identifier": "database-1",
                "status": "available"
            },
            "disk_queue_depth": 0.00006666888896296543,
            "disk_usage": {
                "bin_log.bytes": 2752
            },
            "free_storage.bytes": 20402475008,
            "freeable_memory.bytes": 441335808,
            "latency": {
                "read": 0,
                "write": 0.0002909090909090909
            },
            "read_io.ops_per_sec": 0,
            "swap_usage.bytes": 1167360,
            "throughput": {
                "network_receive": 570.7618714269047,
                "network_transmit": 3228.0614030701536,
                "read": 0,
                "write": 3754.7918263942133
            },
            "transactions": {},
            "write_io.ops_per_sec": 0.40002000100005003
        }
    },
    "cloud": {
        "account": {
            "id": "627959692251",
            "name": "elastic-test"
        },
        "availability_zone": "ap-southeast-1a",
        "provider": "aws",
        "region": "ap-southeast-1"
    },
    "event": {
        "dataset": "aws.rds",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "rds",
        "period": 10000
    },
    "service": {
        "type": "aws"
    }
}