Skip to content

Commit 6ba5508

Browse files
author
Matt Desmarais
committed
fix: update nginx console metric configs
1 parent d61ea82 commit 6ba5508

File tree

5 files changed

+47
-11
lines changed

5 files changed

+47
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ You may also find the [documentation folder](/documentation/) for the repository
2727
© [F5, Inc.](https://www.f5.com/) 2025
2828

2929
## Credits
30-
.
30+
3131
- [The Good Docs Project](https://www.thegooddocsproject.dev/), whose templates we've adapted for our use.

content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,4 @@ This configuration:
2424
- Allows requests only from `127.0.0.1` (localhost).
2525
- Blocks all other requests for security.
2626

27-
For more details, see the [NGINX Stub Status module documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html).
28-
29-
After saving the changes, reload NGINX to apply the new configuration:
30-
31-
```shell
32-
nginx -s reload
33-
```
27+
For more details, see the [NGINX Stub Status module documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html).
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
docs:
3+
files:
4+
- content/nginx-one/nginx-configs/metrics/enable-metrics.md
5+
---
6+
7+
To make NGINX Plus metrics available on the NGINX Console, shared memory zones must be enabled for the virtual servers being monitored. Shared memory zones store configuration and runtime state information shared across NGINX worker processes.
8+
9+
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.
10+
11+
Since [R19]({{< ref "nginx/releases.md#r19" >}}), the status_zone directive can also be applied to location blocks, allowing statistics to be aggregated separately for servers and locations.
12+
13+
```nginx
14+
server {
15+
# ...
16+
status_zone status_page;
17+
location / {
18+
proxy_pass http://backend;
19+
status_zone location_zone;
20+
}
21+
}
22+
```

content/nginx-one/nginx-configs/metrics/enable-metrics.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ nd-content-type: tutorial
1212
nd-product: NGINX-One
1313
---
1414

15-
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.
15+
The NGINX 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).
16+
17+
To display metrics, complete the following steps:
18+
1. Enable the API
19+
2. Enable metric collection
1620

1721
## Enable NGINX Plus API and dashboard
1822

@@ -24,6 +28,16 @@ To enable the NGINX Plus API and dashboard with [Config Sync Groups]({{< ref "ng
2428

2529
{{< include "use-cases/monitoring/enable-nginx-plus-api-with-config-sync-group.md" >}}
2630

27-
## Enable NGINX Open Source Stub Status API
31+
## Enable NGINX Open Source Stub Status API
2832

2933
{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}
34+
35+
## Enable NGINX Plus Metric Collection
36+
37+
{{< include "/use-cases/monitoring/enable-nginx-plus-status-zone-limited.md" >}}
38+
39+
After saving the changes, reload NGINX to apply the new configuration:
40+
41+
```shell
42+
nginx -s reload
43+
```

content/nim/monitoring/overview-metrics.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: 'Overview: NGINX instance metrics'
55
toc: true
66
weight: 100
77
type:
8-
- reference
8+
- reference
99
---
1010

1111
## Overview
@@ -38,6 +38,12 @@ NGINX Instance Manager stores historical data in an analytics database and appli
3838

3939
{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}
4040

41+
After saving the changes, reload NGINX to apply the new configuration:
42+
43+
```shell
44+
nginx -s reload
45+
```
46+
4147
### NGINX access log metrics
4248

4349
Enable access logging to collect traffic metrics by parsing logs. Use the following log format:

0 commit comments

Comments
 (0)