Skip to content

AWS EFS

Collect AWS Elastic File System metrics

Configuration

Install Func

We recommend enabling hosted Func under Guance Integrations - Extensions. All prerequisites are installed automatically; continue with the script installation.

To deploy Func yourself, see Deploy Func Yourself

Install Script

Note: Prepare an Amazon AK that meets the requirements. For simplicity, you can grant the global read-only permission ReadOnlyAccess directly.

Activate the Hosted Script

  1. Log in to the Guance console.
  2. Click 【Integrations】 and select 【Cloud Account Management】.
  3. Click 【Add Cloud Account】, select 【AWS】, and enter the required information. Skip this step if the cloud account has already been configured.
  4. Click 【Test】, then click 【Save】 if the test succeeds. If it fails, check the configuration and test again.
  5. Find the added cloud account in 【Cloud Account Management】 and click it to open its details page.
  6. Click 【Integrations】 on the cloud account details page, find AWS EFS under Not Installed, and click 【Install】. Complete the installation in the dialog.

Activate the Script Manually

  1. Log in to the Func console, click 【Script Market】, open the Guance script market, and search for integration_aws_efs.

  2. Click 【Install】 and enter AWS AK ID, AK Secret, and the account name.

  3. Click 【Deploy Startup Script】. The system automatically creates the Startup script set and configures the startup script.

  4. After activation, find the automatic trigger configuration under 「Management / Automatic Trigger Configuration」. Click 【Execute】 to run it immediately without waiting for the schedule. After a short wait, review the task records and logs.

Verification

  1. Under 「Management / Automatic Trigger Configuration」, confirm that the task has an automatic trigger configured, and check its records and logs for errors.
  2. In Guance, check 「Infrastructure - Resource Catalog」 for asset information.
  3. In Guance, check 「Metrics」 for the corresponding monitoring data.

Metrics

Configure Amazon CloudWatch to collect more metrics. See Amazon CloudWatch Metric Details.

AWS Elastic File System metrics belong to the aws_AWS/EFS measurement. The description column explains each metric, including its unit and statistics.

MetricName MetricDescribe Dimensions Unit
BurstCreditBalance_Average Burst throughput credit balance available to the file system FileSystemId B
ClientConnections_Sum Client connections to the file system FileSystemId count
DataReadIOBytes_Sum Total bytes for file system read operations FileSystemId B
DataWriteIOBytes_Sum Total bytes for file system write operations FileSystemId B
MetadataIOBytes_Sum Total bytes for metadata operations FileSystemId B
MetadataReadIOBytes_Sum Total bytes for metadata read operations FileSystemId B
MetadataWriteIOBytes_Sum Total bytes for metadata write operations FileSystemId B
MeteredIOBytes_Sum Total metered bytes for file system operations FileSystemId B
PercentIOLimit_Average Shows how close the file system is to the I/O limit in General Purpose performance mode FileSystemId percent
PermittedThroughput_Average Maximum throughput the file system can deliver FileSystemId B/S
TotalIOBytes_Sum Total bytes for file system I/O operations FileSystemId B

Objects

The collected AWS Elastic File System object data has the following structure. View object data under 「Infrastructure - Resource Catalog」.

{
  "measurement": "aws_efs",
  "tags": {
    "OwnerId"                    : "876267738xxxx",
    "FileSystemId"               : "fs-03babd100fxxxxxxx",
    "FileSystemArn"              : "arn:aws:elasticfilesystem:ap-southeast-1:876267738534:file-system/fs-xxx",
    "LifeCycleState"             : "available",
    "PerformanceMode"            : "generalPurpose",
    "KmsKeyId"                   : "arn:aws:kms:ap-southeast-1:876267738534:key/0dd81bcb-d916xxxxx",
    "ThroughputMode"             : "elastic",
    "AvailabilityZoneName"       : "xxxxxxx",
    "AvailabilityZoneId"         : "xxxxxxx",
    "State"                      : "xxxxxxx"

  },
  "fields": {
    "NumberOfMountTargets"                    : "3",
    "CreationTime"                            : "2025/07/18 17:23:04",
    "Encrypted"                               : "True",
    "ProvisionedThroughputInMibps"            : "xxxxxx"
  }
}

Note: Fields in tags and fields may change in future updates.

Feedback

Is this page helpful?