-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Expose NGINX Plus dashboard Problem: As a user, I want observability into the NGINX Plus configuration and metrics. Solution: By exposing the NGINX Plus dashboard, a user can easily visualize real-time metrics and information about the configuration. * Code review comments * Reapply allow/deny; fix image tag * Arch note
- Loading branch information
Showing
6 changed files
with
54 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: "NGINX Plus Dashboard" | ||
description: "Learn how to view the NGINX Plus dashboard to see real-time metrics." | ||
weight: 200 | ||
toc: true | ||
docs: "DOCS-000" | ||
--- | ||
|
||
{{<custom-styles>}} | ||
|
||
## Overview | ||
|
||
The NGINX Plus dashboard offers a real-time live activity monitoring interface that shows key load and performance metrics of your server infrastructure. The dashboard is enabled by default for NGINX Gateway Fabric deployments that use NGINX Plus as the data plane. The dashboard is available on port 8765. | ||
|
||
To access the dashboard: | ||
|
||
1. Use port-forwarding to forward connections to port 8765 on your local machine to port 8765 on the NGINX Gateway Fabric pod (replace `<nginx-gateway-fabric-pod>` with the actual name of the pod). | ||
|
||
```shell | ||
kubectl port-forward <nginx-gateway-fabric-pod> 8765:8765 -n nginx-gateway | ||
``` | ||
|
||
1. Open your browser to [http://127.0.0.1:8765/dashboard.html](http://127.0.0.1:8765/dashboard.html) to access the dashboard. | ||
|
||
The dashboard will look like this: | ||
|
||
{{<img src="img/nginx-plus-dashboard.png" alt="">}} | ||
|
||
|
||
{{< note >}}The [API](https://nginx.org/en/docs/http/ngx_http_api_module.html), which the dashboard uses to get the metrics, is also accessible using the `/api` path.{{< /note >}} |
4 changes: 2 additions & 2 deletions
4
site/content/how-to/monitoring/monitoring.md → site/content/how-to/monitoring/prometheus.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
title: "Troubleshooting" | ||
|
||
weight: 200 | ||
weight: 300 | ||
toc: true | ||
docs: "DOCS-000" | ||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.