Модуль community.general.nginx_status_info — получение информации о состоянии nginx

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать коллекцию в плейбуке, укажите: community.general.nginx_status_info.

Краткое описание
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Собирает информацию из nginx по URL, где включён stub_status.

Параметры

Параметр	Комментарии
timeout integer	Тайм-аут HTTP-подключения в секундах. По умолчанию: `10`
url string / обязательный	URL страницы состояния nginx.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

Дополнительные сведения см. на странице http://nginx.org/en/docs/http/ngx_http_stub_status_module.html.

Примеры

# Gather status info from nginx on localhost
- name: Get current http stats
  community.general.nginx_status_info:
    url: http://localhost/nginx_status
  register: result

# Gather status info from nginx on localhost with a custom timeout of 20 seconds
- name: Get current http stats
  community.general.nginx_status_info:
    url: http://localhost/nginx_status
    timeout: 20
  register: result

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
accepts integer	Общее количество принятых подключений клиентов. Возвращается: при успехе Пример: `81769947`
active_connections integer	Активные подключения. Возвращается: при успехе Пример: `2340`
data string	HTTP-ответ без изменений. Возвращается: при успехе Пример: `"Active connections: 2340 \nserver accepts handled requests\n 81769947 81769947 144332345 \nReading: 0 Writing: 241 Waiting: 2092 \n"`
handled integer	Общее количество обработанных подключений. Обычно значение параметра совпадает со значением accepts, если не были достигнуты ограничения ресурсов. Возвращается: при успехе Пример: `81769947`
reading integer	Текущее количество подключений, в рамках которых nginx считывает заголовок запроса. Возвращается: при успехе Пример: `0`
requests integer	Общее количество запросов клиентов. Возвращается: при успехе Пример: `144332345`
waiting integer	Текущее количество простаивающих подключений клиентов, ожидающих запроса. Возвращается: при успехе Пример: `2092`
writing integer	Текущее количество подключений, в рамках которых nginx отправляет ответ клиенту. Возвращается: при успехе Пример: `241`

Авторы

René Moser (@resmo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/nginx_status_info_module.html