Skip to content

AWS EFS

Collect AWS Elastic File System Metrics

Configuration

Install Func

It is recommended to activate the TrueWatch Integration - Extensions - DataFlux Func (Automata): All prerequisites are automatically installed. Please proceed with the script installation.

If you are deploying Func manually, refer to Manual Func Deployment

Install Script

Note: Please prepare an Amazon AK that meets the requirements in advance (for simplicity, you can directly grant the global read-only permission ReadOnlyAccess)

Automata Script Activation

  1. Log in to the TrueWatch console
  2. Click on the 【Integration】 menu, select 【Cloud Account Management】
  3. Click on 【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
  4. Click on 【Test】, and after the test is successful, click on 【Save】. If the test fails, please check if the relevant configuration information is correct and test again
  5. Click on 【Cloud Account Management】, and you can see the added cloud account in the list. Click on the corresponding cloud account to enter the details page
  6. Click on the 【Integration】 button on the cloud account details page, and find AWS EFS under the Not Installed list. Click on the 【Install】 button, and the installation interface will pop up for installation.

Manual Script Activation

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

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

  3. Click on 【Deploy Startup Script】, the system will automatically create the Startup script set and automatically configure the corresponding startup script.

  4. After activation, you can see the corresponding automatic trigger configuration in 「Manage / Automatic Trigger Configuration」. Click on 【Execute】 to execute it immediately without waiting for the scheduled time. Wait for a moment, and you can view the execution task records and corresponding logs.

Verification

  1. In 「Manage / Automatic Trigger Configuration」, confirm whether the corresponding task has the corresponding automatic trigger configuration, and you can also check the corresponding task records and logs to see if there are any exceptions
  2. In TrueWatch, check if there is asset information in 「Infrastructure - Resource Catalog」
  3. In TrueWatch, check if there is corresponding monitoring data in 「Metrics」

Metrics

Configure Amazon CloudWatch to collect more metrics Amazon CloudWatch Metrics Details

AWS Elastic File System metrics are under the aws_AWS/EFS Measurement, and the description column includes the description, unit, and statistical data of each metric.

Metric Description Unit
ClientConnections The number of client connections to the file system Count
DataReadIOBytes The actual number of bytes read by each file system read operation Bytes
DataWriteIOBytes The actual number of bytes written by each file system write operation Bytes
MetadataIOBytes The actual number of bytes for each metadata operation Bytes
MetadataReadIOBytes The actual number of bytes read for each metadata read operation Bytes
MetadataWriteIOBytes The actual number of bytes written for each metadata write operation Bytes
MeteredIOBytes The metered number of bytes for each file system operation Bytes
PercentIOLimit Shows how close the file system is to the I/O limit of the general purpose performance mode %
PermittedThroughput The maximum throughput that the file system can drive Bytes/s
TotalIOBytes The number of bytes transferred by IO operations Bytes

Object

The collected AWS Elastic File System object data structure can be seen in 「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: The fields in tags and fields may change with subsequent updates