# Console Light Web Monitoring Panel Angie provides a wide range of possibilities to monitor its work; in addition to the [metrics](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#metrics) API and the [Prometheus](https://en.angie.software//angie/docs/configuration/modules/http/http_prometheus.md#http-prometheus) module, you can use a visual console that installs beside the server. ## Console Light Console Light is a lightweight, real-time activity monitoring interface that displays key server load and performance metrics. The console is based on the [API capabilities](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#http-api) of Angie; activity monitoring data is generated in real time. In addition, the console allows you to dynamically [modify](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-config) Angie configuration where the API itself provides this capability. Example of a deployed and configured console: [https://console.angie.software/](https://console.angie.software/) ## Version History | Version | Release Date | Changes | |-----------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 1.8.2 | 23.01.2026 | Fixed the link to Angie ADC documentation. | | 1.8.1 | 08.09.2025 | Fixed incorrect terms in Settings and tooltips. | | 1.8.0 | 03.07.2025 | Display of response time metrics
for proxied HTTP and TCP/UDP servers | | 1.7.2 | 07.04.2025 | Added "busy" option in filter controller on the HTTP/TCP/UDP Upstreams
pages. | | 1.7.1 | 04.04.2025 | Fixed incorrect values in the HTTP/Location Zones tables on the HTTP
Zones page. | | 1.7.0 | 02.04.2025 | - Display exact data volumes in bytes on mouse hover
- New `busy` status for upstream peers in the statistics API,
indicating that a peer has reached the limit configured by the `max_conns` parameter
- Fixed documentation links | | 1.6.1 | 27.01.2025 | - Fixed typos
- Fixed a development-time project build issue | | 1.6.0 | 23.01.2025 | - Internationalization support with available locales: `en`, `ru`.
- Sticky header feature added to the table component.
- Support for data measurement units in pebibytes (PiB).
- Fixed incorrect value counter in the [HTTP Upstreams](#console-http-upstreams-widget) widget on the main page.
- Default values are now correctly used on the [HTTP Upstreams](#console-http-upstreams-page) page in the response context. | | 1.5.0 | | Not publicly released. | | 1.4.0 | 08.08.2024 | Added monitoring status display in the website favicon. | | 1.3.0 | 28.04.2024 | Added the ability to set a server to the `draining` state
in the upstream context. | | 1.2.1 | 26.12.2023 | Added active health checks in the `Stream` context. | | 1.2.0 | 25.12.2023 | Added server editing in the `Stream` context. | ## Installation and Configuration Console Light is published as `angie-console-light` (Angie) and `angie-pro-console-light` (Angie PRO) packages in [our repositories](https://en.angie.software//angie/docs/installation/index.md#install-packages) and can be installed like any other package; alternatively, you can download the source code [from our website](https://download.angie.software/files/angie-console-light/) or [GitHub](https://github.com/webserver-llc/angie-console-light). After installation, configure the console by adding the following [location](https://en.angie.software//angie/docs/configuration/modules/http/index.md#location) inside a [server](https://en.angie.software//angie/docs/configuration/modules/http/index.md#server) block in the [server configuration](https://en.angie.software//angie/docs/configuration/configfile.md#configfile) (note the comments): ```nginx location /console/ { # Local access only allow 127.0.0.1; deny all; auto_redirect on; alias /usr/share/angie-console-light/html/; # FreeBSD only: # alias /usr/local/www/angie-console-light/html/; index index.html; location /console/api/ { api /status/; } # For editing features to work after authentication (PRO only) location /console/api/config/ { auth_basic "Protected site"; auth_basic_user_file conf/htpasswd; api /config/; } } ``` Don't forget to apply the modified configuration: ```console $ sudo angie -t && sudo service angie reload ``` After this, the console will be available on the server specified by the `server` block, at the path specified for the `location`; in the example above, the path is set as `/console/`. Authentication can be enabled for any API section similar to the example above, for instance: ```nginx location /console/server_zones/ { auth_basic "Protected site"; auth_basic_user_file conf/htpasswd; } ``` You can also restrict access to any section of the configured console `location`, for example: ```nginx location /console/api/resolvers/ { deny all; } ``` ## Interface The console is a single screen with a set of tabs, each containing several widgets with monitoring data. ### Angie Tab ![Console Light - main screen](../../_images/console_light/en/main.png)
This is the main tab where the key Angie monitoring indicators are displayed in summary form, based on data from several API sections. #### NOTE Statistics widgets are displayed if the corresponding blocks are configured in the [Angie configuration](https://en.angie.software//angie/docs/configuration/configfile.md#configfile). #### About Widget Displays the Angie version number with a link to the corresponding documentation, as well as the server address and the time of the last [configuration reload](https://en.angie.software//angie/docs/configuration/runtime.md#control-config-change). Additionally, if the [api_config_files](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#a-api-config-files) directive is enabled, the *Configs* link opens a list of configuration files loaded on the server. Each file can then be viewed in a compact format with syntax highlighting. #### Connections Widget Displays basic server connection statistics, generated from the `/status/connections/` API section: | `Current` | Current number of connections | |--------------|-------------------------------------------| | `Accepted/s` | Number of connections accepted per second | | `Active` | Number of active connections | | `Idle` | Number of idle connections | | `Dropped` | Number of dropped connections | Also available: | `Accepted` | Total number of connections accepted since the last server reload | |--------------|---------------------------------------------------------------------| #### HTTP Zones Widget #### WARNING Requires setting the [status_zone](https://en.angie.software//angie/docs/configuration/modules/http/index.md#status-zone) directive in a `server` or `location` context. Displays shared memory zone statistics for the `http` context, generated from the [/status/http/server_zones/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-server-zones) API section: | `Total` | Total number of zones | |------------|--------------------------------------------| | `Problems` | Number of zones with any issues | | `Traffic` | Total incoming and outgoing traffic volume | #### HTTP Upstreams Widget #### WARNING Requires setting the [zone](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-zone) directive in an [upstream](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-upstream) block in the `http` context. Displays upstream statistics for the `http` context, generated from the [/status/http/upstreams/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-upstreams) API section: | Total | Total number of upstreams | |----------|----------------------------------------| | Problems | Number of upstreams with any issues | | Servers | Server statistics broken down by state | #### TCP/UDP Zones Widget #### WARNING Requires setting the following directives: - `status_zone` in a [server](https://en.angie.software//angie/docs/configuration/modules/http/index.md#status-zone) or [stream](https://en.angie.software//angie/docs/configuration/modules/stream/index.md#s-status-zone) context; - `limit_conn` in a [server](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#limit-conn) or [stream](https://en.angie.software//angie/docs/configuration/modules/stream/stream_limit_conn.md#s-limit-conn) context; - [limit_conn_zone](https://en.angie.software//angie/docs/configuration/modules/http/http_limit_conn.md#limit-conn-zone) in the `stream` context. Example: ```nginx stream { # ... limit_conn_zone $connection zone=limit-conn-stream:10m; server { # ... limit_conn limit-conn-stream 1; status_zone foo; } } ``` Displays shared memory zone statistics for the `stream` context, generated from the [/status/stream/server_zones/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-stream-server-zones) API section: | Conn total | Total number of client connections | |--------------|--------------------------------------------| | Conn current | Current number of client connections | | Conn/s | Number of connections processed per second | #### TCP/UDP Upstreams Widget #### WARNING Requires setting the [zone](https://en.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-zone) directive in an [upstream](https://en.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-upstream) block in the `stream` context. Displays upstream statistics for the `stream` context, generated from the [/status/stream/upstreams/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-stream-upstreams) API section: | Total | Total number of upstreams | |----------|----------------------------------------| | Problems | Number of upstreams with any issues | | Servers | Server statistics broken down by state | ### HTTP Zones Tab #### WARNING Requires setting the [status_zone](https://en.angie.software//angie/docs/configuration/modules/http/index.md#status-zone) directive in a `server` or `location` context. #### Server Zones Section ![Console Light — "Server Zones" section on the "HTTP Zones" tab](../../_images/console_light/en/http-server-zones.png)
Summarizes shared memory zone monitoring statistics for the `server` context in `http`, generated from the [/status/http/server_zones/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-server-zones) API section. The following data is presented for each zone: | Zone | Zone name | |-----------|------------------------------------------------------------------------------------------------------------------------------------------| | Requests | Total number of requests and the number of requests per second | | Responses | Number of responses broken down by status codes,
as well as their total number | | Traffic | Outgoing and incoming traffic rates, as well as total volumes of outgoing
and incoming traffic | | SSL | Aggregate counts of: successful SSL handshakes; SSL session reuses;
SSL handshakes with expired timeout; unsuccessful SSL handshakes | #### Location Zones Section ![Console Light — "Location Zones" section on the "HTTP Zones" tab](../../_images/console_light/en/http-location-zones.png)
Summarizes shared memory zone monitoring statistics for the `location` context in `http`, generated from the [/status/http/location_zones/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-location-zones) API section. The following data is presented for each zone: | Zone | Zone name | |-----------|----------------------------------------------------------------------------------------------------| | Requests | Total number of requests and the number of requests per second | | Responses | Number of responses broken down by status codes,
as well as their total number | | Traffic | Outgoing and incoming traffic rates, as well as total volumes of outgoing
and incoming traffic | #### Connection Limit Zones (Limit Conn) Section ![Console Light — "Connection Limit Zones" section on the "HTTP Zones" tab](../../_images/console_light/en/http-limit-conn.png)
Displays statistics of `limit_conn` zones in the `http` context, generated from the [/status/http/limit_conns/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-limit-conns) API section. The following data is presented for each zone: | Zone | Zone name | |-----------|----------------------------------------------------------------------------------| | Passed | Total number of proxied connections | | Rejected | Total number of rejected connections | | Exhausted | Total number of connections dropped due to zone storage overflow | | Skipped | Total number of connections passed with a zero or greater than 255
bytes key | #### Request Limit Zones (Limit Req) Section ![Console Light — "Request Limit Zones" section on the "HTTP Zones" tab](../../_images/console_light/en/http-limit-req.png)
Displays statistics of `limit_reqs` zones in the `http` context, generated from the [/status/http/limit_reqs/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-limit-reqs) API section. The following data is presented for each zone: | Zone | Zone name | |-----------|----------------------------------------------------------------------------------| | Passed | Total number of proxied connections | | Delayed | Total number of delayed connections | | Rejected | Total number of rejected connections | | Exhausted | Total number of connections dropped due to zone storage overflow | | Skipped | Total number of connections passed with a zero or greater than 255
bytes key | ### HTTP Upstreams Tab ![Console Light — "HTTP Upstreams" tab](../../_images/console_light/en/http-upstreams.png)
#### WARNING Requires setting the [zone](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-zone) directive in an [upstream](https://en.angie.software//angie/docs/configuration/modules/http/http_upstream.md#u-upstream) block in the `http` context. This tab summarizes upstream monitoring statistics for the `http` context, generated from the [/status/http/upstreams/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-upstreams) API section. In debug mode, memory usage percentage is also displayed. - The Show upstreams list button toggles a brief list of upstreams with the number of problematic upstreams and peers. - The Failed only switch toggles the display mode for problematic upstreams statistics. - The edit button toggles the upstream editing interface. - The dropdown list on the right side of each upstream table allows you to filter servers in a specific state (Up, Failed, Checking, Down). For each upstream, in addition to its name and shared memory zone utilization ratio, the following data is presented: | Server | Names, downtimes, and weights of upstream servers | |-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Requests | Total number and processing rate of requests | | Responses | Number of responses broken down by status codes | | Connections | Number of active connections and their maximum limit, if set | | Traffic | Outgoing and incoming traffic rates, as well as total volumes of outgoing
and incoming traffic | | Server checks | Number of unsuccessful attempts to contact the server and the number of times
the server was considered unavailable (the `health` object in the API) | | Health monitors | Total number of server checks, number of
unsuccessful checks, and the time of the last check | | Response time | Time from the beginning of the request to sending the first byte of the response;
total time from the beginning of the request to completion of sending the entire response
(the `health` object in the API) | #### Editing upstreams In Angie PRO, there is an edit button next to each upstream; when clicked, it displays two more buttons: | `Edit selected` | Edit selected servers within an upstream. Allows you to
set the following parameters for all at once: `Weight`,
maximum connection limit (`Max_conns`), maximum failure
limit that marks a server as unavailable (`Max_fails`), time
window for counting failures for the maximum failure limit
(`Fail_timeout`), state (`active` – enabled,
`down` – disabled, or `draining` – only receives
requests from sessions previously bound through `sticky`).

You can also delete the selected servers here.

![Console Light — editing servers
on the "HTTP Upstreams" tab](../../_images/console_light/en/http_upstreams_edit_servers.png)


| |-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Add server` | Add a server to the upstream. Allows you to set the following parameters:
address, backup server or not, `Weight`, maximum connection
limit (`Max_conns`), maximum failure limit that marks a server
as unavailable (`Max_fails`), failure counting time
window (`Fail_timeout`), state (`active` – enabled,
`down` – disabled, or `draining` – only receives
requests from sessions previously bound through `sticky`).

![Console Light — adding a server
on the "HTTP Upstreams" tab](../../_images/console_light/en/http_upstreams_add_server.png)


| ### `TCP/UDP Zones` Tab #### WARNING Requires setting the following directives: - `status_zone` in a [server](https://en.angie.software//angie/docs/configuration/modules/http/index.md#status-zone) or [stream](https://en.angie.software//angie/docs/configuration/modules/stream/index.md#s-status-zone) context; - `limit_conn` in a [server](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#limit-conn) or [stream](https://en.angie.software//angie/docs/configuration/modules/stream/stream_limit_conn.md#s-limit-conn) context; - [limit_conn_zone](https://en.angie.software//angie/docs/configuration/modules/http/http_limit_conn.md#limit-conn-zone) in the `stream` context. Example: ```nginx stream { # ... limit_conn_zone $connection zone=limit-conn-stream:10m; server { # ... limit_conn limit-conn-stream 1; status_zone foo; } } ``` #### `TCP/UDP Zones` Section ![Console Light — "TCP/UDP Zones" tab](../../_images/console_light/en/stream-zones.png)
Summarizes shared memory zone monitoring statistics for the `server` context in `stream`, generated from the [/status/stream/server_zones/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-stream-server-zones) API section. The following data is presented for each zone: | `Zone` | Zone name | |---------------|-----------------------------------------------------------------------------------------------------| | `Connections` | Current and total number of connections, as well as the number of connections per
second | | `Sessions` | Number of sessions broken down by status codes,
as well as their total number | | `Traffic` | Outgoing and incoming traffic rates, as well as total volumes of outgoing
and incoming traffic | | `SSL` | Aggregate counts of: successful SSL handshakes; unsuccessful SSL handshakes;
SSL session reuses | #### `Connection Limit Zones (Limit Conn)` Section ![Console Light — "Connection Limit Zones" section on the "TCP/UDP Zones" tab](../../_images/console_light/en/stream-limit-conn.png)
Displays statistics of `limit_conn` zones in the `stream` context, generated from the [/status/stream/limit_conns/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-limit-conns) API section. The following data is presented for each zone: | `Zone` | Zone name | |-------------|----------------------------------------------------------------------------------| | `Passed` | Total number of proxied connections | | `Rejected` | Total number of rejected connections | | `Exhausted` | Total number of connections dropped due to zone storage overflow | | `Skipped` | Total number of connections passed with a zero or greater than 255
bytes key | ### `TCP/UDP Upstreams` Tab ![Console Light — "TCP/UDP Upstreams" tab](../../_images/console_light/en/stream-upstreams.png)
#### WARNING Requires setting the [zone](https://en.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-zone) directive in an [upstream](https://en.angie.software//angie/docs/configuration/modules/stream/stream_upstream.md#s-u-upstream) block in the `stream` context. This tab summarizes upstream monitoring statistics for the `stream` context, generated from the [/status/stream/upstreams/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-stream-upstreams) API section. In debug mode, memory usage percentage is also displayed. - The `Show upstreams list` button toggles the display of a brief list of upstreams with the number of problematic upstreams and peers. - The `Failed only` switch enables and disables the display mode for problematic upstreams statistics. - The edit button opens the `upstream editing` widget. - The dropdown list on the right side of each upstream table allows you to filter servers in a specific state (`Up`, `Failed`, `Checking`, `Down`). For each upstream, the following data is presented: | `Server` | Names, downtimes, and weights of upstream servers | |-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Connections` | Number of active connections and their maximum limit, if set | | `Traffic` | Outgoing and incoming traffic rates, as well as total volumes of outgoing and incoming traffic | | `Server checks` | Number of unsuccessful attempts to contact the server and the number of times
the server was considered unavailable (the `health` object in the API) | | `Health monitors` | Total number of server checks, number of
unsuccessful checks, and the time of the last check | | `Response time` | Time spent establishing a connection to the backend;
time from the beginning of the request to receiving the first byte of the response;
total time elapsed from the beginning of the request to receiving the last byte of the response
(the `health` object in the API) | #### Editing upstreams In Angie PRO, there is an edit button next to each upstream; when clicked, it displays two more buttons: | `Edit selected` | Edit selected servers within an upstream. Allows you to
set the following parameters for all at once: `Weight`,
maximum connection limit (`Max_conns`), maximum failure
limit that marks a server as unavailable (`Max_fails`), time
window for counting failures for the maximum failure limit
(`Fail_timeout`), state (`active` – enabled,
`down` – disabled, or `draining` – only receives
requests from sessions previously bound through `sticky`).

You can also delete the selected servers here.

![Console Light – editing servers
on the "TCP/UDP Upstreams" tab](../../_images/console_light/en/http_upstreams_edit_servers.png)


| |-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Add server` | Add a server to the upstream. Allows you to set the following parameters:
address, backup server or not, `Weight`, maximum connection
limit (`Max_conns`), maximum failure limit that marks a server
as unavailable (`Max_fails`), failure counting time
window (`Fail_timeout`), state (`active` – enabled,
`down` – disabled, or `draining` – only receives
requests from sessions previously bound through `sticky`).

![Console Light – adding a server
on the "TCP/UDP Upstreams" tab](../../_images/console_light/en/http_upstreams_add_server.png)


| ### `Caches` Tab ![Console Light – "Caches" tab](../../_images/console_light/en/caches.png)
#### WARNING Requires setting the [proxy_cache_path](https://en.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache-path) directive in the `http` context. This tab summarizes monitoring statistics for `proxy_cache` zones in the `http` context, generated from the [/status/http/caches/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-http-caches) API section. The following data is presented for each zone: | `Zone` | Zone name | |----------------|------------------------------------------------------------------------------------| | `State` | Cache state: cold (metadata being loaded into memory) or hot
(metadata loaded) | | `Memory usage` | Memory utilization ratio | | `Max size` | Maximum memory size | | `Used` | Used memory size | | `Disk usage` | Disk utilization ratio | | `Traffic` | Traffic served from cache, written to cache, and returned bypassing the cache | | `Hit ratio` | Cache hit ratio (ratio of traffic served from cache to
total volume) | If [sharding](https://en.angie.software//angie/docs/configuration/modules/http/http_proxy.md#proxy-cache) is enabled for a zone, it is shown as a dropdown list that lists individual shards: | `Path` | Shard path on disk | |--------------|------------------------------------------------------------------------------------| | `State` | Shard state: cold (metadata being loaded into memory) or hot
(metadata loaded) | | `Max size` | Maximum memory size | | `Used` | Used memory size | | `Disk usage` | Disk utilization ratio | ### `Shared Zones` Tab ![Console Light – "Shared Zones" tab](../../_images/console_light/en/shared_zones.png)
This tab summarizes monitoring statistics for **all** shared memory zones across all contexts. The following data is presented for each zone: | `Zone` | Zone name | |----------------------|---------------------------------------| | `Total memory pages` | Total number of memory pages | | `Used memory pages` | Number of memory pages used | | `Memory usage` | Memory utilization ratio for the zone | ### `DNS Resolvers` Tab ![Console Light – "Resolvers" tab](../../_images/console_light/en/resolvers.png)
#### WARNING Requires setting the [resolver](https://en.angie.software//angie/docs/configuration/modules/http/index.md#resolver) directive in the `http` context. This tab summarizes query statistics in DNS shared memory zones, generated from the [/status/resolvers/](https://en.angie.software//angie/docs/configuration/modules/http/http_api.md#api-status-resolvers) API section. The following data is presented for each zone: | `Zone` | Zone name | |-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Requests` | Number of A and AAAA, SRV, PTR type requests | | `Responses` | Number of responses broken down by corresponding codes
(`Success`, `Format error`, `Server failure`,
`Name error`, `Not implemented`,
`Refused` and others) | ### `Settings` Widget ![Console Light – "Settings" widget](../../_images/console_light/en/cog.png)
Allows you to configure general console parameters: - Data refresh rate. Default value – 1 sec. - Threshold ratio for `4xx` statuses. When the threshold is reached, "yellow" warnings appear in the corresponding sections related to server responses. Default value – 7%. - Time window for calculating the cache hit ratio. Default value – 300 sec. - Error threshold for the resolver. When the threshold is reached, the resolver will turn "red". Default value – 3%. - Console interface language. Available options: English and Russian. By default, the console language is selected based on the locale set in the browser. ### Console Control Panel On all tabs, in the middle of the left side of the page, there is a slide-out panel with two buttons ![Console Light – console control buttons on the "About" tab](../../_images/console_light/en/play.png). The top button pauses and resumes data updates from the API, while the bottom button allows you to update the data manually when updates are paused.