github.com/nginxinc/kubernetes-ingress@v1.12.5/docs-web/logging-and-monitoring/status-page.md (about)

     1  # Status Page
     2  
     3  NGINX comes with a status page that reports basic metrics about NGINX called the [stub status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html). NGINX Plus comes with a [dashboard](https://docs.nginx.com/nginx/admin-guide/monitoring/live-activity-monitoring/) that reports key load-balancing and performance metrics. This doc shows how to get access to the stub status/dashboard.
     4  
     5  ## Accessing Stub Status
     6  
     7  Prerequisites:
     8  1. The stub status is enabled by default. Ensure that the `nginx-status` [command-line argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments) is not set to false.
     9  1. The stub status is available on port 8080 by default. It is customizable by the `nginx-status-port` command-line argument. If yours is not on 8080, modify the kubectl proxy command below.
    10  
    11  To access the status:
    12  1. Use the `kubectl port-forward` command to forward connections to port 8080 on your local machine to port 8080 of an NGINX Ingress controller pod (replace `<nginx-ingress-pod>` with the actual name of a pod):.
    13      ```
    14      $ kubectl port-forward <nginx-ingress-pod> 8080:8080 --namespace=nginx-ingress
    15      ```
    16  1. Open your browser at [http://127.0.0.1:8080/stub_status](http://127.0.0.1:8080/stub_status) to access the status.
    17  
    18  If you want to access the stub status externally (without `kubectl port-forward`):
    19  1. Configure `-nginx-status-allow-cidrs` command-line argument with IPv4 IP/CIDR blocks for which you want to allow access to the status. By default, the access is allowed for `127.0.0.1`.
    20  1. Use the IP/port through which the Ingress Controller pod/pods are available to connect the stub status at the `/stub_status` path.
    21  
    22  ## Accessing Live Activity Monitoring Dashboard
    23  
    24  Prerequisites:
    25  1. The dashboard is enabled by default. Ensure that the `nginx-status` [command-line argument](/nginx-ingress-controller/configuration/global-configuration/command-line-arguments)is not set to false.
    26  1. The dashboard is available on port 8080 by default. It is customizable by the `nginx-status-port` command-line argument. If yours is not on 8080, modify the kubectl proxy command below.
    27  
    28  To access the dashboard:
    29  1. Use the `kubectl port-forward` command to forward connections to port 8080 on your local machine to port 8080 of an NGINX Plus Ingress controller pod (replace `<nginx-plus-ingress-pod>` with the actual name of a pod):
    30      ```
    31      $ kubectl port-forward <nginx-plus-ingress-pod> 8080:8080 --namespace=nginx-ingress
    32      ```
    33  1. Open your browser at http://127.0.0.1:8080/dashboard.html to access the dashboard.
    34  
    35  If you want to access the dashboard externally (without `kubectl port-forward`):
    36  1. Configure `-nginx-status-allow-cidrs` command-line argument with IPv4 IP/CIDR blocks for which you want to allow access to the dashboard. By default, the access is allowed for `127.0.0.1`.
    37  1. Use the IP/port through which the Ingress Controller pod/pods are available to connect the dashboard at the `/dashboard.html` path.
    38  
    39  **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: use the `/api` path. Note that the API is configured in the read-only mode.