Metrics catalog

F5 NGINXaaS for Google Cloud (NGINXaaS) provides a rich set of metrics that you can use to monitor the health and performance of your NGINXaaS deployment. This document provides a catalog of the metrics that are available for monitoring NGINXaaS for Google Cloud.

Available metrics

• Available metrics
• Metrics
  • NGINX config statistics
  • NGINX connections statistics
  • NGINX requests and response statistics
  • NGINX SSL statistics
  • NGINX cache statistics
  • NGINX worker statistics
  • NGINX upstream statistics
  • NGINX stream statistics

Metrics

The following metrics are reported by NGINXaaS for Google Cloud in Google Cloud Monitoring. The metrics are categorized by the namespace used in Google Cloud Monitoring. The labels allow you to filter or split your queries in Google Cloud Monitoring providing you with a granular view over the metrics reported.

NGINX config statistics

All NGINXaaS deployments collect these metrics automatically. No additional NGINX configuration is required.

NGINX connections statistics

All NGINXaaS deployments collect these metrics automatically. No additional NGINX configuration is required.

NGINX requests and response statistics

To collect these metrics, configure the status_zone directive in your NGINX configuration. Add a status_zone directive to your server or location blocks to enable zone-specific request and response tracking.

Example:

server {
    listen 80;
    status_zone my_server_zone;
    
    location / {
        proxy_pass http://backend;
    }
}

NGINX SSL statistics

NGINX automatically collects these metrics when you configure SSL/TLS in your NGINX deployment. To collect SSL metrics, configure SSL certificates and enable HTTPS listeners in your NGINX configuration.

Example:

server {
    listen 443 ssl;
    ssl_certificate /path/to/cert.pem;
    ssl_certificate_key /path/to/key.pem;
}

NGINX cache statistics

To collect cache metrics, configure caching in your NGINX configuration using the proxy_cache_path and proxy_cache directives.

Example:

http {
    proxy_cache_path /var/cache/nginx levels=1:2 keys_zone=my_cache:10m;
    
    server {
        location / {
            proxy_cache my_cache;
            proxy_pass http://backend;
        }
    }
}

NGINX memory statistics

These metrics track shared memory zone usage. NGINX automatically collects memory statistics when you configure zones using the status_zone directive or other directives that create shared memory zones.

NGINX upstream statistics

To collect upstream metrics, define upstream blocks in your NGINX configuration and reference them in your proxy configuration. Add zone directives to track upstream statistics.

Example:

upstream backend {
    zone backend_zone 64k;
    server 10.0.0.1:8080;
    server 10.0.0.2:8080;
}

server {
    status_zone my_server;
    location / {
        proxy_pass http://backend;
    }
}

NGINX stream statistics

To collect stream metrics, configure the stream context in your NGINX configuration and add status_zone directives to your stream servers.

Example:

stream {
    server {
        listen 12345;
        status_zone tcp_server;
        proxy_pass backend_stream;
    }
    
    upstream backend_stream {
        zone stream_backend 64k;
        server 10.0.0.1:12345;
    }
}