AWS workspaces documentation change
Summary
Updated CloudWatch metrics documentation: Reorganized metrics table, added new network performance metrics (TCPRetransmissionRate, Bandwidth, CongestionWindow etc.), modified metric descriptions, updated reference numbering, and clarified metric applicability.
Security assessment
Changes involve metric reorganization and additions for network monitoring, but contain no references to security vulnerabilities, patches, or incidents. Trusted device metrics were moved but not substantively changed.
Diff
diff --git a/workspaces/latest/adminguide/cloudwatch-metrics.md b/workspaces/latest/adminguide/cloudwatch-metrics.md index 1df81b3ec..5b0e0a152 100644 --- a//workspaces/latest/adminguide/cloudwatch-metrics.md +++ b//workspaces/latest/adminguide/cloudwatch-metrics.md @@ -36,9 +36,2 @@ Metric | Description | Dimensions | Statistics | Units -`Available`1 | The number of WorkSpaces that returned a healthy status. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count -`Unhealthy`1 | The number of WorkSpaces that returned an unhealthy status. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count -`ConnectionAttempt`2 | The number of connection attempts. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count -`ConnectionSuccess`2 | The number of successful connections. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count -`ConnectionFailure`2 | The number of failed connections. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count -`SessionLaunchTime`2,6 | The amount of time it takes to initiate a WorkSpaces session. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Second (time) -`InSessionLatency`2,6 | The round trip time between the WorkSpaces client and the WorkSpace. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Millisecond (time) -`SessionDisconnect`2,6 | The number of connections that were closed, including user-initiated and failed connections. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count -`UserConnected`3 | The number of WorkSpaces that have a user connected. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`Available` | The number of WorkSpaces that are healthy. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`Unhealthy` | The number of WorkSpaces that are unhealthy. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count @@ -46,5 +39,11 @@ Metric | Description | Dimensions | Statistics | Units -`Maintenance`4 | The number of WorkSpaces that are under maintenance. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count -`TrustedDeviceValidationAttempt`5,6 | The number of device authentication signature validation attempts. | `DirectoryId` | Average, Sum, Maximum, Minimum, Data Samples | Count -`TrustedDeviceValidationSuccess`5,6 | The number of successful device authentication signature validations. | `DirectoryId` | Average, Sum, Maximum, Minimum, Data Samples | Count -`TrustedDeviceValidationFailure`5,6 | The number of failed device authentication signature validations. | `DirectoryId` | Average, Sum, Maximum, Minimum, Data Samples | Count -`TrustedDeviceCertificateDaysBeforeExpiration`6 | Days left before the root certificate associated with the directory is expired. | `CertificateId` | Average, Sum, Maximum, Minimum, Data Samples | Count +`Maintenance` | The number of WorkSpaces that are under maintenance. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`ConnectionAttempt`1 | The number of connection attempts. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`ConnectionSuccess`1 | The number of successful connections. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`ConnectionFailure`1 | The number of failed connections. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`SessionLaunchTime`1 | The amount of time it takes to initiate a WorkSpaces session. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Seconds +`SessionDisconnect` | The number of sessions that were disconnected. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`UserConnected` | The number of WorkSpaces that have a user connected. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Sum, Maximum, Minimum, Data Samples | Count +`TrustedDeviceValidationAttempt`2 | The number of device authentication signature validation attempts. | `DirectoryId` | Average, Sum, Maximum, Minimum, Data Samples | Count +`TrustedDeviceValidationSuccess`2 | The number of successful device authentication signature validations. | `DirectoryId` | Average, Sum, Maximum, Minimum, Data Samples | Count +`TrustedDeviceValidationFailure`2 | The number of failed device authentication signature validations. | `DirectoryId` | Average, Sum, Maximum, Minimum, Data Samples | Count +`TrustedDeviceCertificateDaysBeforeExpiration` | Days left before the root certificate associated with the directory is expired. | `CertificateId` | Average, Sum, Maximum, Minimum, Data Samples | Count @@ -55 +53,0 @@ Metric | Description | Dimensions | Statistics | Units -`UDPPacketLossRate`7 | The percentage of packets dropped between the client and the gateway. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Percentage @@ -56,0 +55,8 @@ Metric | Description | Dimensions | Statistics | Units +`InSessionLatency` | The round trip time between the WorkSpaces client and the WorkSpace. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Milliseconds +`UDPPacketLossRate` | The percentage of packets lost for traffic from the gateway to the client. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Percentage +`TCPRetransmissionRate`3 | The percentage of TCP segments that were retransmitted from the gateway to the client. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Percentage +`Bandwidth`3 | The rate of data transferred from the gateway to the client (outbound). | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Kilobits/Second +`BandwidthInbound`3 | The rate of data transferred from the client to the gateway (inbound). | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Kilobits/Second +`CongestionWindow`3 | The size of the congestion window in bytes, which controls the amount of data that can be in transit at any given time. A smaller window indicates network congestion. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Bytes +`ConnectionDuration`3 | The duration of the streaming connection in seconds. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum, Data Samples | Seconds +`FramesPerSecond`3 | The number of frames sent per second from the WorkSpace to the client. | `DirectoryId` `WorkspaceId` `RunningMode` `Protocol` `ComputeType` `BundleId` `UserName` `ComputerName` | Average, Maximum, Minimum | Count/Second @@ -58 +64 @@ Metric | Description | Dimensions | Statistics | Units -1 WorkSpaces periodically sends status requests to a WorkSpace. A WorkSpace is marked `Available` when it responds to these requests, and `Unhealthy` when it fails to respond to these requests. These metrics are available at a per-WorkSpace level of granularity, and also aggregated for all WorkSpaces in an organization. +1 WorkSpaces records metrics on connections made to each WorkSpace. These metrics are emitted after a user has successfully authenticated via the WorkSpaces client and the client then initiates a session connection. @@ -60 +66 @@ Metric | Description | Dimensions | Statistics | Units -2 WorkSpaces records metrics on connections made to each WorkSpace. These metrics are emitted after a user has successfully authenticated via the WorkSpaces client and the client then initiates a session. The metrics are available at a per-WorkSpace level of granularity, and also aggregated for all WorkSpaces in a directory. +2 If the trusted devices feature is enabled for the directory, Amazon WorkSpaces uses certificate-based authentication to determine whether a device is trusted. When users attempt to access their WorkSpaces, these metrics are emitted to indicate successful or failed trusted device authentication. These metrics are applicable to only Windows and macOS client applications. @@ -62,9 +68 @@ Metric | Description | Dimensions | Statistics | Units -3 WorkSpaces periodically sends connection status requests to a WorkSpace. Users are reported as connected when they are actively using their sessions. This metric is available at a per-WorkSpace level of granularity, and is also aggregated for all WorkSpaces in an organization. - -4 This metric applies to WorkSpaces that are configured with an AutoStop running mode. If you have maintenance enabled for your WorkSpaces, this metric captures the number of WorkSpaces that are currently under maintenance. This metric is available at a per-WorkSpace level of granularity, which describes when a WorkSpace went into maintenance and when it was removed. - -5 If the trusted devices feature is enabled for the directory, Amazon WorkSpaces uses certificate-based authentication to determine whether a device is trusted. When users attempt to access their WorkSpaces, these metrics are emitted to indicate successful or failed trusted device authentication. These metrics are available at a per-directory level of granularity, and only for the Amazon WorkSpaces Windows and macOS client applications. - -6 Not available on WorkSpaces Web Access. - -7 This metric measures average packet loss. +3 Available only on DCV.