community.general.nginx_status_facts – Retrieve nginx status facts.
community.general.nginx_status_facts – Retrieve nginx status facts.
Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.nginx_status_facts
.
DEPRECATED
- Removed in
- version 3.0.0
- Why
- Deprecated in favour of
_info
module. - Alternative
- Use community.general.nginx_status_info instead.
Synopsis
- Gathers facts from nginx from an URL having
stub_status
enabled.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
timeout integer |
Default: 10 |
HTTP connection timeout in seconds. |
url string / required |
URL of the nginx status. |
Notes
Examples
# Gather status facts from nginx on localhost
- name: Get current http stats
community.general.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
community.general.nginx_status_facts:
url: http://localhost/nginx_status
timeout: 20
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
nginx_status_facts.accepts integer |
success |
The total number of accepted client connections.
Sample: 81769947 |
nginx_status_facts.active_connections integer |
success |
Active connections.
Sample: 2340 |
nginx_status_facts.data string |
success |
HTTP response as is.
Sample: Active connections: 2340 server accepts handled requests 81769947 81769947 144332345 Reading: 0 Writing: 241 Waiting: 2092 |
nginx_status_facts.handled integer |
success |
The total number of handled connections. Generally, the parameter value is the same as accepts unless some resource limits have been reached.
Sample: 81769947 |
nginx_status_facts.reading integer |
success |
The current number of connections where nginx is reading the request header.
|
nginx_status_facts.requests integer |
success |
The total number of client requests.
Sample: 144332345 |
nginx_status_facts.waiting integer |
success |
The current number of idle client connections waiting for a request.
Sample: 2092 |
nginx_status_facts.writing integer |
success |
The current number of connections where nginx is writing the response back to the client.
Sample: 241 |
Status
- This module will be removed in version 3.0.0. [deprecated]
- For more information see DEPRECATED.
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/nginx_status_facts_module.html