Collector 'AWS-EFS' Configuration Manual¶

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the "Integration Core Package" and its associated third-party dependencies.

1. Configuration Structure¶

The configuration structure of this collector is as follows:

Field	Type	Required	Description
`regions`	list	Required	List of regions to be collected
`regions[#]`	str	Required	Region ID. For example: `'cn-north-1'` See appendix for the complete list

2. Configuration Example¶

Collect instance data from Ningxia and Beijing regions

collector_configs = {
    'regions': [ 'cn-northwest-1', 'cn-north-1' ]
}

3. Data Reporting Format¶

After data is successfully synchronized, you can view the data in the "Infrastructure-Resource Catalog" of TrueWatch.

An example of the reported data is as follows:

{
  "measurement": "aws_efs",
  "tags": {
    "name"           : "fs-01234567",
    "FileSystemId"   : "fs-01234567",
    "LifeCycleState" : "available",
    "FileSystemName" : "MyFileSystem",
    "OwnerId"        : "012345678912",
    "PerformanceMode": "generalPurpose",
    "RegionId"       : "cn-northwest-1",
    "OwnerId"        : "012345678912",
  },
  "fields": {
    "CreationTime"   : "2022-03-09T06:13:31Z",
    "CreationToken"  : "tokenstring",
    "SizeInBytes"    : "{'Value': 6144,}",
  }
}

Note

The fields in tags and fields may change with subsequent updates.

4. IAM Policy Permissions¶

Note

If users collect resources using the IAM role method, certain operation permissions need to be enabled.

This collector requires the following permissions:

elasticfilesystem:DescribeFileSystems

X. Appendix¶

Please refer to the AWS official documentation: