Skip to content

Alibaba Cloud NLB

Collect monitoring data from Alibaba Cloud Network Load Balancer (NLB)

Configuration

Install Func

It is recommended to subscribe to the TrueWatch Integration - Extensions - DataFlux Func (Automata)

For self-deploying Func, refer to Self-deploying Func

Enable Script

Note: Please prepare the Alibaba Cloud AK that meets the requirements in advance (for simplicity, you can directly grant the global read-only permission ReadOnlyAccess)

Enable Script on DataFlux Func (Automata)

  1. Log in to the TrueWatch console.
  2. Click the [Integration] menu, select [Cloud Account Management].
  3. Click [Add Cloud Account], select [Alibaba Cloud], and fill in the required information on the interface. If you have already configured cloud account information before, ignore this step.
  4. Click [Test]. After the test is successful, click [Save]. If the test fails, please check whether the relevant configuration information is correct and test again.
  5. Click [Cloud Account Management]. You can see the added cloud account in the list. Click the corresponding cloud account to enter the details page.
  6. Click the [Integration] button on the cloud account details page. Under the Not Installed list, find Alibaba Cloud NLB, click the [Install] button, and install it in the pop-up installation interface.

Enable Script Manually

  1. Log in to the Func console, click [Script Market], enter the TrueWatch Script Market, and search for: integration_alibabacloud_nlb.

  2. Click [Install], then enter the corresponding parameters: Alibaba Cloud AK ID, AK Secret, and account name.

  3. Click [Deploy Startup Script]. The system will automatically create the Startup script set and automatically configure the corresponding startup script.

  4. After enabling, you can see the corresponding automatic trigger configuration in "Management / Automatic Trigger Configuration". Click [Execute] to execute it immediately once without waiting for the scheduled time. Wait a moment, and you can view the execution task records and corresponding logs.

Verification

  1. In "Management / Automatic Trigger Configuration", confirm whether the corresponding task has the corresponding automatic trigger configuration. At the same time, you can check the corresponding task records and logs to see if there are any exceptions.
  2. In TrueWatch, check in "Infrastructure / Custom" to see if there is asset information.
  3. In TrueWatch, check in "Metrics" to see if there is corresponding monitoring data.

Metrics

Network Load Balancer (NLB) metrics are under the aliyun_acs_nlb Measurement. Below are the metric details.

