Skip to content

Collector Configuration Manual for "Alibaba Cloud - VPN"

Before reading this article, please first read:

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

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'
Refer to the appendix for the complete list

2. Configuration Example

Specifying Regions

Collect data from Hangzhou and Shanghai regions

Python
1
2
3
collector_configs = {
    'regions': [ 'cn-hangzhou', 'cn-shanghai' ]
}

3. Data Reporting Format

After the data is synchronized successfully, you can view it in the "Infrastructure - Resource Catalog" section of {{( brand_name }}}.

An example of the reported data is as follows:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "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"   : "{JSON instance data}"
  }
}

The fields in tags and fields may change with subsequent updates

The value of tags.name is the instance ID, used as a unique identifier. The value of fields.message is a string serialized in JSON format

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

X. Appendix

Please refer to the official Alibaba Cloud documentation: