Skip to content

docs: add access log metrics setup details to Agent docs #1520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
spencerugbo wants to merge 2 commits into
base: main
Choose a base branch
from
+17 −2
Draft

docs: add access log metrics setup details to Agent docs #1520

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31f97a4
docs: add access log metrics setup details to Agent docs
spencerugbo Dec 3, 2025
c2c9bce
docs: move doc changes to metrics page
spencerugbo Dec 3, 2025
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
16 changes: 15 additions & 1 deletion content/includes/use-cases/monitoring/enable-nginx-oss-stub-status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,18 @@ 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).
For more details, see the [NGINX Stub Status module documentation](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html).

{{<call-out "note" "Note: NGINX Open Source Metrics" >}} For collecting metrics from NGINX Open Source, ensure that following log format is used in the NGINX configuration:

```nginx
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" '
'"$http_user_agent" "$http_x_forwarded_for" '
'"$bytes_sent" "$request_length" "$request_time" '
'"$gzip_ratio" $server_protocol ';

access_log /var/log/nginx/access.log main;
```

{{</call-out>}}
3 changes: 2 additions & 1 deletion content/nginx-one-console/agent/configure-instances/configure-agent-features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,15 @@ Before you start, make sure that you have:
The following table lists the NGINX Agent features:

{{< table "features" >}}

| Feature Name | Description | Default |
| ------------------- | --------------------------------------------------------------------------- | ------- |
| configuration | Full read/write management of configurations, controlled by DataPlaneConfig ConfigMode. | On |
| certificates | Inclusion of public keys and other certificates in the configurations toggled by DataPlaneConfig CertMode | On |
| file-watcher | Monitoring of file changes in the allowed directories list and references from product configs. | On |
| metrics | Full metrics reporting. | On
| logs-nap | F5 WAF for NGINX logs. | On |

{{< /table >}}

## Configuration sources
Expand Down Expand Up @@ -86,4 +88,3 @@ Define features in the `nginx-agent.conf` file:
`sudo systemctl restart nginx-agent`

Once the steps have been completed, users will be able to view metrics data being sent but will not have the capability to push NGINX configuration changes.