new module nginx_status_facts (#3286)

* new module nginx_status_facts

* nginx_status_facts: remove requirement

* nginx_status_facts: implement timeout param

* nginx_status_facts: update example docs

lib/ansible/modules/extras/web_infrastructure/nginx_status_facts.py

@@ -0,0 +1,160 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+#
+# (c) 2016, René Moser <mail@renemoser.net>
+#
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
+
+DOCUMENTATION = '''
+---
+module: nginx_status_facts
+short_description: Retrieve nginx status facts.
+description:
+  - Gathers facts from nginx from an URL having C(stub_status) enabled.
+version_added: "2.3"
+author: "René Moser (@resmo)"
+options:
+  url:
+    description:
+      - URL of the nginx status.
+    required: true
+  timeout:
+    description:
+      - HTTP connection timeout in seconds.
+    required: false
+    default: 10
+
+notes:
+  - See http://nginx.org/en/docs/http/ngx_http_stub_status_module.html for more information.
+'''
+
+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 = '''
+---
+nginx_status_facts.active_connections:
+  description: Active connections.
+  returned: success
+  type: int
+  sample: 2340
+nginx_status_facts.accepts:
+  description: The total number of accepted client connections.
+  returned: success
+  type: int
+  sample: 81769947
+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
+  type: int
+  sample: 81769947
+nginx_status_facts.requests:
+  description: The total number of client requests.
+  returned: success
+  type: int
+  sample: 144332345
+nginx_status_facts.reading:
+  description: The current number of connections where nginx is reading the request header.
+  returned: success
+  type: int
+  sample: 0
+nginx_status_facts.writing:
+  description: The current number of connections where nginx is writing the response back to the client.
+  returned: success
+  type: int
+  sample: 241
+nginx_status_facts.waiting:
+  description: The current number of idle client connections waiting for a request.
+  returned: success
+  type: int
+  sample: 2092
+nginx_status_facts.data:
+  description: HTTP response as is.
+  returned: success
+  type: string
+  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
+
+
+class NginxStatusFacts(object):
+
+    def __init__(self):
+        self.url = module.params.get('url')
+        self.timeout = module.params.get('timeout')
+
+    def run(self):
+        result = {
+            'nginx_status_facts': {
+                '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 = response.read()
+        if not data:
+            return result
+
+        result['nginx_status_facts']['data'] = data
+        match = re.match(r'Active connections: ([0-9]+) \nserver accepts handled requests\n ([0-9]+) ([0-9]+) ([0-9]+) \nReading: ([0-9]+) Writing: ([0-9]+) Waiting: ([0-9]+)', data, re.S)
+        if match:
+            result['nginx_status_facts']['active_connections'] = int(match.group(1))
+            result['nginx_status_facts']['accepts'] = int(match.group(2))
+            result['nginx_status_facts']['handled'] = int(match.group(3))
+            result['nginx_status_facts']['requests'] = int(match.group(4))
+            result['nginx_status_facts']['reading'] = int(match.group(5))
+            result['nginx_status_facts']['writing'] = int(match.group(6))
+            result['nginx_status_facts']['waiting'] = int(match.group(7))
+        return result
+
+def main():
+    global module
+    module = AnsibleModule(
+        argument_spec=dict(
+            url=dict(required=True),
+            timeout=dict(type='int', default=10),
+        ),
+        supports_check_mode=True,
+    )
+
+    nginx_status_facts = NginxStatusFacts().run()
+    result = dict(changed=False, ansible_facts=nginx_status_facts)
+    module.exit_json(**result)
+
+if __name__ == '__main__':
+    main()