stream_server_traffic_status_display_format
Директива `stream_server_traffic_status_display_format` задаёт формат ответа для отображения статуса трафика в stream-серверах NGINX.
Описание
Директива stream_server_traffic_status_display_format является частью модуля статуса трафика stream-сервера NGINX, который предоставляет статистику по трафику, обрабатываемому stream-серверами. Эта директива позволяет пользователю указать формат ответа, возвращаемого при запросе статуса трафика. Доступные форматы обычно включают JSON и HTML. Когда директива установлена на уровне server или location, она определяет, как будут отображаться метрики, что облегчает мониторинг и проведение health checks для балансировщиков нагрузки и других служб TCP/UDP.
Директива принимает один аргумент, определяющий формат вывода. Когда выполняется запрос к endpoint статуса трафика, NGINX извлекает метрики трафика из разделяемой памяти и форматирует их в соответствии с указанным аргументом. Система проверяет URI и убеждается, что это корректный GET-запрос, прежде чем продолжить обработку. Если указанный формат не распознан или при получении статистики происходит ошибка, клиенту возвращается соответствующий ответ об ошибке.
Правильная реализация этой директивы повышает наблюдаемость для администраторов, позволяя им быстро оценивать нагрузку и производительность своих stream-серверов. Настройка формата вывода помогает интегрировать эти данные с различными системами мониторинга или инструментами визуализации, делая этот механизм гибким вариантом для эффективного управления развертываниями NGINX.
Пример конфига
server {
listen 12345;
stream_server_traffic_status on;
stream_server_traffic_status_display_format json;
}Убедитесь, что вы задали правильную строку формата; распространённые форматы: 'json' и 'html'.
Помните, что если traffic status module не включён при компиляции NGINX, эта директива не будет работать.
Проверьте правильный контекст; эта директива должна использоваться только в блоках server или location.