Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
docs:
files:
- content/nginx-one/nginx-configs/metrics/enable-metrics.md
---

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.

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" >}}), the status_zone directive can also be applied 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;
}
}
```
18 changes: 16 additions & 2 deletions content/nginx-one/nginx-configs/metrics/enable-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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

Expand All @@ -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
```
8 changes: 7 additions & 1 deletion content/nim/monitoring/overview-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: 'Overview: NGINX instance metrics'
toc: true
weight: 100
type:
- reference
- reference
---

## Overview
Expand Down Expand Up @@ -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:
Expand Down
Loading