An Amazon ECS cluster is a logical grouping of tasks or services.
- If tasks or services are being run that use the EC2 launch type, a cluster is also a grouping of container instances.
- If capacity providers are being used, a cluster is also a logical grouping of capacity providers.
When Amazon ECS is first used, a default cluster is created. Multiple clusters can be created in an account and help to keep resources separate.
An Amazon ECS service runs and maintains the requested number of tasks and associated load balancers.
External reference
Setup
To set up the AWS integration and discover the VPN resources, do the following:
- Create an AWS Integration if not available in your installed integrations.
- Create a discovery profile.
- Select
ECS Clustersin the AWS Integration Discovery Profile. - Save the discovery profile to make them available in the list of Discovery Profiles.
- Scan to discover the resources at any time independent of the predefined schedule.
- Once the scan is completed, you can view the
ECS Clustersresources under Infrastructure > Resources > AWS category.
Event support
CloudTrail event support
- Not Supported
CloudWatch alarm support
- Supported
- Configurable in OpsRamp AWS Integration Discovery Profile.
Supported metrics
AWS ECS Cluster Metrics
| OpsRamp Metric | AWS Metric | Metric Display Name | Unit | Description | Aggregation Type |
|---|---|---|---|---|---|
| aws_ecs_CPUReservation | CPUReservation | CPUReservation | Percent | The percentage of CPU units that are reserved by running tasks in the cluster. | Average |
| aws_ecs_CPUUtilization | CPUUtilization | CPUUtilization | Percent | The percentage of CPU units that are used in the cluster or service. | Average |
| aws_ecs_MemoryReservation | MemoryReservation | MemoryReservation | Percent | The percentage of memory that is reserved by running tasks in the cluster. | Average |
| aws_ecs_MemoryUtilization | MemoryUtilization | MemoryUtilization | Percent | The percentage of memory that is used in the cluster or service. | Average |
| aws_ecs_GPUReservation | GPUReservation | GPU Reservation | Percent | The percentage of total available GPUs that are reserved by running tasks in the cluster. | Average |
| aws_ecs_TaskCount | TaskCount | Task Count | Count | The number of tasks running in the cluster. | Average |
| cloud.instance.state Status/State | n/a | Status/State | n/a | Status/State | n/a |
| aws_ecs_container_insights_instance_cpu_limit | instance_cpu_limit | Instance cpu limit | None | The maximum number of CPU units that can be assigned to a single EC2 Instance in the cluster. | Average |
| aws_ecs_container_insights_instance_cpu_reserved_capacity | instance_cpu_reserved_capacity | Instance cpu reserved capacity | Percent | The percentage of CPU currently being reserved on a single EC2 instance in the cluster. | Average |
| aws_ecs_container_insights_instance_cpu_usage_total | instance_cpu_usage_total | Instance cpu usage total | None | The number of CPU units being used on a Single EC2 instance in the cluster. | Average |
| aws_ecs_container_insights_instance_cpu_utilization | instance_cpu_utilization | Instance cpu utilization | Percent | The total percentage of CPU units being used on a single EC2 instance in the cluster. | Average |
| aws_ecs_container_insights_instance_filesystem_utilization | instance_filesystem_utilization | Instance filesystem utilization | Percent | The total percentage of file system capacity being used on a single EC2 instance in the cluster. | Average |
| aws_ecs_container_insights_instance_memory_limit | instance_memory_limit | Instance memory limit | Bytes | The maximum limit of memory, measured in bytes, that can be allocated to an individual EC2 Instance within this cluster. | Average |
| aws_ecs_container_insights_instance_memory_reserved_capacity | instance_memory_reserved_capacity | Instance memory reserved capacity | Percent | The percentage of Memory currently being reserved on a single EC2 Instance in the cluster. | Average |
| aws_ecs_container_insights_instance_memory_utilization | instance_memory_utilization | Instance memory utilization | Percent | The total percentage of memory being used on a single EC2 Instance in the cluster. | Average |
| aws_ecs_container_insights_instance_memory_working_set | instance_memory_working_set | Instance memory working set | Bytes | The amount of memory, in bytes, being used on a single EC2 Instance in the cluster. | Average |
| aws_ecs_container_insights_instance_network_total_bytes | instance_network_total_bytes | Instance network total bytes | Bytes/Second | The total number of bytes per second transmitted and received over the network on a single EC2 Instance in the cluster. | Average |
| aws_ecs_container_insights_instance_number_of_running_tasks | instance_number_of_running_tasks | Instance number of running tasks | Count | The number of running tasks on a single EC2 Instance in the cluster. | Average |
| aws_ecs_container_insights_ServiceCount | ServiceCount | Service Count | Count | The number of services in the cluster. | Average |
| aws_ecs_container_insights_ContainerInstanceCount | ContainerInstanceCount | Container Instance Count | Count | The number of EC2 instances running the Amazon ECS agent that are registered with a cluster. | Average |
| aws_ecs_container_insights_StorageWriteBytes | StorageWriteBytes | Storage Write Bytes | Bytes | The number of bytes written to storage in the resource that is specified by the dimensions that you are using. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_StorageReadBytes | StorageReadBytes | Storage Read Bytes | Bytes | The number of bytes read from storage on the instance in the resource that is specified by the dimensions that you are using. This does not include read bytes for your storage devices. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_NetworkTxBytes | NetworkTxBytes | Network Tx Bytes | Bytes/Second | The number of bytes transmitted by the resource that is specified by the dimensions that you are using. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_NetworkRxBytes | NetworkRxBytes | Network Rx Bytes | Bytes/Second | The number of bytes received by the resource that is specified by the dimensions that you are using. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_MemoryReserved | MemoryReserved | Memory Reserved | Megabytes | The memory that is reserved by tasks within the specified resource dimension. | Average |
| aws_ecs_container_insights_MemoryUtilized | MemoryUtilized | Memory Utilized | Megabytes | The amount of memory currently utilized by tasks within the specified resource dimension. | Average |
| aws_ecs_container_insights_EphemeralStorageUtilized | EphemeralStorageUtilized | Ephemeral Storage Utilized | Gigabytes | The quantity of bytes consumed from ephemeral storage within the resource defined by the dimensions being utilized. Ephemeral storage is used for the container root filesystem and any host volumes bind-mounted as specified in the container image and task definition. It is important to note that the capacity of ephemeral storage cannot be modified during the execution of a task. | Average |
| aws_ecs_container_insights_EphemeralStorageReserved | EphemeralStorageReserved | Ephemeral Storage Reserved | Gigabytes | The quantity of bytes reserved from ephemeral storage within the resource defined by the dimensions being utilized. Ephemeral storage is used for the container root filesystem and any host volumes bind-mounted as specified in the container image and task definition. It is important to note that the capacity of ephemeral storage cannot be modified during the execution of a running task. | Average |
| aws_ecs_container_insights_CpuReserved | CpuReserved | Cpu Reserved | None | The CPU units reserved by tasks in the resource that is specified by the dimension set that you are using. | Average |
| aws_ecs_container_insights_CpuUtilized | CpuUtilized | Cpu Utilized | None | The CPU units used by tasks in the resource that is specified by the dimension set that you are using. | Average |
AWS ECS Service Metrics
| OpsRamp Metric | AWS Metric | Metric Display Name | Unit | Description | Aggregation Type |
|---|---|---|---|---|---|
| aws_ecs_CPUUtilization | CPUUtilization | CPUUtilization | Percent | Percentage of CPU units that are used in the cluster or service.4 | Average |
| aws_ecs_MemoryUtilization | MemoryUtilization | MemoryUtilization | Percent | Percentage of memory that is used in the cluster or service. | Average |
| aws_ecs_RunningTaskCount | RunningTaskCount | RunningTaskCount | Count | Number of tasks currently in the Running state. | Sum |
| aws_ecs_PendingTaskCount | PendingTaskCount | PendingTaskCount | Count | Number of tasks currently in the Pending state. | Sum |
| aws_ecs_DesiredTaskCount | DesiredTaskCount | DesiredTaskCount | Count | The desired number of tasks for an Amazon ECS service. | Sum |
| cloud.instance.state | n/a | Status/State | n/a | Status/State | n/a |
| aws_ecs_container_insights_TaskSetCount | TaskSetCount | Task Set Count | Count | The number of task sets in the service. | Average |
| aws_ecs_container_insights_DeploymentCount | DeploymentCount | Deployment Count | Count | The number of deployments in an Amazon ECS service. | Average |
| aws_ecs_container_insights_StorageWriteBytes | StorageWriteBytes | Storage Write Bytes | Bytes | The number of bytes written to storage in the resource that is specified by the dimensions that you are using. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_StorageReadBytes | StorageReadBytes | Storage Read Bytes | Bytes | The number of bytes read from storage on the instance in the resource that is specified by the dimensions that you are using. This does not include read bytes for your storage devices. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_NetworkTxBytes | NetworkTxBytes | Network Tx Bytes | Bytes/Second | The number of bytes transmitted by the resource that is specified by the dimensions that you are using. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_NetworkRxBytes | NetworkRxBytes | Network Rx Bytes | Bytes/Second | The number of bytes received by the resource that is specified by the dimensions that you are using. This metric is obtained from the Docker runtime. | Average |
| aws_ecs_container_insights_MemoryReserved | MemoryReserved | Memory Reserved | Megabytes | The memory that is reserved by tasks in the resource that is specified by the dimension set that you are using. | Average |
| aws_ecs_container_insights_MemoryUtilized | MemoryUtilized | Memory Utilized | Megabytes | The memory being used by tasks in the resource that is specified by the dimension set that you are using. | Average |
| aws_ecs_container_insights_EphemeralStorageUtilized | EphemeralStorageUtilized | Ephemeral Storage Utilized | Gigabytes | The quantity of bytes consumed from ephemeral storage within the resource defined by the dimensions being utilized. Ephemeral storage is used for the container root filesystem and any host volumes bind-mounted as specified in the container image and task definition. It is important to note that the capacity of ephemeral storage cannot be modified during the execution of a task. | Average |
| aws_ecs_container_insights_EphemeralStorageReserved | EphemeralStorageReserved | Ephemeral Storage Reserved | Gigabytes | The quantity of bytes reserved from ephemeral storage within the resource defined by the dimensions being utilized. Ephemeral storage is used for the container root filesystem and any host volumes bind-mounted as specified in the container image and task definition. It is important to note that the capacity of ephemeral storage cannot be modified during the execution of a running task. | Average |
| aws_ecs_container_insights_CpuReserved | CpuReserved | Cpu Reserved | None | The CPU units reserved by tasks in the resource that is specified by the dimension set that you are using. | Average |
| aws_ecs_container_insights_CpuUtilized | CpuUtilized | Cpu Utilized | None | The CPU units used by tasks in the resource that is specified by the dimension set that you are using. | Average |