Веб-панель мониторинга Console Light#

Angie предоставляет широкий спектр возможностей мониторинга своей работы; помимо метрик в API и модуля Prometheus, можно использовать визуальную консоль, устанавливаемую в дополнение к серверу.

Console Light#

Console Light — это облегченный интерфейс мониторинга активности в реальном времени, который отображает ключевые показатели нагрузки и производительности сервера. Консоль основана на возможностях API-интерфейса Angie; данные мониторинга активности генерируются в реальном времени. Кроме того, консоль позволяет динамически изменять конфигурацию Angie там, где эту возможность предоставляет сам API.

Пример развернутой и настроенной консоли: https://console.angie.software/

История версий#

Версия	Дата выпуска	Изменения
1.6.1	27.01.2025	Исправлены опечатки Исправлена проблема, мешающая сборке проекта при разработке
1.6.0	23.01.2025	Поддержка интернационализации с доступными локалями: `en`, `ru`. Добавлена функция закрепленного заголовка в компоненте таблицы. Поддержка единиц измерения данных в пебибайтах (PiB). Исправлен некорректный счетчик значений в виджете HTTP-апстримы на главной странице. Теперь значения по умолчанию корректно используются на странице HTTP-апстримы в контексте ответа.
1.5.0		Не выпускалась публично.
1.4.0	08.08.2024	Добавлено отображение статуса мониторинга в фавиконке веб-сайта.
1.3.0	28.04.2024	Добавлена возможность перевода сервера в состояние `draining` в контексте группы проксируемых серверов.
1.2.1	26.12.2023	Добавлены активные проверки состояния в контексте `Stream`.
1.2.0	25.12.2023	Добавлено редактирование серверов в контексте `Stream`.

Установка и настройка#

Console Light публикуется в виде пакетов angie-console-light (Angie) и angie-pro-console-light (Angie PRO) в наших репозиториях и устанавливается так же, как и любой другой пакет; кроме того, можно скачать исходный код с нашего веб-сайта или GitHub.

После установки настройте консоль, добавив такой фрагмент location внутри блока server в файле конфигурации (обратите внимание на комментарии):

location /console/ {

    # Только локальный доступ
    allow 127.0.0.1;
    deny all;

    auto_redirect on;

    alias /usr/share/angie-console-light/html/;
    # Только во FreeBSD:
    # alias /usr/local/www/angie-console-light/html/;
    index index.html;

    location /console/api/ {
        api /status/;
    }

    # Чтобы после аутентификации работали функции редактирования (только PRO)
    location /console/api/config/ {

        auth_basic           "Защищенный сайт";
        auth_basic_user_file conf/htpasswd;

        api /config/;
    }
}

Не забудьте применить измененную конфигурацию:

$ sudo angie -t && sudo service angie reload

После этого консоль будет доступна на сервере, заданном блоком server, по указанному для location пути; выше путь задан как /console/.

Включить аутентификацию аналогично примеру выше можно для произвольного раздела API, например:

location /console/server_zones/ {
    auth_basic           "Защищенный сайт";
    auth_basic_user_file conf/htpasswd;
}

Можно также запретить доступ к произвольному разделу настроенного таким образом location для консоли, например:

location /console/api/resolvers/ {
    deny all;
}

Интерфейс#

Консоль представляет собой единый экран с набором вкладок, каждая из которых содержит ряд виджетов с данными мониторинга.

Подсказка

В разделах ниже описания элементов интерфейса даны в порядке слева направо.

Вкладка Angie#

Это основная вкладка, где в сводном виде отображаются основные показатели мониторинга Angie, сведенные на основе данных из нескольких разделов API.

Виджет Сведения#

Здесь выводится номер версии Angie со ссылкой на соответствующую документацию, а также адрес сервера и время последней перезагрузки конфигурации.

Кроме того, если включена директива api_config_files, ссылка Configs открывает список файлов конфигурации, загруженных на сервере. Затем каждый файл можно просмотреть в компактном виде с подсветкой синтаксиса.

Виджет Соединения#

Здесь представлена основная статистика серверных соединений, формируемая на основе раздела API /status/connections/:

`Текущие`	Текущее количество соединений
`Принято/сек.`	Число принимаемых за секунду соединений
`Активные`	Число активных соединений
`Простаивающие`	Число соединений в состоянии ожидания
`Сброшенные`	Количество сброшенных соединений

Также доступно:

Принято

Общее число соединений, принятых с последней перезагрузки сервера

Виджет HTTP-зоны#

Внимание

Требует задать директиву status_zone в контексте server или location.

Здесь представлена статистика зон разделяемой памяти контекста http, формируемая на основе раздела API /status/http/server_zones/:

`Всего`	Общее количество зон
`Проблем`	Количество зон с какими-либо проблемами
`Трафик`	Общий объем входящего и исходящего трафика

Виджет HTTP-апстримы#

Внимание

Требует задать директиву zone в блоке upstream в контексте http.

Здесь представлена статистика апстримов контекста http, формируемая на основе раздела API /status/http/upstreams/:

`Всего`	Общее количество апстримов
`Проблем`	Количество апстримов с какими-либо проблемами
`Серверы`	Статистика серверов с разделением по состоянию

Виджет TCP/UDP-зоны#

Внимание

Требует задать следующие директивы:

status_zone в контексте server или stream;
limit_conn в контексте server или stream;
limit_conn_zone в контексте stream.

Пример:

stream {

    # ...
    limit_conn_zone $connection zone=limit-conn-stream:10m;

    server {

        # ...
        limit_conn limit-conn-stream 1;
        status_zone foo;
    }
}

Здесь представлена статистика зон разделяемой памяти контекста stream, формируемая на основе раздела API /status/stream/server_zones/:

`Соед. всего`	Общее количество клиентских соединений
`Соед. текущих`	Текущее количество клиентских соединений
`Соед./сек.`	Количество обрабатываемых в секунду соединений

Виджет TCP/UDP-апстримы#

Внимание

Требует задать директиву zone в блоке upstream в контексте stream.

Здесь представлена статистика апстримов контекста stream, формируемая на основе раздела API /status/stream/upstreams/:

`Всего`	Общее количество апстримов
`Проблем`	Количество апстримов с какими-либо проблемами
`Серверы`	Статистика серверов с разделением по состоянию

Вкладка HTTP-зоны#

Внимание

Требует задать директиву status_zone в контексте server или location.

Раздел Серверные зоны#

Здесь в сводном виде отображается статистика мониторинга зон разделяемой памяти для контекста server в http, формируемая на основе раздела API /status/http/server_zones/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните стрелку рядом с пунктом `Зона`, чтобы отсортировать зоны по алфавиту или порядку в конфигурации.
`Запросы`	Общее количество запросов, а также число запросов в секунду
`Ответы`	Количество ответов с разбиением по кодам статуса, а также их общее количество
`Трафик`	Скорость исходящего и входящего трафика, а также общие объемы исходящего и входящего трафика
`SSL`	Суммарные показатели количества: успешных SSL-рукопожатий; повторных использований SSL-сессий; SSL-рукопожатий с истекшим таймаутом; неуспешных SSL-рукопожатий

Раздел Зоны путей (Location)#

Console Light — раздел "Зоны путей" на вкладке "HTTP-зоны"

Здесь в сводном виде отображается статистика мониторинга зон разделяемой памяти для контекста location в http, формируемая на основе раздела API /status/http/location_zones/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните стрелку рядом с пунктом `Зона`, чтобы отсортировать зоны по алфавиту или порядку в конфигурации.
`Запросы`	Общее количество запросов, а также число запросов в секунду
`Ответы`	Количество ответов с разбиением по кодам статуса, а также их общее количество
`Трафик`	Скорость исходящего и входящего трафика, а также общие объемы исходящего и входящего трафика

Раздел Зоны ограничения соединений (Limit Conn)#

Console Light — раздел "Зоны ограничения соединений" на вкладке "HTTP-зоны"

Здесь приведена статистика зон limit_conn в контексте http, формируемая на основе раздела API /status/http/limit_conns/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните значок рядом с пунктом `Зона`, чтобы открыть или закрыть график со следующими показателями.
`Передано`	Общее количество проксированных соединений
`Отклонено`	Общее количество сброшенных соединений
`Сброшено`	Общее количество соединений, сброшенных из-за переполнения хранилища зоны
`Пропущено`	Общее количество соединений, переданных с нулевым или превосходящим 255 байт ключом

Раздел Зоны ограничения запросов (Limit Req)#

Console Light — раздел "Зоны ограничения запросов" на вкладке "HTTP-зоны"

Здесь приведена статистика зон limit_reqs в контексте http, формируемая на основе раздела API /status/http/limit_reqs/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните значок рядом с пунктом `Зона`, чтобы открыть или закрыть график со следующими показателями.
`Передано`	Общее количество проксированных соединений
`Задержано`	Общее количество задержанных соединений
`Отклонено`	Общее количество сброшенных соединений
`Сброшено`	Общее количество соединений, сброшенных из-за переполнения хранилища зоны
`Пропущено`	Общее количество соединений, переданных с нулевым или превосходящим 255 байт ключом

Вкладка HTTP-апстримы#

Внимание

Требует задать директиву zone в блоке upstream в контексте http.

На этой вкладке в сводном виде отображается статистика мониторинга апстримов контекста http, формируемая на основе раздела API /status/http/upstreams/.

Кнопка Показать список апстримов переключает краткий список апстримов с указанием числа проблемных апстримов и пиров.
Переключатель Только проблемные переключает режим вывода статистики по проблемным апстримам.
Кнопка редактирования переключает интерфейс редактирования апстрима.
Раскрывающийся список с правой стороны таблицы каждого апстрима позволяет отфильтровать серверы в определенном состоянии (Активные, Проблемные, На проверке, Недоступные).

Для каждого апстрима, помимо имени и коэффициента использования зоны разделяемой памяти, представлены следующие данные:

`Сервер`	Имена, время простоя и веса серверов апстрима Подсказка Щелкните стрелку рядом с пунктом `Сервер`, чтобы отсортировать серверы по их состоянию или порядку в конфигурации.
`Запросы`	Общее количество и скорость обработки запросов
`Ответы`	Количество ответов с разбиением по кодам статуса
`Соединения`	Количество активных соединений и их максимальный предел, если он задан
`Трафик`	Скорость исходящего и входящего трафика, а также общие объемы исходящего и входящего трафика
`Проверки сервера`	Количество неуспешных обращений к серверу и число раз, когда сервер считался недоступным (объект `health` в API)
`Проверки работоспособности`	Общее количество проверок сервера, количество неуспешных проверок, а также время последней проверки

Редактирование апстримов#

В Angie PRO рядом с каждым апстримом есть кнопка редактирования; при нажатии она выводит еще две кнопки:

Редактировать выбранные

Редактирование выбранных серверов в составе апстрима. Позволяет одновременно задать для всех следующие параметры: Вес, максимальный предел соединений (Max_conns), максимальный предел сбоев, переводящий сервер в недоступные (Max_fails), временное окно подсчета сбоев для максимального предела сбоев (Fail_timeout), состояние (активный – включен, недоступный – выключен или разгружаемый – получает только запросы сессий, привязанных ранее через sticky).

Также здесь можно удалить выбранные серверы.

Console Light — редактирование серверов на вкладке "HTTP-апстримы"

Добавить сервер

Добавление сервера в апстрим. Позволяет задать следующие параметры: адрес, запасной сервер или нет, Вес, максимальный предел соединений (Max_conns), максимальный предел сбоев, переводящий сервер в недоступные (Max_fails), временное окно подсчета сбоев (Fail_timeout), состояние (активный – включен, недоступный – выключен или разгружаемый – получает только запросы сессий, привязанных ранее через sticky).

Console Light — добавление сервера на вкладке "HTTP-апстримы"

Вкладка TCP/UDP-зоны#

Внимание

Требует задать следующие директивы:

status_zone в контексте server или stream;
limit_conn в контексте server или stream;
limit_conn_zone в контексте stream.

Пример:

stream {

    # ...
    limit_conn_zone $connection zone=limit-conn-stream:10m;

    server {

        # ...
        limit_conn limit-conn-stream 1;
        status_zone foo;
    }
}

Раздел TCP/UDP-зоны#

Здесь в сводном виде отображается статистика мониторинга зон разделяемой памяти контекста server в stream, формируемая на основе раздела API /status/stream/server_zones/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны
`Соединения`	Текущее и общее количество соединений, а также число соединений в секунду
`Сессии`	Количество сессий с разбиением по кодам статуса, а также их общее число
`Трафик`	Скорость исходящего и входящего трафика, а также общие объемы исходящего и входящего трафика
`SSL`	Суммарные показатели количества: успешных SSL-рукопожатий; неуспешных SSL-рукопожатий; повторных использований SSL-сессий

Раздел Зоны ограничения соединений (Limit Conn)#

Console Light — раздел "Зоны ограничения соединений" на вкладке "TCP/UDP-зоны"

Здесь приведена статистика зон limit_conn в контексте stream, формируемая на основе раздела API /status/stream/limit_conns/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните значок рядом с пунктом `Зона`, чтобы открыть или закрыть график со следующими показателями.
`Передано`	Общее количество проксированных соединений
`Отклонено`	Общее количество сброшенных соединений
`Сброшено`	Общее количество соединений, сброшенных из-за переполнения хранилища зоны
`Пропущено`	Общее количество соединений, переданных с нулевым или превосходящим 255 байт ключом

Вкладка TCP/UDP-апстримы#

Внимание

Требует задать директиву zone в блоке upstream в контексте stream.

На этой вкладке в сводном виде отображается статистика мониторинга апстримов контекста stream, формируемая на основе раздела API /status/stream/upstreams/.

Кнопка Показать список апстримов переключает отображение краткого списка апстримов с указанием числа проблемных апстримов и пиров.
Переключатель Только проблемные включает и отключает режим вывода статистики по проблемным апстримам.
Кнопка редактирования открывает виджет редактирования апстрима.
Раскрывающийся список с правой стороны таблицы каждого апстрима позволяет отфильтровать серверы в определенном состоянии (Активные, Проблемные, На проверке, Недоступные).

Для каждого апстрима представлены следующие данные:

`Сервер`	Имена, время простоя и веса серверов апстрима Подсказка Щелкните стрелку рядом с пунктом `Сервер`, чтобы отсортировать серверы по их состоянию или порядку в конфигурации.
`Соединения`	Количество активных соединений и их максимальный предел, если он задан
`Трафик`	Скорость исходящего и входящего трафика, а также общие объемы исходящего и входящего трафика
`Проверки сервера`	Количество неуспешных обращений к серверу и число раз, когда сервер считался недоступным (объект `health` в API)

Редактирование апстримов#

В Angie PRO рядом с каждым апстримом есть кнопка редактирования; при нажатии она выводит еще две кнопки:

Редактировать выбранные

Редактирование выбранных серверов в составе апстрима. Позволяет одновременно задать для всех следующие параметры: Вес, максимальный предел соединений (Max_conns), максимальный предел сбоев, переводящий сервер в недоступные (Max_fails), временное окно подсчета сбоев для максимального предела сбоев (Fail_timeout), состояние (активный – включен, недоступный – выключен или разгружаемый – получает только запросы сессий, привязанных ранее через sticky).

Также здесь можно удалить выбранные серверы.

Console Light — редактирование серверов на вкладке "TCP/UDP-апстримы"

Добавить сервер

Добавление сервера в апстрим. Позволяет задать следующие параметры: адрес, запасной сервер или нет, Вес, максимальный предел соединений (Max_conns), максимальный предел сбоев, переводящий сервер в недоступные (Max_fails), временное окно подсчета сбоев (Fail_timeout), состояние (активный – включен, недоступный – выключен или разгружаемый – получает только запросы сессий, привязанных ранее через sticky).

Console Light — добавление сервера на вкладке "TCP/UDP-апстримы"

Вкладка Кэши#

Внимание

Требует задать директиву proxy_cache_path в контексте http.

На этой вкладке в сводном виде отображается статистика мониторинга зон proxy_cache контекста http, формируемая на основе раздела API /status/http/caches/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните значок рядом с пунктом `Зона`, чтобы открыть или закрыть списки шардов для всех зон, где они есть.
`Состояние`	Состояние кэша: холодный (метаданные загружаются в память) или горячий (метаданные загружены)
`Загрузка памяти`	Коэффициент использования памяти
`Макс. размер`	Максимальный объем памяти
`Использовано`	Использованный объем памяти
`Загрузка диска`	Коэффициент использования дисковой памяти
`Трафик`	Переданный из кэша, записанный в кэш и возвращенный в обход кэша трафик
`Коэффициент попадания`	Коэффициент попадания в кэш (отношение переданного из кэша трафика к общему объему)

Если для зоны включен шардинг, то она обозначена как раскрывающийся список, в котором перечислены отдельные шарды:

`Путь`	Путь шарда на диске
`Состояние`	Состояние шарда: холодный (метаданные загружаются в память) или горячий (метаданные загружены)
`Макс. размер`	Максимальный объем памяти
`Использовано`	Использованный объем памяти
`Загрузка диска`	Коэффициент использования дисковой памяти

Вкладка Общие зоны#

На этой вкладке в сводном виде отображается статистика мониторинга всех зон разделяемой памяти для всех контекстов. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните стрелку рядом с пунктом `Зона`, чтобы отсортировать зоны по размеру или порядку в конфигурации.
`Всего страниц памяти`	Общее количество страниц памяти
`Использовано страниц памяти`	Количество используемых страниц памяти
`Загрузка памяти`	Коэффициент использования памяти для зоны

Вкладка DNS-резолверы#

Внимание

Требует задать директиву resolver в контексте http.

На этой вкладке в сводном виде отображается статистика запросов в зонах разделяемой памяти DNS, формируемая на основе раздела API /status/resolvers/. Для каждой зоны представлены следующие данные:

`Зона`	Имя зоны Подсказка Щелкните стрелку рядом с пунктом `Зона`, чтобы отсортировать зоны по состоянию или порядку в конфигурации.
`Запросы`	Количество запросов типа A и AAAA, SRV, PTR
`Ответы`	Количество ответов с разделением по соответствующим кодам (`Успешные`, `Ошибок формата`, `Сервер не завершил запрос`, `Ошибок имени`, `Запрос не поддерживается`, `Запрос отклонен` и прочих)

Виджет Настройки#

Позволяет настроить общие параметры консоли:

Частоту обновления данных. Значение по умолчанию — 1 сек.
Пороговое соотношение статусов 4xx. По достижении порога в соответствующих разделах, посвященных ответам сервера, появляются "желтые" предупреждения. Значение по умолчанию — 7%.
Временное окно для вычисления соотношения успешных попаданий в кэш. Значение по умолчанию — 300 сек.
Порог учета ошибок для резолвера. По достижении указанного порога резолвер станет "красным". Значение по умолчанию — 3%.
Язык интерфейса консоли. Доступные варианты: английский (English) и русский. По умолчанию язык консоли выбирается на основе локали, установленной в браузере.

Панель управления консолью#

На всех вкладках в середине левой части страницы есть выдвигающаяся панель с двумя кнопками . Верхняя приостанавливает и вновь запускает обновление данных из API, а нижняя позволяет обновить данные вручную, когда обновление приостановлено.