跳转至

采集器「腾讯云-Nat Gateway」配置手册

阅读本文前，请先阅读：

使用本采集器前，必须安装「观测云集成 Core 核心包」及其配套的第三方依赖包

1. 配置结构

本采集器配置结构如下：

字段 类型 是否必须 说明
regions list 必须 所需采集的地域列表
regions[#] str 必须 地域 ID。如：'ap-shanghai'
总表见附录

2. 配置示例

指定地域

采集上海、广州地域的数据

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

配置过滤器（可选项）

本采集器脚本支持用户自定义过滤器，让用户通过对象属性筛选出目标资源。过滤器函数返回值为 True｜False

  • True：目标资源需要被采集。
  • False 目标资源不需要被采集

支持筛选的对象属性：

属性 描述
NatGatewayId NAT 网关的 ID
NatGatewayName NAT 网关的名称
Zone NAT 网关所在的可用区
VpcId VPC 实例 ID
Python
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
# 示例：开启过滤器，根据对象的 NatGatewayId， NetworkState 属性过滤，配置格式如下：
# Instance filter

def filter_instance(instance):
    '''
    采集 NatGatewayId 为 nat-xxxxxxx, nat-yyyyyyy 的 NAT 网关实例
    '''
    nat_gateway_id = instance['NatGatewayId']
    if nat_gateway_id in ['nat-xxxxxxx', 'nat-yyyyyyy']:
        return True
    return False

from guance_integration__runner import Runner
import guance_tencentcloud_nat_gateway__main as main

@DFF.API('TencentCloud-Nat Gateway Collection', timeout=3600, fixed_crontab='*/15 * * * *')
def run():
    Runner(main.DataCollector(account, collector_configs, filters=[filter_instance])).run()

3. 数据上报格式

数据正常同步后，可以在观测云的「基础设施-资源目录」中查看数据。

上报的数据示例如下：

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
  "measurement": "tencentcloud_nat_gateway",
  "tags": {
    "name"               : "nat-xxxxxx",
    "RegionId"           : "ap-shanghai",
    "NatGatewayId"       : "ap-shanghai-1",
    "NatGatewayName"     : "xxxx",
    "Zone"               : "ap-nanjing-3",
  },
  "fields": {
    "State"                                  : "AVAILABLE",
    "NetworkState"                           : "AVAILABLE",
    "VpcId"                                  : "vpc-xxxxxx",
    "RestrictState"                          : "NORMAL",
    "CreatedTime"                            : "2024-06-13 16:04:12",
    "InternetMaxBandwidthOut"                : 10,
    "MaxConcurrentConnection"                : 1000000,
    "PublicIpAddressSet"                     : "{绑定 NAT 网关的公网 IP 对象数组}",
    "DestinationIpPortTranslationNatRuleSet" : "{NAT 网关的端口转发规则}",
    "DirectConnectGatewayIds"                : "{绑定的专线网关 ID}",
    "SecurityGroupSet"                       : "{NAT 网关绑定的安全组列表}",
    "SourceIpTranslationNatRuleSet"          : "{NAT 网关的 SNAT 转发规则}",
    "message"                                : "{实例 JSON 数据}"
  }
}

tags、fields 中的字段可能会随后续更新有所变动

tags.name 值为实例 ID，作为唯一标识

fields.message、fields.PublicIpAddressSet.DestinationIpPortTranslationNatRuleSet, fileds.DirectConnectGatewayIds、 fields.SecurityGroupSet、fields.SourceIpTranslationNatRuleSet 均为 JSON 序列化后字符串

X. 附录

请参考腾讯云官方文档：