community.general.nginx_status_facts (2.5.9) — module

Install collection

Install with ansible-galaxy collection install community.general:==2.5.9

Add to requirements.yml

  collections:
    - name: community.general
      version: 2.5.9

Description

Gathers facts from nginx from an URL having C(stub_status) enabled.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# Gather status facts from nginx on localhost
- name: Get current http stats
  community.general.nginx_status_facts:
    url: http://localhost/nginx_status

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

# 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

Inputs

    
url:
    description:
    - URL of the nginx status.
    required: true
    type: str

timeout:
    default: 10
    description:
    - HTTP connection timeout in seconds.
    required: false
    type: int

Outputs

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