Volcengine NAT

Collect Volcengine NAT Metrics data

Configuration¶

Install Func¶

It is recommended to activate Guance integration - extension - DataFlux Func (Automata): all prerequisites are automatically installed. Please continue with the script installation.

If you deploy Func on your own, refer to Self-deploy Func

Install Script¶

Note: Please prepare a qualified Volcengine AK in advance (for simplicity, you can directly grant global read-only permission ReadOnlyAccess).

Log in to the Func console, click on [Script Market], enter the official script market, and search for: guance_volcengine_nat
After clicking [Install], input the corresponding parameters: Volcengine AK ID, AK Secret, and account name.
Click [Deploy Startup Script], the system will automatically create a Startup script set and configure the corresponding startup scripts automatically.
After enabling, you can see the corresponding automatic trigger configuration under "Manage / Automatic Trigger Configuration". Click [Execute] to immediately execute it without waiting for the scheduled time. Wait a moment, and you can view the execution task records and corresponding logs.

Verification¶

In "Manage / Automatic Trigger Configuration", confirm whether the corresponding tasks have the relevant automatic trigger configurations. You can also check the task records and logs to ensure there are no anomalies.
In Guance, under "Infrastructure - Resource Catalog", check if asset information exists.
In Guance, under "Metrics", check if there are corresponding monitoring data.

Metrics¶

After configuring Volcengine-NAT, the default Measurement set is as follows. More metrics can be collected through configuration. Volcengine Cloud Monitoring Metrics Details

The Volcengine Metrics set is under volcengine_VCM_NAT. Below is an explanation of related metrics.

`MetricName`	`Subnamespace`	Metric Name	MetricUnit	Dimension
`client_conns`	`client`	SNAT Concurrent Connections	Count	ResourceID,ClientIP
`client_cps`	`client`	SNAT New Connections per Second	Count/Second	ResourceID,Node
`client_out_bps`	`client`	SNAT Outbound Bandwidth	Bits/Second(SI)	ResourceID,Node
`client_in_bps`	`client`	SNAT Inbound Bandwidth	Bits/Second(SI)	ResourceID,Node
`client_out_bps_peak`	`client`	SNAT Outbound Bandwidth Peak	Bits/Second(SI)	ResourceID,Node
`client_in_bps_peak`	`client`	SNAT Inbound Bandwidth Peak	Bits/Second(SI)	ResourceID,Node
`cur_con_num`	`natgateway`	Concurrent Connections	Count	ResourceID
`cps`	`natgateway`	New Connections per Second	Count/Second	ResourceID
`cur_con_drop_num`	`natgateway`	Dropped Concurrent Connections Rate	Count/Second	ResourceID
`con_drop_per_sec`	`natgateway`	Dropped New Connections Rate	Count/Second	ResourceID
`max_con_use_percent`	`natgateway`	Connection Usage Percentage	Percent	ResourceID
`out_bytes`	`natgateway`	Outbound Traffic	Bytes(SI)	ResourceID
`out_bps`	`natgateway`	Outbound Bandwidth	Bits/Second(SI)	ResourceID
`out_packets`	`natgateway`	Outbound Packets	Count	ResourceID
`out_pps`	`natgateway`	Outbound Packet Rate	Packet/Second	ResourceID
`in_bytes`	`natgateway`	Inbound Traffic	Bytes(SI)	ResourceID
`in_bps`	`natgateway`	Inbound Bandwidth	Bits/Second(SI)	ResourceID
`in_packets`	`natgateway`	Inbound Packets	Count	ResourceID
`in_pps`	`natgateway`	Inbound Packet Rate	Packet/Second	ResourceID
`error_port_allocation_count`	`natgateway`	Failed Port Allocations	Count	ResourceID
`in_schedule_bps`	`natgateway`	Inbound Scheduling Bandwidth	Bits/Second(SI)	ResourceID
`out_schedule_bps`	`natgateway`	Outbound Scheduling Bandwidth	Bits/Second(SI)	ResourceID
`in_packets_drop`	`natgateway`	Inbound Speed-Limited Dropped Packets	Count	ResourceID
`out_packets_drop`	`natgateway`	Outbound Speed-Limited Dropped Packets	Count	ResourceID

Objects¶

The structure of collected Volcengine NAT object data can be viewed under "Infrastructure - Resource Catalog".

{
  "fields": {
    "CreationTime": "2024-04-08T14:01:10+08:00",
    "EipAddresses": "[Information about public IPs bound to the NAT gateway]",
    "DnatEntryIds": "{List of DNAT rule IDs}",
    "ExpiredTime": "",
    "Description": "",
    "SnatEntryIds": "{List of SNAT rule IDs}",
    "message": "{Instance JSON data}"
  },
  "measurement": "volcengine_nat",
  "tags": {
    "BillingType": "2",
    "BusinessStatus": "Normal",
    "EipAddresses": "{Information about public IPs bound to the NAT gateway}",
    "NatGatewayId": "ngw-xxx",
    "NatGatewayName": "xxx",
    "NetworkInterfaceId": "eni-xxx",
    "ProjectName": "default",
    "RegionId": "cn-shanghai",
    "Spec": "Small",
    "Status": "Available",
    "SubnetId": "subnet-xxx",
    "VpcId": "vpc-xxx",
    "ZoneId": "cn-shanghai-a",
    "name": "ngw-xxx"
  }
}

Note: Fields in tags, fields may change with subsequent updates.

Tip: The value of tags.name is the instance ID, used as a unique identifier. fields.message, fields.EipAddresses, fields.DnatEntryIds, fields.SnatEntryIds are all serialized JSON strings.