--- title: AWS Storage Gateway description: >- Ensures secure and seamless integration between an organization's IT environment and AWS's storage infrastructure. breadcrumbs: Docs > Integrations > AWS Storage Gateway --- # AWS Storage Gateway Integration version1.0.0 ## Overview{% #overview %} AWS Storage Gateway provides seamless and secure integration between an organization's IT environment and AWS's storage infrastructure. Enable this integration to see in Datadog all your Storage Gateway metrics. ## Setup{% #setup %} ### Installation{% #installation %} If you haven't already, set up the [Amazon Web Services integration first](https://docs.datadoghq.com/integrations/amazon_web_services/). ### Metric collection{% #metric-collection %} 1. In the [AWS integration page](https://app.datadoghq.com/integrations/amazon-web-services), ensure that `StorageGateway` is enabled under the `Metric Collection` tab. 1. Install the [Datadog - AWS Storage Gateway integration](https://app.datadoghq.com/integrations/amazon-storage-gateway). ### Log collection{% #log-collection %} #### Enable logging{% #enable-logging %} Configure AWS Storage Gateway to send logs either to a S3 bucket or to CloudWatch. **Note**: If you log to a S3 bucket, make sure that `amazon_storage_gateway` 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/). 1. Once the Lambda function is installed, manually add a trigger on the S3 bucket or CloudWatch log group that contains your AWS Storage Gateway 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/#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/#collecting-logs-from-cloudwatch-log-group) ## Data Collected{% #data-collected %} ### Metrics{% #metrics %} | | | | | **aws.storagegateway.availability\_notifications**(count) | Number of availability-related health notifications generated by the gateway.*Shown as event* | | **aws.storagegateway.cache\_hit\_percent**(gauge) | Percent of application reads served from the cache.*Shown as percent* | | **aws.storagegateway.cache\_percent\_dirty**(gauge) | Percentage of gateway cache that has not been persisted to AWS.*Shown as percent* | | **aws.storagegateway.cache\_used**(gauge) | Total number of bytes being used in the gateway's cache storage.*Shown as byte* | | **aws.storagegateway.io\_wait\_percent**(gauge) | Percentage of time that the gateway's CPU was waiting for I/O operations.*Shown as percent* | | **aws.storagegateway.mem\_total\_bytes**(gauge) | Total memory available to the gateway VM.*Shown as byte* | | **aws.storagegateway.mem\_used\_bytes**(gauge) | Memory in use by the gateway VM.*Shown as byte* | | **aws.storagegateway.queued\_writes**(gauge) | Bytes waiting to be written to AWS from working storage.*Shown as byte* | | **aws.storagegateway.read\_bytes**(count) | Bytes read from on-premises applications for all volumes in the gateway.*Shown as byte* | | **aws.storagegateway.read\_time**(gauge) | Milliseconds spent on read operations from on-premises applications for all volumes in the gateway.*Shown as millisecond* | | **aws.storagegateway.time\_since\_last\_recovery\_point**(gauge) | Seconds since the last available recovery point.*Shown as second* | | **aws.storagegateway.total\_cache\_size**(gauge) | Total size of the gateway cache, in bytes.*Shown as byte* | | **aws.storagegateway.upload\_buffer\_percent\_used**(gauge) | Percentage of the upload buffer currently being used.*Shown as percent* | | **aws.storagegateway.upload\_buffer\_used**(gauge) | Bytes being used in the upload buffer.*Shown as byte* | | **aws.storagegateway.user\_cpu\_percent**(gauge) | Percentage of CPU utilization in user space on the gateway VM.*Shown as percent* | | **aws.storagegateway.working\_storage\_free**(gauge) | Bytes free in the gateway's working storage.*Shown as byte* | | **aws.storagegateway.working\_storage\_percent\_used**(gauge) | Percentage of working storage currently used.*Shown as percent* | | **aws.storagegateway.working\_storage\_used**(gauge) | Bytes used in the gateway's working storage.*Shown as byte* | | **aws.storagegateway.write\_bytes**(count) | Bytes written to on-premises applications for all volumes.*Shown as byte* | | **aws.storagegateway.write\_time**(gauge) | Milliseconds spent on write operations.*Shown as millisecond* | | **aws.storagegateway.cache\_percent\_used**(gauge) | Percentage of the gateway's cache storage currently used.*Shown as percent* | | **aws.storagegateway.upload\_buffer\_free**(gauge) | Bytes of free space in the upload buffer.*Shown as byte* | | **aws.storagegateway.cache\_file\_size**(gauge) | Bytes of files stored in cache.*Shown as byte* | | **aws.storagegateway.cache\_free**(gauge) | Bytes free in the file gateway cache.*Shown as byte* | | **aws.storagegateway.cloud\_bytes\_downloaded**(count) | Compressed bytes downloaded from AWS.*Shown as byte* | | **aws.storagegateway.cloud\_bytes\_uploaded**(count) | Compressed bytes uploaded to AWS.*Shown as byte* | | **aws.storagegateway.cloud\_download\_latency**(gauge) | Milliseconds spent reading data from AWS.*Shown as millisecond* | | **aws.storagegateway.files\_failing\_upload**(count) | Files that failed to upload to S3.*Shown as file* | | **aws.storagegateway.file\_shares\_unavailable**(gauge) | Number of file shares in the unavailable state.*Shown as event* | | **aws.storagegateway.files\_renamed**(count) | Files that were renamed in the cache.*Shown as file* | | **aws.storagegateway.health\_notifications**(count) | Health notifications generated by the tape gateway.*Shown as event* | | **aws.storagegateway.index\_evictions**(count) | Metadata entries evicted from the cache index.*Shown as eviction* | | **aws.storagegateway.index\_fetches**(count) | Metadata entries fetched into the cache index.*Shown as fetch* | | **aws.storagegateway.nfs\_sessions**(gauge) | Active NFS sessions on the gateway.*Shown as session* | | **aws.storagegateway.root\_disk\_free\_bytes**(gauge) | Available bytes on the gateway's root disk.*Shown as byte* | | **aws.storagegateway.s\_3get\_object\_request\_time**(gauge) | Latency of S3 GetObject requests.*Shown as millisecond* | | **aws.storagegateway.s\_3put\_object\_request\_time**(gauge) | Latency of S3 PutObject requests.*Shown as millisecond* | | **aws.storagegateway.s\_3upload\_part\_request\_time**(gauge) | Latency of S3 UploadPart requests.*Shown as millisecond* | | **aws.storagegateway.smb\_v\_1sessions**(gauge) | Active SMBv1 sessions on the gateway.*Shown as session* | | **aws.storagegateway.smb\_v\_2sessions**(gauge) | Active SMBv2 sessions on the gateway.*Shown as session* | | **aws.storagegateway.smb\_v\_3sessions**(gauge) | Active SMBv3 sessions on the gateway.*Shown as session* | | **aws.storagegateway.cache\_directory\_size**(gauge) | Size of folders in the gateway cache.*Shown as resource* | | **aws.storagegateway.file\_system\_error**(gauge) | Number of file system associations which are in the ERROR state in the gateways.*Shown as error* | | **aws.storagegateway.file\_shares**(gauge) | Number of file shares in the gateway.*Shown as resource* | | **aws.storagegateway.audit\_notifications**(count) | Number of audit logs emitted by the gateway.*Shown as event* | 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 AWS Storage Gateway integration does not include any events. ### Service Checks{% #service-checks %} The AWS Storage Gateway integration does not include any service checks. ## Troubleshooting{% #troubleshooting %} Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).