Collector 'Alibaba Cloud-NAT' Configuration Manual¶

Before reading this document, please read:

Cloud Integration

Tip

Before using this collector, you must install the 'Integration Core Package' and its corresponding 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 collect data from
`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 'Metrics' section of TrueWatch.

An example of the reported data is as follows:

{
  "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"     : "{Instance JSON Data}"
  }
}

Note

The fields in tags and fields may change with subsequent updates.

Tip

The value of tags.name is the ID of the NAT gateway, which serves as the unique identifier. The value of instance_name is the name of the NAT gateway. The value of BusinessStatus is the business status of the NAT gateway: Possible values: Normal: Normal; FinancialLocked: Locked due to overdue payment. The value of fields.message is a JSON serialized string.

X. Appendix¶

Please refer to the official Alibaba Cloud documentation: