Metrics delivery sends base metrics to a Prometheus instance in your account. You can use these metrics to create custom dashboards and monitor your services.
Prerequisites
-
A gateway instance is created.
-
CloudMonitor CloudLens is activated. CloudMonitor CloudLens is activated automatically the first time you enable metrics delivery.
Enable metrics delivery
Cloud Native API Gateway is free of charge, but you are charged for Managed Service for Prometheus. Pricing details: billing overview.
Log on to the API Gateway console.
In the left-side navigation pane, click . In the top navigation bar, select a region.
-
On the Instance page, click the ID or name of the target instance. In the navigation pane on the left, click Parameters.
-
In the Observability Parameters section, click the
icon next to Metrics Delivery Configuration. In the Metrics Delivery Configuration panel, turn on Metrics Delivery. Review the Terms of Service and Billing Details, and then click OK.This activates CloudMonitor CloudLens and sends monitoring metrics to the Prometheus instance in your account. You are charged for the Prometheus instance on a pay-as-you-go basis.
-
Wait for resources to be created. After metrics delivery is enabled, the Prometheus instance ID appears on the console. Click the instance ID to open the Prometheus instance details page.
Metrics
Use these metrics to build custom Grafana dashboards.
|
Metric name |
Description |
Granularity |
|
envoy_http_downstream_cx_active |
Number of active connections from clients to the gateway. |
instance level |
|
envoy_http_downstream_cx_rx_bytes_total |
Total bytes received by the gateway. |
instance level |
|
envoy_http_downstream_cx_tx_bytes_total |
Total bytes sent by the gateway. |
instance level |
|
envoy_http_downstream_rq |
Number of active requests processed by the gateway. |
instance level |
|
envoy_http_downstream_rq_time_bucket |
A histogram of gateway response times used to calculate percentiles. |
instance level |
|
envoy_http_downstream_rq_time_count |
Total number of gateway responses. Used with the sum to calculate the average response time. |
instance level |
|
envoy_http_downstream_rq_time_sum |
Total gateway response time. Used with the count to calculate the average response time. |
instance level |
|
envoy_http_downstream_rq_total |
Total number of requests processed by the gateway. |
instance level |
|
envoy_listener_downstream_cx_destroy |
Number of destroyed downstream connections. |
instance level |
|
envoy_listener_downstream_cx_total |
Total number of downstream connections. |
instance level |
|
envoy_listener_ssl_connection_error |
Number of SSL connection errors. |
instance level |
|
envoy_listener_ssl_handshake |
Number of successful SSL handshakes. |
instance level |
|
envoy_listener_ssl_session_reused |
Number of reused SSL sessions. |
instance level |
|
envoy_cluster_membership_healthy |
Number of healthy endpoints in the backend service. |
service level |
|
envoy_cluster_upstream_cx_active |
Number of active upstream connections. |
service level |
|
envoy_cluster_upstream_cx_destroy |
Number of destroyed upstream connections. |
service level |
|
envoy_cluster_upstream_cx_total |
Total number of upstream connections. |
service level |
|
envoy_cluster_upstream_rq |
Number of active requests sent to the backend service. |
service level |
|
envoy_cluster_upstream_rq_time_bucket |
A histogram of backend service response times used to calculate percentiles. |
service level |
|
envoy_cluster_upstream_rq_time_count |
Total number of responses from the backend service. Used with the sum to calculate the average response time. |
service level |
|
envoy_cluster_upstream_rq_time_sum |
Total response time for the backend service. Used with the count to calculate the average response time. |
service level |
|
envoy_cluster_upstream_rq_timeout |
Number of timed-out requests to the backend service. |
service level |
|
envoy_cluster_upstream_rq_total |
Total number of requests to the backend service. |
service level |
|
envoy_vhost_route_upstream_rq |
Number of active requests to a specific route. |
route level |
|
envoy_vhost_route_upstream_rq_timeout |
Number of timed-out requests for a specific route. |
route level |
|
envoy_vhost_route_upstream_rq_time_bucket |
A histogram of route response times used to calculate percentiles. |
route level |
|
envoy_vhost_route_upstream_rq_time_count |
Total number of responses for a route. Used with the sum to calculate the average response time. |
route level |
|
envoy_vhost_route_upstream_rq_time_sum |
Total response time for a route. Used with the count to calculate the average response time. |
route level |