Skip to content

Collector Configuration Manual for "Alibaba Cloud-NAT"

Before reading this, please refer to:

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 full 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 data synchronization is successful, you can view the data in the 'Metrics' section of TrueWatch.

Example of reported data:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "measurement": "aliyun_nat",
  "tags": {
    "name"              : "ngw-bp1b3urqh0t7xxxxx",
    "NatGatewayId"      : "ngw-bp1b3urqh0t7xxxxx",
    "instance_name"     : "Operator",
    "VpcId"             : "vpc-bp1l3jzwhv8cnu9p8u4yh",
    "Spec"              : "Small",
    "InstanceChargeType": "PrePaid",
    "RegionId"          : "cn-hangzhou",
    "BusinessStatus"    : "Normal"
  },
  "fields": {
    "CreationTime": "2021-01-27T06:15:48Z",
    "ExpiredTime" : "2022-04-27T16:00Z",
    "message"     : "{JSON instance data}"
  }
}

Fields in tags and fields may change with subsequent updates.

The value of tags.name is the ID of the NAT gateway, used as a unique identifier. The value of instance_name is the name of the NAT gateway. The value of BusinessStatus indicates the business status of the NAT gateway: Normal: normal; FinancialLocked: locked due to non-payment. The value of fields.message is a string serialized in JSON format.

X. Appendix

Please refer to the official Alibaba Cloud documentation: