ContextQMD
Back to Beats

AWS elb metricset [metricbeat-metricset-aws-elb]

docs/reference/metricbeat/metricbeat-metricset-aws-elb.md

9.4.05.1 KB
Original Source

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

AWS elb metricset [metricbeat-metricset-aws-elb]

Elastic Load Balancing publishes data points to Amazon CloudWatch for your load balancers and your back-end instances. This aws elb metricset collects these Cloudwatch metrics for monitoring purposes.

AWS Permissions [_aws_permissions_6]

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

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

Dashboard [_dashboard_7]

The aws elb metricset comes with a predefined dashboard for classic ELB. For example:

Configuration example [_configuration_example_6]

yaml
- module: aws
  period: 300s
  metricsets:
    - elb
  access_key_id: '${AWS_ACCESS_KEY_ID:""}'
  secret_access_key: '${AWS_SECRET_ACCESS_KEY:""}'
  session_token: '${AWS_SESSION_TOKEN:""}'
  # This module uses the aws cloudwatch metricset, all
  # the options for this metricset are also available here.

Metrics [_metrics_4]

elb metricset collects Cloudwatch metrics from classic ELB, application ELB and network ELB.

Metrics for Classic ELB [_metrics_for_classic_elb]

Metric NameStatistic Method
BackendConnectionErrorsSum
HealthyHostCountMaximum
HTTPCode_Backend_2XXSum
HTTPCode_Backend_3XXSum
HTTPCode_Backend_4XXSum
HTTPCode_Backend_5XXSum
HTTPCode_ELB_4XXSum
HTTPCode_ELB_5XXSum
LatencyAverage
RequestCountSum
SpilloverCountSum
SurgeQueueLengthMaximum
UnHealthyHostCountMaximum
EstimatedALBActiveConnectionCountAverage
EstimatedALBConsumedLCUsAverage
EstimatedALBNewConnectionCountAverage
EstimatedProcessedBytesAverage

Metrics for Application ELB [_metrics_for_application_elb]

Metric NameStatistic Method
ActiveConnectionCountSum
ClientTLSNegotiationErrorCountSum
ConsumedLCUsAverage
HTTP_Fixed_Response_CountSum
HTTP_Redirect_CountSum
HTTP_Redirect_Url_Limit_Exceeded_CountSum
HTTPCode_ELB_3XX_CountSum
HTTPCode_ELB_4XX_CountSum
HTTPCode_ELB_5XX_CountSum
HTTPCode_ELB_500_CountSum
HTTPCode_ELB_502_CountSum
HTTPCode_ELB_503_CountSum
HTTPCode_ELB_504_CountSum
IPv6ProcessedBytesSum
IPv6RequestCountSum
NewConnectionCountSum
ProcessedBytesSum
RejectedConnectionCountSum
RequestCountSum
RuleEvaluationsSum

Metrics for Network ELB [_metrics_for_network_elb]

Metric NameStatistic Method
ActiveFlowCountAverage
ActiveFlowCount_TLSAverage
ActiveFlowCount_TCPAverage
ActiveFlowCount_UDPAverage
ConsumedLCUsAverage
ConsumedLCUs_TCPAverage
ConsumedLCUs_TLSAverage
ConsumedLCUs_UDPAverage
ClientTLSNegotiationErrorCountSum
NewFlowCountSum
NewFlowCount_TLSSum
NewFlowCount_TCPSum
NewFlowCount_UDPSum
ProcessedBytesSum
ProcessedBytes_TCPSum
ProcessedBytes_TLSSum
ProcessedBytes_UDPSum
TargetTLSNegotiationErrorCountSum
TCP_Client_Reset_CountSum
TCP_ELB_Reset_CountSum
TCP_Target_Reset_CountSum
UnHealthyHostCountMaximum
HealthyHostCountMaximum

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/ELB"
        },
        "dimensions": {
            "Namespace": "AWS"
        },
        "elb": {
            "metrics": {
                "HealthyHostCount": {
                    "max": 2
                },
                "Latency": {
                    "avg": 0.000005960464477539062
                },
                "RequestCount": {
                    "sum": 1
                },
                "SurgeQueueLength": {
                    "max": 1
                },
                "UnHealthyHostCount": {
                    "max": 0
                }
            }
        }
    },
    "cloud": {
        "account": {
            "id": "428152502467",
            "name": "elastic-beats"
        },
        "provider": "aws",
        "region": "us-east-1"
    },
    "event": {
        "dataset": "aws.elb",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "elb",
        "period": 10000
    },
    "service": {
        "type": "aws"
    }
}