Collector 'Alibaba Cloud-VPN' 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 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_vpn",
  "tags": {
    "name"            : "vpn-xxxx",
    "VpnGatewayId"    : "vpn-xxxx",
    "vpn_gateway_name": "DMS Test",
    "InternetIp"      : "47.xxxx",
    "RegionId"        : "cn-hangzhou",
    "VpcId"           : "vpc-xxxx",
    "BusinessStatus"  : "Normal"
  },
  "fields": {
    "CreateTime": 1650357175000,
    "EndTime"   : 1652976000000,
    "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, and fields.message is the JSON serialized string.

Tip

The value of tags.vpn_gateway_name is taken from the Name field returned by the Alibaba Cloud API, which is the name of the VPN gateway.

X. Appendix¶

Please refer to the official Alibaba Cloud documentation: