diff --git a/content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.md b/content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.md index ae6e3438b..3bfbfc7c7 100644 --- a/content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.md +++ b/content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.md @@ -24,10 +24,4 @@ This configuration: - Allows requests only from `127.0.0.1` (localhost). - Blocks all other requests for security. -For more details, see the [NGINX Stub Status module documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html). - -After saving the changes, reload NGINX to apply the new configuration: - -```shell -nginx -s reload -``` +For more details, see the [NGINX Stub Status module documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html). \ No newline at end of file diff --git a/content/includes/use-cases/monitoring/enable-nginx-plus-status-zone-limited.md b/content/includes/use-cases/monitoring/enable-nginx-plus-status-zone-limited.md new file mode 100644 index 000000000..6dabb1a3b --- /dev/null +++ b/content/includes/use-cases/monitoring/enable-nginx-plus-status-zone-limited.md @@ -0,0 +1,22 @@ +--- +docs: +files: + - content/nginx-one/nginx-configs/metrics/enable-metrics.md +--- + +To make NGINX Plus metrics available on the NGINX One Console, you must enable shared memory zones for the virtual servers being monitored. Shared memory zones store configuration and runtime state information shared across NGINX worker processes. + +To display [HTTP]({{< ref "nginx/admin-guide/load-balancer/http-load-balancer.md" >}}) and [TCP]({{< ref "nginx/admin-guide/load-balancer/tcp-udp-load-balancer.md" >}}) servers in NGINX Console, one or more status_zone directives must be defined. The same zone name can be reused across multiple server blocks. + +Since [R19]({{< ref "nginx/releases.md#r19" >}}), you can apply the status_zone directive to location blocks, allowing statistics to be aggregated separately for servers and locations. + +```nginx +server { + # ... + status_zone status_page; + location / { + proxy_pass http://backend; + status_zone location_zone; + } +} +``` \ No newline at end of file diff --git a/content/nginx-one/nginx-configs/metrics/enable-metrics.md b/content/nginx-one/nginx-configs/metrics/enable-metrics.md index 02894c2c1..93fde0642 100644 --- a/content/nginx-one/nginx-configs/metrics/enable-metrics.md +++ b/content/nginx-one/nginx-configs/metrics/enable-metrics.md @@ -12,7 +12,11 @@ nd-content-type: tutorial nd-product: NGINX-One --- -The NGINX One Console dashboard relies on APIs for NGINX Plus and NGINX Open Source Stub Status to report traffic and system metrics. The following sections show you how to enable those metrics. +The NGINX One Console dashboard and metrics views present system metrics and detailed NGINX metrics gathered through the NGINX Plus API or the Stub Status API (for NGINX Open Source). + +To display metrics, complete the following steps: +1. Enable the API +2. Enable metric collection ## Enable NGINX Plus API and dashboard @@ -24,6 +28,16 @@ To enable the NGINX Plus API and dashboard with [Config Sync Groups]({{< ref "ng {{< include "use-cases/monitoring/enable-nginx-plus-api-with-config-sync-group.md" >}} -## Enable NGINX Open Source Stub Status API +## Enable NGINX Open Source Stub Status API {{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}} + +## Enable NGINX Plus Metric Collection + +{{< include "/use-cases/monitoring/enable-nginx-plus-status-zone-limited.md" >}} + +After saving the changes, reload NGINX to apply the new configuration: + +```shell +nginx -s reload +``` \ No newline at end of file diff --git a/content/nim/monitoring/overview-metrics.md b/content/nim/monitoring/overview-metrics.md index c60617579..cb1fe13e6 100644 --- a/content/nim/monitoring/overview-metrics.md +++ b/content/nim/monitoring/overview-metrics.md @@ -5,7 +5,7 @@ title: 'Overview: NGINX instance metrics' toc: true weight: 100 type: -- reference + - reference --- ## Overview @@ -38,6 +38,12 @@ NGINX Instance Manager stores historical data in an analytics database and appli {{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}} +After saving the changes, reload NGINX to apply the new configuration: + +```shell +nginx -s reload +``` + ### NGINX access log metrics Enable access logging to collect traffic metrics by parsing logs. Use the following log format: