AWS AmazonECS documentation change
Summary
Restructured metrics documentation into table format for improved readability, consolidating metric descriptions, dimensions, statistics, and units into a standardized layout
Security assessment
Changes are purely structural/organizational improvements to existing metrics documentation. No security vulnerabilities or new security features are mentioned. TLS-related metrics (ClientTLSNegotiationErrorCount, TargetTLSNegotiationErrorCount) were already documented and remain unchanged in content.
Diff
diff --git a/AmazonECS/latest/developerguide/available-metrics.md index 329508bf0..5697e4d0f 100644 --- a/AmazonECS/latest/developerguide/available-metrics.md +++ b/AmazonECS/latest/developerguide/available-metrics.md @@ -11,34 +11,5 @@ You can use CloudWatch usage metrics to provide visibility into your accounts us -`CPUReservation` - - -The percentage of CPU units that are reserved in the cluster or service. - -The CPU reservation ( filtered by `ClusterName`) is measured as the total CPU units that are reserved by Amazon ECS tasks on the cluster, divided by the total CPU units for all of the Amazon EC2 instances registered in the cluster. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect CPU reservation metrics. The metric is only supported for tasks hosted on an Amazon EC2 instance. - -Valid dimensions: `ClusterName`. - -Useful statistics: Average, Minimum, Maximum - -Unit: Percent. - -`CPUUtilization` - - -The percentage of CPU units that is used by the cluster or service. - -The cluster-level CPU utilization ( filtered by `ClusterName`) is measured as the total CPU units that are in use by Amazon ECS tasks on the cluster, divided by the total CPU units for all of the Amazon EC2 instances registered in the cluster. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect CPU reservation metrics. The cluster-level metric is only supported for tasks hosted on an Amazon EC2 instance. - -The service-level CPU utilization ( filtered by `ClusterName`, `ServiceName`) is measured as the total CPU units in use by the tasks that belong to the service, divided by the total number of CPU units that are reserved for the tasks that belong to the service. The service-level metric is supported for tasks hosted on Amazon EC2 instances and Fargate. - -Valid dimensions: `ClusterName`, `ServiceName`. - -Useful statistics: Average, Minimum, Maximum - -Unit: Percent. - -`MemoryReservation` - - -The percentage of memory that is reserved by running tasks in the cluster. - -Cluster memory reservation is measured as the total memory that is reserved by Amazon ECS tasks on the cluster, divided by the total amount of memory for all of the Amazon EC2 instances registered in the cluster. This metric can only be filtered by `ClusterName`. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect memory reservation metrics. The cluster level memory reservation metric is only supported for tasks hosted on an Amazon EC2 instance. +Metric | Description | Valid Dimension | Useful Statistics | Unit +---|---|---|---|--- +CPUReservation | The percentage of CPU units that are reserved in the cluster or service. The CPU reservation ( filtered by `ClusterName`) is measured as the total CPU units that are reserved by Amazon ECS tasks on the cluster, divided by the total CPU units for all of the Amazon EC2 instances registered in the cluster. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect CPU reservation metrics. The metric is only supported for tasks hosted on an Amazon EC2 instance. | `ClusterName`. | Average, Minimum, Maximum | Percent +`CPUUtilization` | The percentage of CPU units that is used by the cluster or service. The cluster-level CPU utilization ( filtered by `ClusterName`) is measured as the total CPU units that are in use by Amazon ECS tasks on the cluster, divided by the total CPU units for all of the Amazon EC2 instances registered in the cluster. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect CPU reservation metrics. The cluster-level metric is only supported for tasks hosted on an Amazon EC2 instance. The service-level CPU utilization ( filtered by `ClusterName`, `ServiceName`) is measured as the total CPU units in use by the tasks that belong to the service, divided by the total number of CPU units that are reserved for the tasks that belong to the service. The service-level metric is supported for tasks hosted on Amazon EC2 instances and Fargate. | `ClusterName`, `ServiceName` | Average, Minimum, Maximum | Percent +`MemoryReservation` | The percentage of memory that is reserved by running tasks in the cluster. Cluster memory reservation is measured as the total memory that is reserved by Amazon ECS tasks on the cluster, divided by the total amount of memory for all of the Amazon EC2 instances registered in the cluster. This metric can only be filtered by `ClusterName`. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect memory reservation metrics. The cluster level memory reservation metric is only supported for tasks hosted on an Amazon EC2 instance. @@ -48,29 +19,3 @@ Cluster memory reservation is measured as the total memory that is reserved by A -When calculating memory utilization, if `MemoryReservation` is specified, it's used in the calculation instead of total memory. - -Valid dimensions: `ClusterName`. - -Useful statistics: Average, Minimum, Maximum - -Unit: Percent. - -`MemoryUtilization` - - -The percentage of memory in use by the cluster or service. - -The cluster-level memory utilization (filtered by `ClusterName`) is measured as the total memory in use by Amazon ECS tasks on the cluster, divided by the total memory for all of the Amazon EC2 instances registered in the cluster. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect memory utilization metrics. The cluster-level metric is only supported for tasks hosted on an Amazon EC2 instance. - -The service-level memory utilization (filtered by `ClusterName`, `ServiceName`) is measured as the total memory in use by the tasks that belong to the service, divided by the total memory reserved for the tasks that belong to the service. The service-level metric is supported for tasks hosted on Amazon EC2 instances and Fargate. - -Valid dimensions: `ClusterName`, `ServiceName`. - -Useful statistics: Average, Minimum, Maximum - -Unit: Percent. - -`EBSFilesystemUtilization` - - -The percentage of the Amazon EBS filesystem that is used by tasks in a service. - -The service level EBS filesystem utilization metric (filtered by `ClusterName`, `ServiceName`) is measured as the total amount of the EBS filesystem in use by the tasks that belong to the service, divided by the total amount of EBS filesystem storage that is allocated for all tasks that belong to the service. The service level EBS filesystem utilization metric is only available for tasks hosted on Amazon EC2 instances (using container agent version `1.79.0` ) and Fargate (using platform version `1.4.0`) that have an EBS volume attached. +When calculating memory utilization, if `MemoryReservation` is specified, it's used in the calculation instead of total memory. | `ClusterName`. | Average, Minimum, Maximum | Percent +`MemoryUtilization` | The percentage of memory in use by the cluster or service. The cluster-level memory utilization (filtered by `ClusterName`) is measured as the total memory in use by Amazon ECS tasks on the cluster, divided by the total memory for all of the Amazon EC2 instances registered in the cluster. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect memory utilization metrics. The cluster-level metric is only supported for tasks hosted on an Amazon EC2 instance. The service-level memory utilization (filtered by `ClusterName`, `ServiceName`) is measured as the total memory in use by the tasks that belong to the service, divided by the total memory reserved for the tasks that belong to the service. The service-level metric is supported for tasks hosted on Amazon EC2 instances and Fargate. | `ClusterName`, `ServiceName` | Average, Minimum, Maximum | Percent +`EBSFilesystemUtilization` | The percentage of the Amazon EBS filesystem that is used by tasks in a service. The service level EBS filesystem utilization metric (filtered by `ClusterName`, `ServiceName`) is measured as the total amount of the EBS filesystem in use by the tasks that belong to the service, divided by the total amount of EBS filesystem storage that is allocated for all tasks that belong to the service. The service level EBS filesystem utilization metric is only available for tasks hosted on Amazon EC2 instances (using container agent version `1.79.0` ) and Fargate (using platform version `1.4.0`) that have an EBS volume attached. @@ -80,206 +25,16 @@ The service level EBS filesystem utilization metric (filtered by `ClusterName`, -For tasks hosted on Fargate, there is space on the disk that is only used by Fargate. There is no cost associated with the space Fargate uses, but you will see this additional storage using tools like `df`. - -Valid dimensions: `ClusterName, ServiceName`. - -Useful statistics: Average, Minimum, Maximum - -Unit: Percent. - -`GPUReservation` - - -The percentage of total available GPUs that are reserved by running tasks in the cluster. - -The cluster level GPU reservation metric is measured as the number of GPUs reserved by Amazon ECS tasks on the cluster, divided by the total number of GPUs that was available on all of the Amazon EC2 instances with GPUs registered in the cluster. Only Amazon EC2 instances in `ACTIVE` or `DRAINING` status will affect GPU reservation metrics. - -Valid dimensions: `ClusterName`. - -Useful statistics: Average, Minimum, Maximum - -All statistics: Average, Minimum, Maximum, Sum, Sample Count. - -Unit: Percent. - -`ActiveConnectionCount` - - -The total number of concurrent connections active from clients to the Amazon ECS Service Connect proxies that run in tasks that share the selected `DiscoveryName`. - -This metric is only available if you have configured Amazon ECS Service Connect. - -Valid dimensions: `DiscoveryName` and `DiscoveryName, ServiceName, ClusterName`. - -Useful statistics: Average, Minimum, Maximum, Sum. - -Unit: Count. - -`NewConnectionCount` - - -The total number of new connections established from clients to the Amazon ECS Service Connect proxies that run in tasks that share the selected `DiscoveryName`. - -This metric is only available if you have configured Amazon ECS Service Connect. - -Valid dimensions: `DiscoveryName` and `DiscoveryName, ServiceName, ClusterName`. - -Useful statistics: Average, Minimum, Maximum, Sum. - -Unit: Count. - -`ProcessedBytes` - - -The total number of bytes of inbound traffic processed by the Service Connect proxies. - -This metric is only available if you have configured Amazon ECS Service Connect. - -Valid dimensions: `DiscoveryName` and `DiscoveryName, ServiceName, ClusterName`. - -Useful statistics: Average, Minimum, Maximum, Sum. - -Unit: Bytes. - -`RequestCount` - - -The number of inbound traffic requests processed by the Service Connect proxies. - -This metric is only available if you have configured Amazon ECS Service Connect. - -You also need to configure `appProtocol` in the port mapping in your task definition. - -Valid dimensions: `DiscoveryName` and `DiscoveryName, ServiceName, ClusterName`. - -Useful statistics: Average, Minimum, Maximum, Sum. - -Unit: Count. - -`GrpcRequestCount` - - -The number of gRPC inbound traffic requests processed by the Service Connect proxies. - -This metric is only available if you have configured Amazon ECS Service Connect and the `appProtocol` is `GRPC` in the port mapping in the task definition. - -Valid dimensions: `DiscoveryName` and `DiscoveryName, ServiceName, ClusterName`. - -Useful statistics: Average, Minimum, Maximum, Sum. - -Unit: Count. - -`HTTPCode_Target_2XX_Count` - - -The number of HTTP response codes with numbers 200 to 299 generated by the applications in these tasks. These tasks are the targets. This metric only counts the responses sent to the Service Connect proxies by the applications in these tasks, not responses sent directly. - -This metric is only available if you have configured Amazon ECS Service Connect and the `appProtocol` is `HTTP` or `HTTP2` in the port mapping in the task definition. - -Valid dimensions: `TargetDiscoveryName` and `TargetDiscoveryName, ServiceName, ClusterName`. - -Useful statistics: Average, Minimum, Maximum, Sum. - -Unit: Count. - -`HTTPCode_Target_3XX_Count` - - -The number of HTTP response codes with numbers 300 to 399 generated by the applications in these tasks. These tasks are the targets. This metric only counts the responses sent to the Service Connect proxies by the applications in these tasks, not responses sent directly. - -This metric is only available if you have configured Amazon ECS Service Connect and the `appProtocol` is `HTTP` or `HTTP2` in the port mapping in the task definition. - -Valid dimensions: `TargetDiscoveryName` and `TargetDiscoveryName, ServiceName, ClusterName`. - -Useful statistics: Average, Minimum, Maximum, Sum. - -Unit: Count. - -`HTTPCode_Target_4XX_Count` - - -The number of HTTP response codes with numbers 400 to 499 generated by the applications in these tasks. These tasks are the targets. This metric only counts the responses sent to the Service Connect proxies by the applications in these tasks, not responses sent directly. - -This metric is only available if you have configured Amazon ECS Service Connect and the `appProtocol` is `HTTP` or `HTTP2` in the port mapping in the task definition.