AWS Storage Gateway

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

Installation

If you haven’t already, set up the Amazon Web Services integration first.

Metric collection

  1. In the AWS integration page, ensure that StorageGateway is enabled under the Metric Collection tab.
  2. Install the Datadog - AWS Storage Gateway integration.

Log collection

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

  1. If you haven’t already, set up the Datadog Forwarder Lambda function.

  2. 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:

Data Collected

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

The AWS Storage Gateway integration does not include any events.

Service Checks

The AWS Storage Gateway integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.