aws cloudwatch 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 cloudwatch metricset of aws module allows you to monitor various services on AWS. cloudwatch metricset fetches metrics from given namespace periodically by calling GetMetricData api.

AWS Permissionsedit

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

ec2:DescribeRegions
cloudwatch:GetMetricData
cloudwatch:ListMetrics
tag:getResources

Module-specific configuration notesedit

  • namespace: The namespace to filter against. For example, AWS/EC2, AWS/S3.
  • metricname: The name of the metric to filter against. For example, CPUUtilization for EC2 instance.
  • dimensions: The dimensions to filter against. For example, InstanceId=i-123.
  • tags.resource_type_filter: The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

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": {
        "cloudwatch": {
            "dimensions": {
                "DBInstanceIdentifier": "test1"
            },
            "metrics": {
                "ActiveTransactions": 0,
                "AuroraBinlogReplicaLag": 0,
                "AuroraReplicaLagMaximum": 18.62599983215332,
                "AuroraReplicaLagMinimum": 18.62599983215332,
                "BinLogDiskUsage": 0,
                "BlockedTransactions": 0,
                "BufferCacheHitRatio": 100,
                "CPUUtilization": 3.2,
                "CommitLatency": 7.324593333333333,
                "CommitThroughput": 0.49995937707131555,
                "DDLLatency": 0,
                "DDLThroughput": 0,
                "DMLLatency": 0.15980666666666668,
                "DMLThroughput": 0.49995937707131555,
                "DatabaseConnections": 0,
                "Deadlocks": 0,
                "DeleteLatency": 0,
                "DeleteThroughput": 0,
                "EngineUptime": 5698620,
                "FreeLocalStorage": 30215283507.2,
                "FreeableMemory": 4574632345.6,
                "InsertLatency": 0.15980666666666668,
                "InsertThroughput": 0.49995937707131555,
                "LoginFailures": 0,
                "NetworkReceiveThroughput": 0.6999953344221976,
                "NetworkThroughput": 1.3999906688443953,
                "NetworkTransmitThroughput": 0.6999953344221976,
                "Queries": 8.796891844051007,
                "ResultSetCacheHitRatio": 0,
                "SelectLatency": 0.17348499249549354,
                "SelectThroughput": 3.0864647634387916,
                "UpdateLatency": 0,
                "UpdateThroughput": 0
            },
            "namespace": "AWS/RDS"
        },
        "tags": {
            "workload-type": "other"
        }
    },
    "cloud": {
        "provider": "aws",
        "region": "us-east-2"
    },
    "event": {
        "dataset": "aws.cloudwatch",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "cloudwatch"
    },
    "service": {
        "name": "cloudwatch",
        "type": "cloudwatch"
    }
}