1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/modules/web_infrastructure/nginx_status_info.py
patchback[bot] 0d598c3542
Fix more copyright lines, add more default copyright lines () ()
* Fix copyright lines.

* Add default copyright line.

(cherry picked from commit 424d706f92)

Co-authored-by: Felix Fontein <felix@fontein.de>
2022-08-08 15:19:46 +02:00

156 lines
4.5 KiB
Python

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright (c) 2016, René Moser <mail@renemoser.net>
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
module: nginx_status_info
short_description: Retrieve information on nginx status.
description:
- Gathers information from nginx from an URL having C(stub_status) enabled.
author: "René Moser (@resmo)"
options:
url:
type: str
description:
- URL of the nginx status.
required: true
timeout:
type: int
description:
- HTTP connection timeout in seconds.
required: false
default: 10
notes:
- See U(http://nginx.org/en/docs/http/ngx_http_stub_status_module.html) for more information.
'''
EXAMPLES = r'''
# 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
'''
RETURN = r'''
---
active_connections:
description: Active connections.
returned: success
type: int
sample: 2340
accepts:
description: The total number of accepted client connections.
returned: success
type: int
sample: 81769947
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
type: int
sample: 81769947
requests:
description: The total number of client requests.
returned: success
type: int
sample: 144332345
reading:
description: The current number of connections where nginx is reading the request header.
returned: success
type: int
sample: 0
writing:
description: The current number of connections where nginx is writing the response back to the client.
returned: success
type: int
sample: 241
waiting:
description: The current number of idle client connections waiting for a request.
returned: success
type: int
sample: 2092
data:
description: HTTP response as is.
returned: success
type: str
sample: "Active connections: 2340 \nserver accepts handled requests\n 81769947 81769947 144332345 \nReading: 0 Writing: 241 Waiting: 2092 \n"
'''
import re
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils.urls import fetch_url
from ansible.module_utils.common.text.converters import to_text
class NginxStatusInfo(object):
def __init__(self):
self.url = module.params.get('url')
self.timeout = module.params.get('timeout')
def run(self):
result = {
'active_connections': None,
'accepts': None,
'handled': None,
'requests': None,
'reading': None,
'writing': None,
'waiting': None,
'data': None,
}
(response, info) = fetch_url(module=module, url=self.url, force=True, timeout=self.timeout)
if not response:
module.fail_json(msg="No valid or no response from url %s within %s seconds (timeout)" % (self.url, self.timeout))
data = to_text(response.read(), errors='surrogate_or_strict')
if not data:
return result
result['data'] = data
expr = r'Active connections: ([0-9]+) \nserver accepts handled requests\n ([0-9]+) ([0-9]+) ([0-9]+) \n' \
r'Reading: ([0-9]+) Writing: ([0-9]+) Waiting: ([0-9]+)'
match = re.match(expr, data, re.S)
if match:
result['active_connections'] = int(match.group(1))
result['accepts'] = int(match.group(2))
result['handled'] = int(match.group(3))
result['requests'] = int(match.group(4))
result['reading'] = int(match.group(5))
result['writing'] = int(match.group(6))
result['waiting'] = int(match.group(7))
return result
def main():
global module
module = AnsibleModule(
argument_spec=dict(
url=dict(type='str', required=True),
timeout=dict(type='int', default=10),
),
supports_check_mode=True,
)
nginx_status_info = NginxStatusInfo().run()
module.exit_json(changed=False, **nginx_status_info)
if __name__ == '__main__':
main()