Collector 'AWS-ElastiCache' Configuration Manual¶

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the 'Integration Core Package' and its corresponding 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 collect data from
`regions[#]`	str	Required	Region ID. For example: `'cn-north-1'` Refer to the appendix for the complete list

2. Configuration Example¶

Specify Regions¶

Collect instance data from Ningxia and Beijing regions

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

3. Data Reporting Format¶

After successful data synchronization, you can view the data in the 'Infrastructure-Resource Catalog' of TrueWatch.

Example of reported data:

{
  "measurement": "aws_elasticache",
  "tags": {
    "name"                     : "test",
    "CacheClusterId"           : "test",
    "CacheNodeType"            : "cache.t3.small",
    "Engine"                   : "redis",
    "EngineVersion"            : "6.2.5",
    "CacheClusterStatus"       : " available",
    "PreferredAvailabilityZone": "cn-northwest-1b",
    "ARN"                      : "arn:aws-cn:elasticache:cn-northwest-1:5881335135:cluster:test",
    "RegionId"                 : "cn-north-1"
  },
  "fields": {
    "SecurityGroups": "{Security Group JSON Data}}",
    "NumCacheNodes" : "1",
    "message"       : "{Instance JSON Data}"
  }
}

Note

Fields in tags and fields may change with subsequent updates

Tip

The value of tags.name is the instance ID, which serves as a unique identifier

Tip

fields.message, fields.network_interfaces, fields.blockdevicemappings are JSON serialized strings

4. IAM Policy Permissions¶

Note

If users collect resources using IAM roles, certain operational permissions need to be enabled

This collector requires the following operational permissions:

elasticache:DescribeCacheClusters

X. Appendix¶

Please refer to the AWS official documentation:

AWS Region IDs