echo_status

Директива `echo_status` выводит текущий статус обработки запроса в NGINX.

Синтаксисecho_status;
По умолчаниюnone
Контекстlocation, if in location
Аргументы1

Описание

Директива echo_status является компонентом модуля NGINX Echo, который позволяет разработчикам выводить отладочную информацию и сведения о статусе обработки во время обработки запроса. При вызове она отправляет клиенту текущий статус запроса, включая различные метрики задержки и информацию о состоянии. Это особенно полезно для мониторинга и диагностики во время разработки приложения, тестирования или в рабочей среде, если требуется отладка.

Эту директиву можно размещать внутри location blocks или условно в if statements внутри location, что обеспечивает гибкость в том, как и когда могут передаваться обновления статуса. Хотя у неё есть один аргумент, основная функция директивы — прозрачно выводить статусы, не влияя на основной поток приложения. Поскольку она работает с внутренними состояниями обработки запросов NGINX, предоставляемые значения могут дать представление о производительности и неэффективностях обработки запросов.

Важно отметить, что интенсивное использование этой директивы в рабочей среде может привести к увеличению объёма логов, что при высокой нагрузке может незначительно повлиять на производительность.

Пример конфига

location /status {
    echo_status;
}

Размещение echo_status в неправильном контексте (например, вне блока location) приведёт к ошибке конфигурации.

Широкое использование этой директивы в производственной среде может привести к избыточному логированию, что может ухудшить производительность.

← Ко всем директивам