Collector 'Alibaba Cloud-Redis' Configuration Manual¶

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the 'Integration Core Package' and its accompanying third-party dependency packages.

Tip

This collector supports collecting resources from three architecture types: standard, cluster, and read-write separation.

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-hangzhou'` See appendix for the complete list

2. Configuration Example¶

Specified Region¶

Collect data from Hangzhou and Shanghai regions.

collector_configs = {
    'regions': [ 'cn-hangzhou', 'cn-shanghai' ]
}

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": "aliyun_redis",
  "tags": {
    "name"            : "r-bp12xxxxxxx",
    "InstanceId"      : "r-bp12vxxxxxxxxx",
    "RegionId"        : "cn-hangzhou",
    "ZoneId"          : "cn-hangzhou-h",
    "InstanceClass"   : "redis.master.small.default",
    "EngineVersion"   : "5.0",
    "ChargeType"      : "PrePaid",
    "ConnectionDomain": "r-bp12vxxxxxxx.redis.rds.aliyuncs.com",
    "NetworkType"     : "VPC",
    "PrivateIp"       : "xxxxxx",
    "Port"            : "6379",
    "InstanceName"    : "xxx system",
    "InstanceType"    : "Redis",
    "InstanceStatus"  : "Normal",
    "ArchitectureType": "standard",
  },
  "fields": {
    "Tags"      : "[Tags set in the cloud console]",
    "Capacity"  : "1024",
    "EndTime"   : "2022-12-13T16:00:00Z",
    "CreateTime": "2021-01-11T09:35:51Z",
    "Accounts"  : "[{Account information JSON data}]",
    "message"   : "{Instance JSON data}"
  }
}

Note

The 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

tags.PrivateIp will not be returned if the instance's network type is classic network.

Tip

fields.message, fields.Tags, and fields.Accounts are JSON serialized strings.

X. Appendix¶

Please refer to the official Alibaba Cloud documentation:

Alibaba Cloud Redis Region ID