Skip to content

Commit 4438a0e

Browse files
committed
fix: minimize reference to metrics
1 parent e30b109 commit 4438a0e

File tree

2 files changed

+30
-4
lines changed

2 files changed

+30
-4
lines changed

content/includes/use-cases/monitoring/enable-nginx-plus-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
docs:
33
files:
44
- content/nim/monitoring/overview-metrics.md
5-
- content/nginx-one/getting-started.md
5+
<!-- - content/nginx-one/getting-started.md (temporarily disabled) -->
66
---
77

88
To collect comprehensive metrics for NGINX Plus--including bytes streamed, information about upstream systems and caches, and counts of all HTTP status codes--add the following to your NGINX Plus configuration file (for example, `/etc/nginx/nginx.conf` or an included file):

content/nginx-one/getting-started.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,17 +136,43 @@ If you followed the [Installation and upgrade](https://docs.nginx.com/nginx-agen
136136
137137
## Enable NGINX metrics reporting
138138
139-
In order for NGINX One Console to show specific traffic and system metrics, you need to enable the appropriate API on your NGINX data plane instances. The sections below provide step-by-step instructions for both NGINX Plus and NGINX Open Source (OSS).
139+
NGINX One Console dashboard relies on the NGINX Plus and NGINX Open Source Stub Status APIs to report traffic and system metrics. The following sections include instructions on how to enable those metrics.
140+
<!--
141+
In order for NGINX One Console to show specific traffic and system metrics, you need to enable the appropriate API on your NGINX data plane instances. The sections below provide step-by-step instructions for both NGINX Plus and NGINX Open Source (OSS). -->
140142
141143
### Enable NGINX Plus API
142144
143-
{{< include "/use-cases/monitoring/enable-nginx-plus-api.md" >}}
145+
<!-- {{< include "/use-cases/monitoring/enable-nginx-plus-api.md" >}} -->
146+
To collect metrics for NGINX Plus, add the following to your NGINX Plus configuration file:
147+
148+
```nginx
149+
# Enable the /api/ location with appropriate access control
150+
# to use the NGINX Plus API.
151+
#
152+
location /api/ {
153+
api write=on;
154+
allow 127.0.0.1;
155+
deny all;
156+
}
157+
```
158+
159+
This configuration:
160+
161+
- Enables the NGINX Plus API.
162+
- Allows requests only from `127.0.0.1` (localhost).
163+
- Blocks all other requests for security.
164+
165+
After saving the changes, reload NGINX to apply the new configuration:
166+
167+
```shell
168+
nginx -s reload
169+
```
144170
145171
### Enable NGINX Open Source Stub Status API
146172
147173
{{< include "/use-cases/monitoring/enable-nginx-oss-stub-status.md" >}}
148174
149-
---
175+
---
150176
151177
## View instance metrics with the NGINX One dashboard
152178

0 commit comments

Comments
 (0)