Skip to content

Alibaba Cloud Native API Gateway

Collect Alibaba Cloud Native API Gateway monitoring data

Configuration

Install Func

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

If deploying Func on your own, refer to Self-deployed Func

Activate Script

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

Activate 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], fill in the required information on the interface. If the cloud account information has been configured before, ignore this step.
  4. Click [Test]. After a successful test, 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 Native API Gateway, click the [Install] button, and install it in the pop-up installation interface.

Manually Activate Script

  1. Log in to the Func console, click [Script Market], enter the TrueWatch script market, search for: integration_alibabacloud_cnapigateway.

  2. After clicking [Install], 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 scripts.

  4. After activation, 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 whether asset information exists in "Infrastructure / Custom".
  3. In TrueWatch, check in "Metrics" whether there is corresponding monitoring data.

Metrics

Cloud Native API Gateway metrics are under the aliyun_acs_cnapigateway Measurement. The following are the metric details.

Metric Original Metric Description Unit Demissions
envoy_cpu_usage_rate EnvoyCpuUsageRate Gateway CPU usage rate % userId,instanceId
envoy_fs_read_bytes EnvoyFsReadBytes Disk Read load B/s userId,instanceId
envoy_fs_write_bytes EnvoyFsWriteBytes Disk Write load B/s userId,instanceId
envoy_memory_usage EnvoyMemoryUsage Memory load MiB userId,instanceId
envoy_memory_usage_rate EnvoyMemoryUsageRate Gateway memory usage rate % userId,instanceId
envoy_network_in_bytes EnvoyNetworkInBytes Network inbound IO load B/s userId,instanceId
envoy_network_out_bytes EnvoyNetworkOutBytes Network outbound IO load B/s userId,instanceId
ipv4_eip_rate_in_average Ipv4EipRateIn Public IPv4 inbound bandwidth bit/s userId,instanceId
ipv4_eip_rate_out_average Ipv4EipRateOut Public IPv4 outbound bandwidth bit/s userId,instanceId
ipv6_gateway_rate_in Ipv6GatewayRateIn Public IPv6 inbound bandwidth bit/s userId,instanceId
ipv6_gateway_rate_out Ipv6GatewayRateOut Public IPv6 inbound bandwidth bit/s userId,instanceId
slb_instance_traffic_rx_average SlbInstanceTrafficRX Private network inbound bandwidth bit/s userId,instanceId
slb_instance_traffic_tx_average SlbInstanceTrafficTX Private network outbound bandwidth bit/s userId,instanceId