Collector Configuration Manual for Alibaba Cloud Tair¶

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

2. Configuration Example¶

Specifying Regions¶

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_tair",
  "tags": {
    "ArchitectureType"      : "cluster",
    "ChargeType"            : "PostPaid",
    "CreateTime"            : "2023-07-26T07:51:00Z",
    "EditionType"           : "Community",
    "EngineVersion"         : "5.0",
    "InstanceClass"         : "redis.logic.sharding.1g.2db.0rodb.4proxy.default",
    "InstanceId"            : "r-bp153nzuqbc1m4uvd0",
    "InstanceName"          : "redis",
    "InstanceStatus"        : "Normal",
    "InstanceType"          : "Redis",
    "NetworkType"           : "VPC",
    "NodeType"              : "double",
    "PackageType"           : "standard",
    "PrivateIp"             : "172.16.0.246",
    "RegionId"              : "cn-hangzhou",
    "ResourceGroupId"       : "rg-acfmv3ro3xnfwaa",
    "UserName"              : "r-bp153nzuqbc1m4uvd0",
    "VSwitchId"             : "vsw-bp10hgbody9mjgvt8rfxv",
    "VpcId"                 : "vpc-bp1uhj8mimgturv8c0gg6",
    "ZoneId"                : "cn-hangzhou-h",
    "cloud_provider"        : "aliyun",
    "name"                  : "r-bp153nzuqbc1m4uvd0"
  },
  "fields": {
    "Bandwidth"             : "96",
    "Capacity"              : "2048",
    "Config"                : "{json data}",
    "ConnectionDomain"      : "r-bp153nzuqbc1m4uvd0.redis.rds.aliyuncs.com",
    "Connections"           : "20000",
    "HasRenewChangeOrder"   : "False",
    "IsRds"                 : "True",
    "Port"                  : "6379",
    "QPS"                   : "200000",
  }
}

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

fields.message and fields.Config are both JSON serialized strings.

X. Appendix¶

Please refer to the official Alibaba Cloud documentation:

Alibaba Cloud Tair/Region Information