Metric Original Metric Description Unit Dimensions
active_connection ActiveConnection Active connections per second for the listener count userId,instanceId,listenerPort,listenerProtocol
drop_connection DropConnection Dropped connections per second for the listener count/s userId,instanceId,listenerPort,listenerProtocol
drop_packet_rx DropPacketRX Dropped inbound packets per second for the listener count/s userId,instanceId,listenerPort,listenerProtocol
drop_packet_tx DropPacketTX Dropped outbound packets per second for the listener count/s userId,instanceId,listenerPort,listenerProtocol
drop_traffic_rx DropTrafficRX Dropped inbound bits per second for the listener bit/s userId,instanceId,listenerPort,listenerProtocol
drop_traffic_tx DropTrafficTX Dropped outbound bits per second for the listener bit/s userId,instanceId,listenerPort,listenerProtocol
inactive_connection InactiveConnection Inactive connections for the listener count userId,instanceId,listenerPort,listenerProtocol
instance_active_connection InstanceActiveConnection Active connections per second for the instance count userId,instanceId
instance_drop_connection InstanceDropConnection Dropped connections per second for the instance count/s userId,instanceId
instance_drop_packet_rx InstanceDropPacketRX Dropped inbound packets per second for the instance count/s userId,instanceId
instance_drop_packet_tx InstanceDropPacketTX Dropped outbound packets per second for the instance count/s userId,instanceId
instance_drop_traffic_rx InstanceDropTrafficRX Dropped inbound bits per second for the instance count/s userId,instanceId
instance_drop_traffic_tx InstanceDropTrafficTX Dropped outbound bits per second for the instance count/s userId,instanceId
instance_inactive_connection InstanceInactiveConnection Inactive connections per second for the instance count/s userId,instanceId
instance_max_connection InstanceMaxConnection Maximum concurrent connections per second for the instance count/s userId,instanceId
instance_new_connection InstanceNewConnection New connections per second for the instance count/s userId,instanceId
instance_packet_rx InstancePacketRX Inbound packets per second for the instance count/s userId,instanceId
instance_packet_tx InstancePacketTX Outbound packets per second for the instance count/s userId,instanceId
instance_packet_rx InstanceTrafficRX Inbound bits per second for the instance bit/s userId,instanceId
instance_packet_tx InstanceTrafficTX Outbound bits per second for the instance bit/s userId,instanceId
instance_unhealthy_server_count InstanceUnhealthyServerCount Number of unhealthy backend ECS instances for instance health check count userId,instanceId
listener_heathy_server_count ListenerHeathyServerCount Number of healthy backend ECS instances for listener health check count userId,instanceId,listenerPort,listenerProtocol
listener_packet_rx_average ListenerPacketRX Inbound data packets per second for the listener count/s userId,instanceId,listenerPort,listenerProtocol
listener_packet_tx_average ListenerPacketTX Outbound data packets per second for the listener count/s userId,instanceId,listenerPort,listenerProtocol
listener_unhealthy_server_count ListenerUnhealthyServerCount Number of unhealthy backend ECS instances for listener health check count/s userId,instanceId,listenerPort,listenerProtocol
listener_packet_tx_average MaxConnection Maximum connections per second for the listener count/s userId,instanceId,listenerPort,listenerProtocol
listener_packet_tx_average NewConnection New connections per second for the listener count/s userId,instanceId,listenerPort,listenerProtocol
real_server_reset_packet RealServerResetPacket VIP server-side sent reset packets per second count/s userId,instanceId,vip
traffic_rxnew_average TrafficRXNew Inbound bits per second for the listener bit/s userId,instanceId,listenerPort,listenerProtocol
traffic_txnew_average TrafficTXNew Outbound bits per second for the listener bit/s userId,instanceId,listenerPort,listenerProtocol
vip_active_connection VipActiveConnection Active connections per second for the VIP bit/s userId,instanceId,vip
vip_client_reset_packet VipClientResetPacket VIP client-side sent reset packets per second count/s userId,instanceId,vip
vip_drop_connection VipDropConnection Dropped connections per second for the VIP count/s userId,instanceId,vip
vip_drop_packet_rx VipDropPacketRX Dropped inbound packets per second for the VIP count/s userId,instanceId,vip
vip_drop_packet_tx VipDropPacketTX Dropped outbound packets per second for the VIP count/s userId,instanceId,vip
vip_drop_traffic_rx VipDropTrafficRX Dropped inbound bits per second for the VIP bit/s userId,instanceId,vip
vip_drop_traffic_tx VipDropTrafficTX Dropped outbound bits per second for the VIP bit/s userId,instanceId,vip
vip_inactive_connection VipInactiveConnection Inactive connections for the VIP count userId,instanceId,vip
vip_max_connection VipMaxConnection Maximum concurrent connections per second for the VIP count/s userId,instanceId,vip
vip_packet_rx VipPacketRX Inbound packets per second for the VIP count/s userId,instanceId,vip
vip_packet_tx VipPacketTX Outbound packets per second for the VIP count/s userId,instanceId,vip
vip_traffic_rx VipTrafficRX Inbound bits per second for the VIP bit/s userId,instanceId,vip
vip_traffic_tx VipTrafficTX Outbound bits per second for the VIP bit/s userId,instanceId,vip

Object

The data structure of the collected Alibaba Cloud Network Load Balancer (NLB) object can be seen in "Infrastructure - Custom".

{
  "measurement": "aliyun_nlb",
  "tags": {
    "RegionId"                 : "cn-shenzhen",
    "ResourceGroupId"          : "xxxx3qbgfd23-asxab123",
    "LoadBalancerId"           : "xxxx3qbgfd23xxxxxxxxx",
    "LoadBalancerName"         : "test-zppp",
    "DNSName"                  : "xxxxxxxxx"
  },
  "fields": {
    "LoadBalancerStatus"               : "Active",
    "LoadBalancerBussinessStatus"      : "Active",
    "VpcId"                            : "xxxx3qbgfd23-asxab123",
    "CreateTime"                       : "2025-10-18T014:49:05Z",
    "ZoneMappings"                     : "{}",
    "SecurityGroupIds"                 : "2025-10-18T014:49:05Z",
    "LoadBalancerBillingConfig"        : "2025-10-18T014:49:05Z",
    "AddressIpVersion"                 : "x.x.x",
    "AddressType"                      : "internet",
    "Tags"                             : "{[json data]}"
  }
}

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