Collect metrics for Amazon Elastic Container Service with Elastic Agent
What is an Elastic integration?
This integration is powered by Elastic Agent. Elastic Agent is a single, unified way to add monitoring for logs, metrics, and other types of data to a host. It can also protect hosts from security threats, query data from operating systems, forward data from remote services or hardware, and more. Refer to our documentation for a detailed comparison between Beats and Elastic Agent.
Prefer to use Beats for this use case? See Filebeat modules for logs or Metricbeat modules for metrics.
See the integrations quick start guides to get started:
The Amazon ECS integration allows you to monitor Amazon Elastic Container Service (Amazon ECS)—a managed container orchestration service.
Use the Amazon ECS integration to collect metrics related to your ECS instances. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference the metrics when troubleshooting an issue.
For example, you could use this data to track Amazon ECS CPU and memory utilization. Then you can alert when utilization for an instance crosses a predefined threshold.
IMPORTANT: Extra AWS charges on AWS API requests will be generated by this integration. Please refer to the AWS integration for more details.
The Amazon ECS integration collects one type of data: metrics.
Metrics give you insight into the state of Amazon ECS. The metrics collected by the Amazon ECS integration include CPU utilization, CPU reservation, memory reservation, memory utilization, and more. See more details in the Metrics reference
You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.
Before using any AWS integration you will need:
For more details about these requirements, see the AWS integration documentation.
Use this integration if you only need to collect data from the Amazon ECS service.
If you want to collect data from two or more AWS services, consider using the AWS integration. When you configure the AWS integration, you can collect data from as many AWS services as you'd like.
For step-by-step instructions on how to set up an integration, see the Getting started guide.
An example event for ecs looks as following:
{
"agent": {
"name": "4b4f1fd6f3ff",
"id": "8c424f1d-e9b1-4aab-8ce5-77dceb4becfb",
"type": "metricbeat",
"ephemeral_id": "0c23896b-0bfe-469f-bf76-7203a2d52568",
"version": "8.1.0"
},
"elastic_agent": {
"id": "8c424f1d-e9b1-4aab-8ce5-77dceb4becfb",
"version": "8.1.0",
"snapshot": false
},
"cloud": {
"provider": "aws",
"region": "eu-west-1",
"account": {
"name": "elastic-observability",
"id": "627286350134"
}
},
"@timestamp": "2022-07-26T08:59:00.000Z",
"ecs": {
"version": "8.0.0"
},
"service": {
"type": "aws"
},
"data_stream": {
"namespace": "default",
"type": "metrics",
"dataset": "aws.ecs_metrics"
},
"host": {
"hostname": "4b4f1fd6f3ff",
"os": {
"kernel": "5.10.104-linuxkit",
"codename": "focal",
"name": "Ubuntu",
"family": "debian",
"type": "linux",
"version": "20.04.3 LTS (Focal Fossa)",
"platform": "ubuntu"
},
"containerized": false,
"ip": [
"172.19.0.4"
],
"name": "4b4f1fd6f3ff",
"mac": [
"02:42:ac:13:00:04"
],
"architecture": "aarch64"
},
"metricset": {
"period": 300000,
"name": "cloudwatch"
},
"aws": {
"ecs": {
"metrics": {
"CPUUtilization": {
"avg": 100.040084913373
},
"MemoryUtilization": {
"avg": 9.195963541666666
}
}
},
"cloudwatch": {
"namespace": "AWS/ECS"
},
"dimensions": {
"ServiceName": "integration-service-1",
"ClusterName": "integration-cluster-1"
}
},
"event": {
"duration": 1862196584,
"agent_id_status": "verified",
"ingested": "2022-07-26T09:04:12Z",
"module": "aws",
"dataset": "aws.ecs_metrics"
}
}Exported fields
| Field | Description | Type |
|---|---|---|
@timestamp | Event timestamp. | date |
aws.cloudwatch.namespace | The namespace specified when query cloudwatch api. | keyword |
aws.dimensions.* | Metric dimensions. | object |
aws.dimensions.ClusterName | This dimension filters the data that you request for all resources in a specified cluster. All Amazon ECS metrics are filtered by ClusterName. | keyword |
aws.dimensions.ServiceName | This dimension filters the data that you request for all resources in a specified service within a specified cluster. | keyword |
aws.ecs.metrics.CPUReservation.avg | The percentage of CPU units that are reserved by running tasks in the cluster. | double |
aws.ecs.metrics.CPUUtilization.avg | The percentage of CPU units that are used in the cluster or service. | double |
aws.ecs.metrics.GPUReservation.avg | The percentage of total available GPUs that are reserved by running tasks in the cluster. | double |
aws.ecs.metrics.MemoryReservation.avg | The percentage of memory that is reserved by running tasks in the cluster. | double |
aws.ecs.metrics.MemoryUtilization.avg | The percentage of memory that is used in the cluster or service. | double |
aws.s3.bucket.name | Name of a S3 bucket. | keyword |
aws.tags.* | Tag key value pairs from aws resources. | object |
cloud | Fields related to the cloud or infrastructure the events are coming from. | group |
cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword |
cloud.account.name | The cloud account name or alias used to identify different entities in a multi-tenant environment. Examples: AWS account name, Google Cloud ORG display name. | keyword |
cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword |
cloud.image.id | Image ID for the cloud instance. | keyword |
cloud.instance.id | Instance ID of the host machine. | keyword |
cloud.instance.name | Instance name of the host machine. | keyword |
cloud.machine.type | Machine type of the host machine. | keyword |
cloud.project.id | The cloud project identifier. Examples: Google Cloud Project id, Azure Project id. | keyword |
cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword |
cloud.region | Region in which this host, resource, or service is located. | keyword |
container.id | Unique container id. | keyword |
container.image.name | Name of the image the container was built on. | keyword |
container.labels | Image labels. | object |
container.name | Container name. | keyword |
data_stream.dataset | Data stream dataset. | constant_keyword |
data_stream.namespace | Data stream namespace. | constant_keyword |
data_stream.type | Data stream type. | constant_keyword |
ecs.version | ECS version this event conforms to. ecs.version is a required field and must exist in all events. When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events. | keyword |
error | These fields can represent errors of any kind. Use them for errors that happen while fetching events or in cases where the event itself contains an error. | group |
error.message | Error message. | match_only_text |
event.dataset | Event dataset | constant_keyword |
event.module | Event module | constant_keyword |
host.architecture | Operating system architecture. | keyword |
host.containerized | If the host is a container. | boolean |
host.domain | Name of the domain of which the host is a member. For example, on Windows this could be the host's Active Directory domain or NetBIOS domain name. For Linux this could be the domain of the host's LDAP provider. | keyword |
host.hostname | Hostname of the host. It normally contains what the hostname command returns on the host machine. | keyword |
host.id | Unique host id. As hostname is not always unique, use values that are meaningful in your environment. Example: The current usage of beat.name. | keyword |
host.ip | Host ip addresses. | ip |
host.mac | Host MAC addresses. The notation format from RFC 7042 is suggested: Each octet (that is, 8-bit byte) is represented by two [uppercase] hexadecimal digits giving the value of the octet as an unsigned integer. Successive octets are separated by a hyphen. | keyword |
host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use. | keyword |
host.os.build | OS build information. | keyword |
host.os.codename | OS codename, if any. | keyword |
host.os.family | OS family (such as redhat, debian, freebsd, windows). | keyword |
host.os.kernel | Operating system kernel version as a raw string. | keyword |
host.os.name | Operating system name, without the version. | keyword |
host.os.name.text | Multi-field of host.os.name. | match_only_text |
host.os.platform | Operating system platform (such centos, ubuntu, windows). | keyword |
host.os.version | Operating system version as a raw string. | keyword |
host.type | Type of host. For Cloud providers this can be the machine type like t2.medium. If vm, this could be the container, for example, or other information meaningful in your environment. | keyword |
service.type | The type of the service data is collected from. The type can be used to group and correlate logs and metrics from one service type. Example: If logs or metrics are collected from Elasticsearch, service.type would be elasticsearch. | keyword |
| Version | Details |
|---|---|
1.33.2 | Bug fix View pull request Add missing permissions in the AWS Billing integration documentation. |
1.33.1 | Bug fix View pull request Add missing permissions in the AWS CloudWatch Logs integration documentation. |
1.33.0 | Bug fix View pull request Add latency configuration option on the CloudWatch Logs integration. |
1.32.2 | Bug fix View pull request Fix a minor documentation format issue. |
1.32.1 | Enhancement View pull request Added categories and/or subcategories. |
1.32.0 | Enhancement View pull request Migrate AWS EBS dashboard visualizations to lenses. |
1.31.0 | Enhancement View pull request Add a data stream for Amazon GuardDuty. |
1.30.0 | Enhancement View pull request Add dashboards data streams filters. |
1.29.1 | Bug fix View pull request Drop comments from CloudFront loglines |
1.29.0 | Enhancement View pull request Add data_granularity parameter and rename period title to Collection Period. |
1.28.3 | Bug fix View pull request Remove quotes from VPC flow log message field and move dot_expander processor to top |
1.28.2 | Bug fix View pull request Add dot_expander processor to expand all fields with dot into object fields Bug fix View pull request Support VPC flow log with message field |
1.28.1 | Enhancement View pull request Adjust kinesis integration to kinesis data stream |
1.28.0 | Enhancement View pull request Enhance S3 integration dashboard |
1.27.3 | Bug fix View pull request Support multiple forwarded IPs in cloudfront integration |
1.27.2 | Enhancement View pull request Update the pagination termination condition. |
1.27.1 | Enhancement View pull request Added a Summary Dashboard for AWS Security Hub. |
1.27.0 | Enhancement View pull request Add Inspector data stream. |
1.25.3 | Bug fix View pull request Remove duplicate fields from agent.yml and use ecs.yml for ECS fields |
1.25.2 | Bug fix View pull request Update ec2 fields.yml doc |
1.25.1 | Bug fix View pull request Remove duplicate 'content_type' config that causes errors while configurating the integration. |
1.25.0 | Enhancement View pull request Force content type where json content is expected |
1.24.6 | Bug fix View pull request Enhance Kinesis integration dashboard |
1.24.5 | Bug fix View pull request Allow adding multiple processors in cloudfront logs. |
1.24.4 | Bug fix View pull request Do not rely on dynamodb lightweight module metricset. |
1.24.3 | Bug fix View pull request Fix adding processors in cloudfront logs. |
1.24.2 | Bug fix View pull request Fix billing datastream agent template. |
1.24.1 | Bug fix View pull request Fix aws.cloudtrail.request_id parsing |
1.24.0 | Bug fix View pull request Expose Default Region setting to UI |
1.23.4 | Bug fix View pull request Set default endpoint to empty string |
1.23.3 | Bug fix View pull request Fix Billing Dashboard |
1.23.2 | Bug fix View pull request Fix EC2 dashboard |
1.23.1 | Enhancement View pull request Update all AWS documentation. |
1.23.0 | Bug fix View pull request Fix file.path field in cloudtrail data stream to use json.digestS3Object |
1.22.0 | Enhancement View pull request Update cloud.region parsing |
1.21.0 | Enhancement View pull request Add Security Hub Findings and Insights data streams |
1.20.0 | Enhancement View pull request Improve dashboards by removing individual visualizations from library |
1.19.5 | Enhancement View pull request Move ebs metrics config from beats to integrations |
1.19.4 | Bug fix View pull request Fix proxy URL documentation rendering. |
1.19.3 | Bug fix View pull request Update sample_event.json in kinesis data stream |
1.19.2 | Enhancement View pull request Move NATGateway metrics config from beats to integrations |
1.19.1 | Enhancement View pull request Move Transit Gateway metrics config from beats to integrations |
1.19.0 | Enhancement View pull request Add Kinesis metrics datastream |
1.18.2 | Enhancement View pull request Move s3_request metrics config from beats to integrations Enhancement View pull request Move s3_daily_storage metrics config from beats to integrations Enhancement View pull request Move SQS metrics config from beats to integrations Enhancement View pull request Move SNS metrics config from beats to integrations Enhancement View pull request Move lambda metrics config from beats to integrations |
1.18.1 | Enhancement View pull request Release AWS billing integration as GA |
1.18.0 | Enhancement View pull request Add ECS metricset Bug fix View pull request Fix incorrect fields on multiple visualizations |
1.17.5 | Enhancement View pull request Release Amazon Redshift integration as GA |
1.17.4 | Bug fix View pull request Fix data_stream.dataset indentation on cloudwatch_logs integration |
1.17.3 | Bug fix View pull request Add missing endpoint config to metrics datasets. Enhancement View pull request Move usage metrics config from beats to integrations Enhancement View pull request Move dynamodb metrics config from beats to integrations |
1.17.2 | Bug fix View pull request Improve support for event.original field from upstream forwarders. |
1.17.1 | Bug fix View pull request Fix misspelling of Log Stream Prefix variable in manifest for aws-cloudwatch input |
1.17.0 | Enhancement View pull request Added Redshift integration |
1.16.6 | Enhancement View pull request Update documentation with additional context for new users. |
1.16.5 | Enhancement View pull request Move ELB metrics config from beats to integrations |
1.16.4 | Bug fix View pull request Fix ELB dataset to parse URLs with spaces Enhancement View pull request Upgrade ECS to 8.2.0 |
1.16.3 | Enhancement View pull request Move RDS metrics config from beats to integrations |
1.16.2 | Enhancement View pull request Move EC2 metrics config from beats to integrations |
1.16.1 | Bug fix View pull request Fix invalid values for ECS fields in vpcflow |
1.16.0 | Enhancement View pull request Move VPN configuration file into integrations and add tag collection |
1.15.0 | Enhancement View pull request Deprecate s3 input in cloudwatch integration Enhancement View pull request Improve description for cloudwatch integration |
1.14.8 | Bug fix View pull request Fix http.response.status_code to accept 000 |
1.14.7 | Bug fix View pull request Fix aws.dimensions.* for rds data stream Bug fix View pull request Fix aws.dimensions.* for sns data stream Bug fix View pull request Add aws.dimensions.* for dynamodb data stream |
1.14.6 | Enhancement View pull request Improve s3 integration tile title and description |
1.14.5 | Bug fix View pull request Fix duplicate titles for integrations |
1.14.4 | Bug fix View pull request Fix cloudfront integration grok pattern |
1.14.3 | Enhancement View pull request Add new pattern to VPC Flow logs including all 29 v5 fields |
1.14.2 | Bug fix View pull request Fix billing dashboard. |
1.14.1 | Enhancement View pull request Add documentation for multi-fields |
1.14.0 | Enhancement View pull request Add configuration for max_number_of_messages to the aws.firewall_logs S3 input. |
1.13.1 | Bug fix View pull request Fix metricbeat- reference in dashboard |
1.13.0 | Enhancement View pull request Compress dashboard screenshots. |
1.12.1 | Bug fix View pull request Fix field mapping conflicts in the elb_logs data stream relating to ECS fields ( trace.id, source.port, and a few others). |
1.12.0 | Enhancement View pull request Add CloudFront Logs Datastream |
1.11.4 | Bug fix View pull request Add Ingest Pipeline script to map IANA Protocol Numbers |
1.11.3 | Bug fix View pull request Changing missing ecs versions to 8.0.0 |
1.11.2 | Bug fix View pull request Add data_stream.dataset option for custom aws-cloudwatch log input |
1.11.1 | Bug fix View pull request Update permission list |
1.11.0 | Enhancement View pull request Update to ECS 8.0 |
1.10.2 | Enhancement View pull request Change cloudwatch metrics and logs default to false |
1.10.1 | Enhancement View pull request Add description of supported vpcflow formats |
1.10.0 | Enhancement View pull request Add cloudwatch input into AWS package for log collection |
1.9.0 | Enhancement View pull request Add Route 53 Resolver Logs Datastream |
1.8.0 | Enhancement View pull request Add Route 53 Public Zone Logs Datastream |
1.7.1 | Bug fix View pull request Regenerate test files using the new GeoIP database |
1.7.0 | Enhancement View pull request Add integration for AWS Network Firewall |
1.6.2 | Bug fix View pull request Change test public IPs to the supported subset |
1.6.1 | Enhancement View pull request Fix the value of event.created in CloudTrail data stream. |
1.6.0 | Enhancement View pull request Add max_number_of_messages config option to AWS S3 input config. |
1.5.1 | Enhancement View pull request Add missing sample events |
1.5.0 | Enhancement View pull request Support Kibana 8.0 |
1.4.1 | Enhancement View pull request Add Overview dashboard for AWS S3 Storage Lens |
1.4.0 | Enhancement View pull request Add integration for AWS S3 Storage Lens |
1.3.2 | Enhancement View pull request Uniform with guidelines |
1.3.1 | Enhancement View pull request Add config parameter descriptions |
1.3.0 | Enhancement View pull request Add WAF datastream |
1.2.2 | Bug fix View pull request Prevent pipeline script error |
1.2.1 | Bug fix View pull request Fix logic that checks for the 'forwarded' tag |
1.2.0 | Enhancement View pull request Update to ECS 1.12.0 |
1.1.0 | Enhancement View pull request vpcflow sync with filebeat fileset |
1.0.0 | Enhancement View pull request Release AWS as GA |
0.10.7 | Enhancement View pull request Add proxy config |
0.10.6 | Bug fix View pull request Fix aws.billing.EstimatedCharges field name |
0.10.5 | Bug fix View pull request Add event.created field |
0.10.4 | Enhancement View pull request Improve RDS dashboard |
0.10.3 | Enhancement View pull request Convert to generated ECS fields |
0.10.2 | Enhancement View pull request update to ECS 1.11.0 |
0.10.1 | Enhancement View pull request Escape special characters in docs |
0.10.0 | Enhancement View pull request Update integration description |
0.9.3 | Bug fix View pull request Fix categories for each policy template |
0.9.2 | Enhancement View pull request Add linked account information into billing metricset |
0.9.1 | Bug fix View pull request Fix aws.s3access pipeline when remote IP is a - |
0.9.0 | Enhancement View pull request Change default credential options to access keys |
0.8.0 | Enhancement View pull request Set "event.module" and "event.dataset" |
0.7.0 | Enhancement View pull request Introduce granularity using input_groups |
0.6.4 | Enhancement View pull request Add support for Splunk authorization tokens |
0.6.3 | Bug fix View pull request Fix bug in Third Party ingest pipeline |
0.6.2 | Bug fix View pull request Removed incorrect http.request.referrer field from elb logs |
0.6.1 | Enhancement View pull request Add support for CloudTrail Digest & Insight logs |
0.6.0 | Enhancement View pull request Update ECS version, add event.original and preparing for package GA |
0.5.6 | Bug fix View pull request Fix stack compatability |
0.5.5 | Enhancement View pull request Allow role_arn work with access keys for AWS |
0.5.4 | Enhancement View pull request Rename s3 input to aws-s3. |
0.5.3 | Enhancement View pull request Add missing "geo" fields |
0.5.2 | Enhancement View pull request update to ECS 1.9.0 |
0.5.1 | Bug fix View pull request Ignore missing "json" field in ingest pipeline |
0.5.0 | Enhancement View pull request Moving edge processors to ingest pipeline |
0.4.2 | Enhancement View pull request Updating package owner |
0.4.1 | Bug fix View pull request Correct sample event file. |
0.4.0 | Enhancement View pull request Add changes to use ECS 1.8 fields. |
0.0.3 | Enhancement View pull request initial release |