--- title: Amazon WorkSpaces description: >- Amazon WorkSpaces is a fully managed, secure desktop computing service which runs on the AWS cloud. breadcrumbs: Docs > Integrations > Amazon WorkSpaces --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). # Amazon WorkSpaces Integration version1.1.0 {% callout %} # Important note for users on the following Datadog sites: us2.ddog-gov.com {% alert level="info" %} To find out if this integration is available in your organization, see your [Datadog Integrations](https://app.datadoghq.com/integrations) page or ask your organization administrator. To initiate an exception request to enable this integration for your organization, email [support@ddog-gov.com](mailto:support@ddog-gov.com). {% /alert %} {% /callout %} ## Overview{% #overview %} Amazon WorkSpaces is a fully managed, secure desktop computing service which runs on the AWS cloud. Enable this integration to see in Datadog all your Amazon WorkSpaces metrics. ## Setup{% #setup %} ### Installation{% #installation %} If you haven't already, set up the [Amazon Web Services integration](https://docs.datadoghq.com/integrations/amazon_web_services.md) first. There are no other installation steps that need to be performed. ### Metric collection{% #metric-collection %} 1. In the [AWS integration page](https://app.datadoghq.com/integrations/amazon-web-services), ensure that `WorkSpaces` is enabled under the `Metric Collection` tab. 1. Install the [Datadog - Amazon WorkSpaces integration](https://app.datadoghq.com/integrations/amazon-workspaces). ### Log collection{% #log-collection %} #### Enable logging{% #enable-logging %} Configure Amazon WorkSpaces to send logs either to a S3 bucket or to CloudWatch. **Note**: If you log to a S3 bucket, make sure that `amazon_workspace` is set as *Target prefix*. #### Send logs to Datadog{% #send-logs-to-datadog %} 1. If you haven't already, set up the [Datadog Forwarder Lambda function](https://docs.datadoghq.com/logs/guide/forwarder.md). 1. Once the Lambda function is installed, manually add a trigger on the S3 bucket or CloudWatch log group that contains your Amazon WorkSpaces logs in the AWS console: - [Add a manual trigger on the S3 bucket](https://docs.datadoghq.com/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function.md#collecting-logs-from-s3-buckets) - [Add a manual trigger on the CloudWatch Log Group](https://docs.datadoghq.com/logs/guide/send-aws-services-logs-with-the-datadog-lambda-function.md#collecting-logs-from-cloudwatch-log-group) ## Data Collected{% #data-collected %} ### Metrics{% #metrics %} | | | | | **aws.workspaces.active\_user\_session\_capacity**(gauge) | The number of user sessions currently being used for streaming.*Shown as session* | | **aws.workspaces.actual\_user\_session\_capacity**(gauge) | The total pool sessions available or currently streaming.*Shown as session* | | **aws.workspaces.available**(gauge) | The number of WorkSpaces that returned a healthy status. | | **aws.workspaces.available\_user\_session\_capacity**(gauge) | The number of idle pool sessions available for user streaming.*Shown as session* | | **aws.workspaces.bandwidth**(gauge) | The rate of data transferred from the gateway to the client (outbound).*Shown as kilobit* | | **aws.workspaces.bandwidth\_inbound**(gauge) | The rate of data transferred from the client to the gateway (inbound).*Shown as kilobit* | | **aws.workspaces.congestion\_window**(gauge) | The size of the congestion window at the gateway for traffic flowing to the client.*Shown as byte* | | **aws.workspaces.connection\_attempt**(count) | The number of connection attempts. | | **aws.workspaces.connection\_duration**(gauge) | The duration of the streaming connection.*Shown as second* | | **aws.workspaces.connection\_failure**(count) | The number of failed connections. | | **aws.workspaces.connection\_success**(count) | The number of successful connections. | | **aws.workspaces.cpuusage**(gauge) | The percentage of the CPU resource used.*Shown as percent* | | **aws.workspaces.desired\_user\_session\_capacity**(gauge) | The total number of sessions either running or pending.*Shown as session* | | **aws.workspaces.frames\_per\_second**(gauge) | The number of frames sent per second from the WorkSpace to the client.*Shown as frame* | | **aws.workspaces.in\_session\_latency**(gauge) | The round trip time between the WorkSpaces client and the WorkSpace.*Shown as millisecond* | | **aws.workspaces.insufficient\_capacity\_error**(count) | The number of session requests rejected due to insufficient capacity.*Shown as error* | | **aws.workspaces.maintenance**(gauge) | The number of WorkSpaces that are under maintenance. | | **aws.workspaces.memory\_usage**(gauge) | The percentage of the machine memory used.*Shown as percent* | | **aws.workspaces.pending\_user\_session\_capacity**(gauge) | The number of sessions being provisioned for the pool.*Shown as session* | | **aws.workspaces.root\_volume\_disk\_usage**(gauge) | The percentage of the root disk volume used.*Shown as percent* | | **aws.workspaces.session\_disconnect**(count) | The number of connections that were closed, including user-initiated and failed connections. | | **aws.workspaces.session\_launch\_time**(gauge) | The amount of time it takes to initiate a WorkSpaces session.*Shown as second* | | **aws.workspaces.stopped**(gauge) | The number of WorkSpaces that are stopped. | | **aws.workspaces.tcpretransmission\_rate**(gauge) | The percentage of TCP segments retransmitted from the gateway to the client.*Shown as percent* | | **aws.workspaces.trusted\_device\_certificate\_days\_before\_expiration**(gauge) | The days remaining before the root certificate associated with the directory expires.*Shown as day* | | **aws.workspaces.trusted\_device\_validation\_attempt**(count) | The number of device authentication signature validation attempts.*Shown as attempt* | | **aws.workspaces.trusted\_device\_validation\_failure**(count) | The number of failed device authentication signature validations.*Shown as error* | | **aws.workspaces.trusted\_device\_validation\_success**(count) | The number of successful device authentication signature validations.*Shown as success* | | **aws.workspaces.udppacket\_loss\_rate**(gauge) | The percentage of UDP packets lost in traffic between the gateway and the client.*Shown as percent* | | **aws.workspaces.unhealthy**(gauge) | The number of WorkSpaces that returned an unhealthy status. | | **aws.workspaces.up\_time**(gauge) | The time since the last reboot of a WorkSpace.*Shown as second* | | **aws.workspaces.user\_connected**(gauge) | The number of WorkSpaces that have a user connected. | | **aws.workspaces.user\_sessions\_capacity\_utilization**(gauge) | The percentage of pool sessions in use.*Shown as percent* | | **aws.workspaces.user\_volume\_disk\_usage**(gauge) | The percentage of the user disk volume used.*Shown as percent* | Each of the metrics retrieved from AWS are assigned the same tags that appear in the AWS console, including but not limited to host name, security-groups, and more. ### Events{% #events %} The Amazon WorkSpaces integration does not include any events. ### Service Checks{% #service-checks %} The Amazon WorkSpaces integration does not include any service checks. ## Troubleshooting{% #troubleshooting %} Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).