Monitoring Storage Gateway - Amazon Storage Gateway
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

Amazon FSx File Gateway documentation has been moved to What is Amazon FSx File Gateway?

Volume Gateway documentation has been moved to What is Volume Gateway?

Tape Gateway documentation has been moved to What is Tape Gateway?

Monitoring Storage Gateway

This section describes how to monitor a gateway using Amazon CloudWatch, including monitoring cache storage and other resources associated with the gateway. You use the Storage Gateway console to view metrics and alarms for your gateway. For example, you can view the number of bytes used in read and write operations, the time spent in read and write operations, and the time taken to retrieve data from the Amazon Cloud. With metrics, you can track the health of your gateway and set up alarms to notify you when one or more metrics fall outside a defined threshold.

Storage Gateway provides CloudWatch metrics at no additional charge. Storage Gateway metrics are recorded for a period of two weeks. By using these metrics, you can access historical information and get a better perspective on how your gateways are performing. Storage Gateway also provides CloudWatch alarms, except high-resolution alarms, at no additional charge. For more information about CloudWatch pricing, see Amazon CloudWatch pricing. For more information about CloudWatch, see the Amazon CloudWatch User Guide.

Understanding CloudWatch alarms

CloudWatch alarms monitor information about your gateway based on metrics and expressions. You can add CloudWatch alarms for your gateway and view their statuses in the Storage Gateway console. For more information about the metrics that are used to monitor S3 File Gateway, see Understanding gateway metrics and Understanding file share metrics. For each alarm, you specify conditions that will trigger its ALARM state. Alarm status indicators in the Storage Gateway console turn red when in the ALARM state, making it easier for you to monitor status proactively. You can configure alarms to invoke actions automatically based on sustained changes in state. For more information about CloudWatch alarms, see Using Amazon CloudWatch alarms in the Amazon CloudWatch User Guide.

Note

If you don't have permission to view CloudWatch, you can't view the alarms.

For each activated gateway, we recommend that you create the following CloudWatch alarms:

  • High IO wait: IoWaitpercent >= 20 for 3 datapoints in 15 minutes

  • Cache percent dirty: CachePercentDirty > 80 for 4 datapoints within 20 minutes

  • Files failing upload: FilesFailingUpload >= 1 for 1 datapoint within 5 minutes

  • File shares unavailable: FileSharesUnavailable >= 1 for 1 datapoint within 5 minutes

For gateways on VMware host platforms with HA mode enabled, we also recommend these additional CloudWatch alarms:

  • Availability notifications: AvailabilityNotifications >= 1 for 1 datapoints within 5 minutes

  • Health notifications: HealthNotifications >= 1 for 1 datapoints within 5 minutes

    Note

    You can set a health notification alarm only if the gateway had a previous health notification in CloudWatch.

The following table describes CloudWatch alarm states.

State Description

OK

The metric or expression is within the defined threshold.

Alarm

The metric or expression is outside of the defined threshold.

Insufficient data

The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.

None

No alarms are created for the gateway. To create a new alarm, see Creating a custom CloudWatch alarm for your gateway.

Unavailable

The state of the alarm is unknown. Choose Unavailable to view error information in the Monitoring tab.

When you create a new gateway using the Storage Gateway console, you can choose to create all recommended CloudWatch alarms automatically as part of the initial setup process. For more information, see Configure your Amazon S3 File Gateway. If you want to add or update recommended CloudWatch alarms for an existing gateway, use the following procedure.

To add or update recommended CloudWatch alarms for an existing gateway
Note

This feature requires CloudWatch policy permissions, which are not automatically granted as part of the preconfigured Storage Gateway full access policy. Make sure your security policy grants the following permissions before you attempt to create recommended CloudWatch alarms:

  • cloudwatch:PutMetricAlarm - create alarms

  • cloudwatch:DisableAlarmActions - turn alarm actions off

  • cloudwatch:EnableAlarmActions - turn alarm actions on

  • cloudwatch:DeleteAlarms - delete alarms

  1. Open the Storage Gateway console at https://console.amazonaws.cn/storagegateway/home/.

  2. In the navigation pane, choose Gateways, then choose the gateway for which you want to create recommended CloudWatch alarms.

  3. On the gateway details page, choose the Monitoring tab.

  4. Under Alarms, choose Create recommended alarms. The recommended alarms are created automatically.

    The Alarms section lists all CloudWatch alarms for a specific gateway. From here, you can select and delete one or more alarms, turn alarm actions on or off, and create new alarms.

Creating a custom CloudWatch alarm for your gateway

CloudWatch uses Amazon Simple Notification Service (Amazon SNS) to send alarm notifications when an alarm changes state. An alarm watches a single metric over a time period that you specify, and performs one or more actions based on the value of the metric relative to a given threshold over a number of time periods. The action is a notification that's sent to an Amazon SNS topic. You can create an Amazon SNS topic when you create a CloudWatch alarm. For more information about Amazon SNS, see What is Amazon SNS? in the Amazon Simple Notification Service Developer Guide.

To create a CloudWatch alarm in the Storage Gateway console
  1. Open the Storage Gateway console at https://console.amazonaws.cn/storagegateway/home/.

  2. In the navigation pane, choose Gateways, then choose the gateway for which you want to create an alarm.

  3. On the gateway details page, choose the Monitoring tab.

  4. Under Alarms, choose Create alarm to open the CloudWatch console.

  5. Use the CloudWatch console to create the type of alarm that you want. You can create the following types of alarms:

    • Static threshold alarm: An alarm based on a set threshold for a chosen metric. The alarm enter the ALARM state when the metric breaches the threshold for a specified number of evaluation periods.

      To create a static threshold alarm, see Creating a CloudWatch alarm based on a static threshold in the Amazon CloudWatch User Guide.

    • Anomaly detection alarm: Anomaly detection mines past metric data and creates a model of expected values. You set a value for the anomaly detection threshold, and CloudWatch uses this threshold with the model to determine the "normal" range of values for the metric. A higher value for the threshold produces a thicker band of "normal" values. You can choose to activate the alarm only when the metric value is above the band of expected values, only when it's below the band, or when it's above or below the band.

      To create an anomaly detection alarm, see Creating a CloudWatch alarm based on anomaly detection in the Amazon CloudWatch User Guide.

    • Metric math expression alarm: An alarm based one or more metrics used in a math expression. You specify the expression, threshold, and evaluation periods.

      To create a metric math expression alarm, see Creating a CloudWatch alarm based on a metric math expression in the Amazon CloudWatch User Guide.

    • Composite alarm: An alarm that determines its alarm state by watching the alarm states of other alarms. A composite alarm can help you reduce alarm noise.

      To create a composite alarm, see Creating a composite alarm in the Amazon CloudWatch User Guide.

  6. After you create the alarm in the CloudWatch console, return to the Storage Gateway console. You can view the alarm by doing one of the following:

    • In the navigation pane, choose Gateways, then choose the gateway for which you want to view alarms. On the Details tab, under Alarms, choose CloudWatch Alarms.

    • In the navigation pane, choose Gateways, choose the gateway for which you want to view alarms, then choose the Monitoring tab.

      The Alarms section lists all of the CloudWatch alarms for a specific gateway. From here, you can select and delete one or more alarms, turn alarm actions on or off, and create new alarms.

    • In the navigation pane, choose Gateways, then choose the alarm state of the gateway for which you want to view alarms.

For information about how to edit or delete an alarm, see Editing or deleting a CloudWatch alarm.

Note

When you delete a gateway using the Storage Gateway console, all CloudWatch alarms associated with the gateway are also automatically deleted.