nginx_status_facts - Retrieve nginx status facts.

New in version 2.3.

Synopsis
Options
Examples
Return Values
Notes
- Status

Synopsis

Gathers facts from nginx from an URL having stub_status enabled.

Options

parameter	required	default	choices	comments
timeout	no	10		HTTP connection timeout in seconds.
url	yes			URL of the nginx status.

Examples

# Gather status facts from nginx on localhost
- name: get current http stats
  nginx_status_facts:
    url: http://localhost/nginx_status

# Gather status facts from nginx on localhost with a custom timeout of 20 seconds
- name: get current http stats
  nginx_status_facts:
    url: http://localhost/nginx_status
    timeout: 20

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
nginx_status_facts.accepts	The total number of accepted client connections.	success	int	81769947
nginx_status_facts.active_connections	Active connections.	success	int	2340
nginx_status_facts.data	HTTP response as is.	success	string	Active connections: 2340 server accepts handled requests 81769947 81769947 144332345 Reading: 0 Writing: 241 Waiting: 2092
nginx_status_facts.handled	The total number of handled connections. Generally, the parameter value is the same as accepts unless some resource limits have been reached.	success	int	81769947
nginx_status_facts.reading	The current number of connections where nginx is reading the request header.	success	int	0
nginx_status_facts.requests	The total number of client requests.	success	int	144332345
nginx_status_facts.waiting	The current number of idle client connections waiting for a request.	success	int	2092
nginx_status_facts.writing	The current number of connections where nginx is writing the response back to the client.	success	int	241

Notes

Note

See http://nginx.org/en/docs/http/ngx_http_stub_status_module.html for more information.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nginx_status_facts_module.html