AWS Storage Gateway
Collect asset and monitoring data for AWS Storage Gateway gateways and file shares.
Configuration¶
Install Func¶
We recommend enabling Hosted Func under Guance Integrations - Extensions. All prerequisites are installed automatically; continue with script installation.
For a self-hosted Func deployment, see Self-host Func.
Activate Script¶
Note: Prepare an AWS AK that meets the requirements. For simplicity, you can grant the global read-only permission
ReadOnlyAccessdirectly.
Select AccessKey authentication for GovCloud regions.
Activate the script in Hosted Func¶
- Log in to the Guance console
- Click the 【Integration】 menu and select 【Cloud Account Management】
- Click 【Add Cloud Account】, select 【AWS】, and fill in the required information on the interface. If you have already configured the cloud account information before, ignore this step
- Click 【Test】, and if the test is successful, click 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
- Click 【Cloud Account Management】, and you can see the added cloud account in the list. Click the corresponding cloud account to enter the details page
- Click [Integrations] on the cloud account details page. Find
AWS Storage Gatewayin theNot installedlist and click [Install] to open the installation dialog and complete the installation.
Activate the script manually¶
- Sign in to the Func console, click [Script Market], open the Guance script market, and search for
integration_aws_storage_gateway. - Click 【Install】 and enter AWS AK ID, AK Secret, and the account name.
- Click [Deploy Startup Script]. The system automatically creates the
Startupscript set and configures the corresponding startup script - after enabling it, open"Management / Automatic Trigger Configuration"to view the automatic trigger configuration.Click[Run],to run it immediately,without waiting for the scheduled interval.wait a moment,you can view execution records and related logs
Verification¶
- In"Management / Automatic Trigger Configuration"confirm that the automatic trigger configuration exists for the task,and review task records and logs for exceptions
- In Guance, check [Infrastructure / Custom] for asset information.
- InGuance,"Metrics"verify that the corresponding monitoring data
Metrics¶
Configure AWS cloud monitoring to collect additional metrics AWS cloud monitoring metric details
S3 File Gateway metrics for AWS Storage Gateway are in the aws_storage_gateway measurement; the description column provides each metric's description, unit, and statistics.
| MetricName | MetricDescribe | Dimensions | Unit |
|---|---|---|---|
cache_hit_percent_average |
Percentage of read operations served from cache | gateway_id, gateway_name | percent |
cache_percent_dirty_sum |
Percentage of gateway cache not yet persisted to AWS | gateway_id, gateway_name | percent |
cache_used_average |
Gateway cache bytes used | gateway_id, gateway_name | B |
file_shares_unavailable_average |
Number of unavailable file shares | gateway_id, gateway_name | count |
io_wait_percent_average |
Percentage of time the CPU waits for local disk responses | gateway_id, gateway_name | percent |
mem_total_bytes_average |
Gateway total memory in bytes | gateway_id, gateway_name | B |
mem_used_bytes_average |
Gateway used memory in bytes | gateway_id, gateway_name | B |
nfs_sessions_average |
Active NFS sessions | gateway_id, gateway_name | count |
smb_v1_sessions_average |
Active SMBv1 sessions | gateway_id, gateway_name | count |
smb_v2_sessions_average |
Active SMBv2 sessions | gateway_id, gateway_name | count |
smb_v3_sessions_average |
Active SMBv3 sessions | gateway_id, gateway_name | count |
user_cpu_percent_average |
Percentage of time spent on gateway processing | gateway_id, gateway_name | percent |