Merge lp:~verterok/charms/trusty/telegraf/apache-support into lp:~ubuntuone-hackers/charms/trusty/telegraf/trunk

[Guillermo Gonzalez]

Add apache input support via relation

Add apache input support via relation

[Bret Barker (noise)]

+1

Discussed having a good way to know if mod status isn't disabled and thus not going to get apache metrics.

review: Approve

=== modified file 'README.md'
--- README.md	2016-04-01 14:10:11 +0000
+++ README.md	2016-04-22 15:53:25 +0000
@@ -22,8 +22,6 @@
 
 By default there is no output plugin configured, but a basic set of input plugins are setup, which can be overriden with inputs_config charm config.
 
-The only output plugin supported via relation is influxdb, any other output plugin needs to be configured manually (via juju set)
-
 To configure any of the (default or via relation) plugins, the extra_options charm config can be used. It's string in yaml format, for example: 
 
     inputs:
@@ -46,6 +44,14 @@
 
 This extra options will only be applied to plugins defined in templates/base_inputs.conf and any other plugins configured via relations.
 
+## Apache input
+
+For the apache input plugin, the charm provides the apache relation which uses apache-website interface. Current apache charm disables mod_status  and in order to telegraf apache input to work 'status' should be removed from the list of disable_modules in the apache charm config.
+
+## Output 
+
+The only output plugin supported via relation is influxdb, any other output plugin needs to be configured manually (via juju set)
+
 To use a different metrics storage, e.g: graphite. the plugin configuration needs to be set as a base64 string in outputs_config configuration.
 
 For exmaple, save the following config to a file: 

=== modified file 'hooks/actions.py'
--- hooks/actions.py	2016-04-18 16:08:00 +0000
+++ hooks/actions.py	2016-04-22 15:53:25 +0000
@@ -170,7 +170,7 @@
     return json_vals
 
 
-def render_extra_options(kind, name):
+def render_extra_options(kind, name, extra_options=None):
     template = """
   {% if extra_options %}
   {% for key, value in extra_options.items() %}
@@ -188,7 +188,8 @@
   {% endfor %}
   {% endif %}
   """
-    extra_options = get_extra_options()
+    if extra_options is None:
+        extra_options = get_extra_options()
     context = {"extra_options": extra_options[kind].get(name, {}),
                "kind": kind,
                "name": name}
@@ -243,7 +244,6 @@
             addresses.append(address)
     config_path = '{}/{}.conf'.format(CONFIG_DIR, 'memcached')
     if addresses:
-        extra_options = get_extra_options()
         context = {"servers": json.dumps(addresses)}
         inputs.append(render_template(template, context) + \
                       render_extra_options("inputs", "memcached"))
@@ -271,7 +271,6 @@
         mongo_addresses.append(mongo_address)
     config_path = '{}/{}.conf'.format(CONFIG_DIR, 'mongodb')
     if mongo_addresses:
-        extra_options = get_extra_options()
         context = {"servers": json.dumps(mongo_addresses)}
         inputs.append(render_template(template, context) + \
                       render_extra_options("inputs", "mongodb"))
@@ -288,7 +287,6 @@
 """
     required_keys = ['host', 'user', 'password', 'database']
     rels = hookenv.relations_of_type('postgresql')
-    extra_options = get_extra_options()
     inputs = []
     for rel in rels:
         if all([rel.get(key) for key in required_keys]) \
@@ -342,6 +340,39 @@
         os.unlink(config_path)
 
 
+def apache_input(service_name):
+    template = """
+[[inputs.apache]]
+  urls = {{ urls }}
+"""
+    config_path = '{}/{}.conf'.format(CONFIG_DIR, 'apache')
+    port = '8080'
+    vhost = render(source='apache-server-status.tmpl',
+                   target=None,
+                   context={'port': port})
+    relation_info = {"ports": port,
+                     "domain": "apache-status",
+                     "enabled": True,
+                     "site_config": vhost,
+                     "site_modules": "status"}
+    urls = []
+    rels = hookenv.relations_of_type('apache')
+    for rel in rels:
+        hookenv.relation_set(rel['__relid__'], relation_settings=relation_info)
+        addr = rel['private-address']
+        url = 'http://{}:{}/server-status?auto'.format(addr, port)
+        urls.append(url)
+    inputs = []
+    if urls:
+        context = {"urls": json.dumps(urls)}
+        inputs.append(render_template(template, context) + \
+                      render_extra_options("inputs", "apache"))
+        hookenv.log("Updating {} plugin config file".format('apache'))
+        host.write_file(config_path, '\n'.join(inputs))
+    elif os.path.exists(config_path):
+        os.unlink(config_path)
+
+
 def influxdb_api_output(service_name):
     required_keys = ['hostname', 'port', 'user', 'password']
     rels = hookenv.relations_of_type('influxdb-api')

=== added symlink 'hooks/apache-relation-joined'
=== target is u'hooks.py'
=== modified file 'hooks/services.py'
--- hooks/services.py	2016-04-05 14:07:17 +0000
+++ hooks/services.py	2016-04-22 15:53:25 +0000
@@ -22,6 +22,7 @@
                 actions.memcached_input,
                 actions.postgresql_input,
                 actions.haproxy_input,
+                actions.apache_input,
                 actions.influxdb_api_output,
                 actions.log_start,
             ],

=== modified file 'hooks/tests/test_actions.py'
--- hooks/tests/test_actions.py	2016-04-06 00:25:14 +0000
+++ hooks/tests/test_actions.py	2016-04-22 15:53:25 +0000
@@ -1,6 +1,7 @@
 """actions.py tests"""
 import os
 import getpass
+import json
 
 from functools import partial
 
@@ -15,8 +16,28 @@
     monkeypatch.setattr(actions.hookenv, 'charm_dir', lambda: charm_dir)
     return charm_dir
 
-
-def test_render_extra_options(monkeypatch):
[e-mail]()
+def config_dir(monkeypatch, tmpdir):
+    p = tmpdir.mkdir("configs")
+    monkeypatch.setattr(actions, 'CONFIG_DIR', p.strpath)
+    return p
+
+
[e-mail]()
+def host_write(monkeypatch):
+    user = getpass.getuser()
+    partial_write_file = partial(actions.host.write_file, owner=user, group=user)
+    monkeypatch.setattr(actions.host, 'write_file', partial_write_file)
+
+
[e-mail]()
+def config(monkeypatch):
+    config = {'extra_options': ''}
+    monkeypatch.setattr(actions.hookenv, 'config', lambda: config)
+    return config
+
+
+def test_render_extra_options(monkeypatch, config):
     extra_options = """
     inputs:
         test:
@@ -24,14 +45,29 @@
             string: 10s
             list: ["a", "b"]
 """
-    config = {'extra_options': extra_options}
-    monkeypatch.setattr(actions.hookenv, 'config', lambda: config)
+    config['extra_options'] = extra_options
     content = actions.render_extra_options('inputs', 'test')
     expected = """  boolean = true\n  list = ["a", "b"]\n  string = "10s"\n"""
     assert sorted(content.split()) == sorted(expected.split())
 
 
-def test_render_base_inputs(monkeypatch, charm_dir):
+def test_render_extra_options_override(monkeypatch, config):
+    extra_options = """
+    inputs:
+        test:
+            boolean: true
+            string: 10s
+            list: ["a", "b"]
+"""
+    config['extra_options'] = extra_options
+    # clone extra_options and use a modified version
+    options = {'inputs': {'test': {'string': json.dumps("20s")}}}
+    content = actions.render_extra_options('inputs', 'test', extra_options=options)
+    expected = """  string = "20s"\n"""
+    assert sorted(content.split()) == sorted(expected.split())
+
+
+def test_render_base_inputs(monkeypatch, charm_dir, config):
     base_inputs_opts = """
 inputs:
     cpu:
@@ -41,8 +77,7 @@
         tagpass:
             cpu: ["cpu0"]
 """
-    config = {'extra_options': base_inputs_opts}
-    monkeypatch.setattr(actions.hookenv, 'config', lambda: config)
+    config['extra_options'] = base_inputs_opts
     content = actions.render_base_inputs()
     expected = """
 # Read metrics about cpu usage
@@ -56,27 +91,36 @@
     assert content[:len(expected)] == expected
 
 
-def test_memcached_input(monkeypatch, charm_dir, tmpdir):
+def test_memcached_input(monkeypatch, charm_dir, config_dir, host_write, config):
     relations = [{'host': '1.2.3.4', 'port': 1234}]
     monkeypatch.setattr(actions.hookenv, 'relations_of_type', lambda n: relations)
-    p = tmpdir.mkdir("configs")
-    monkeypatch.setattr(actions, 'CONFIG_DIR', p.strpath)
-    config = {'extra_options': ''}
-    monkeypatch.setattr(actions.hookenv, 'config', lambda: config)
-    user = getpass.getuser()
-    partial_write_file = partial(actions.host.write_file, owner=user, group=user)
-    monkeypatch.setattr(actions.host, 'write_file', partial_write_file)
     actions.memcached_input('test')
     expected = """
 [[inputs.memcached]]
   servers = ["1.2.3.4:1234"]
 """
-    assert p.join('memcached.conf').read().strip() == expected.strip()
-
-def test_memcached_input_no_relations(monkeypatch, charm_dir, tmpdir):
-    relations = []
-    monkeypatch.setattr(actions.hookenv, 'relations_of_type', lambda n: relations)
-    p = tmpdir.mkdir("configs")
-    monkeypatch.setattr(actions, 'CONFIG_DIR', p.strpath)
-    actions.memcached_input('test')
-    assert not p.join('memcached.conf').exists()
+    assert config_dir.join('memcached.conf').read().strip() == expected.strip()
+
+def test_memcached_input_no_relations(monkeypatch, charm_dir, config_dir):
+    relations = []
+    monkeypatch.setattr(actions.hookenv, 'relations_of_type', lambda n: relations)
+    actions.memcached_input('test')
+    assert not config_dir.join('memcached.conf').exists()
+
+
+def test_apache_input(monkeypatch, charm_dir, config_dir, host_write, config):
+    relations = [{'__relid__': 'apache:0', 'private-address': '1.2.3.4'}]
+    monkeypatch.setattr(actions.hookenv, 'relations_of_type', lambda n: relations)
+    monkeypatch.setattr(actions.hookenv, 'relation_set', lambda *a, **kw: None)
+    actions.apache_input('test')
+    expected = """
+[[inputs.apache]]
+  urls = ["http://1.2.3.4:8080/server-status?auto"]
+"""
+    assert config_dir.join('apache.conf').read().strip() == expected.strip()
+
+def test_apache_input_no_relations(monkeypatch, charm_dir, config_dir):
+    relations = []
+    monkeypatch.setattr(actions.hookenv, 'relations_of_type', lambda n: relations)
+    actions.memcached_input('test')
+    assert not config_dir.join('apache.conf').exists()

=== modified file 'metadata.yaml'
--- metadata.yaml	2016-04-05 20:28:25 +0000
+++ metadata.yaml	2016-04-22 15:53:25 +0000
@@ -28,6 +28,9 @@
   haproxy: 
     interface: statistics
     scope: container
+  apache: 
+    interface: apache-website
+    scope: container
   influxdb-api:
     interface: influxdb-api
   juju-info:

=== added file 'templates/apache-server-status.tmpl'
--- templates/apache-server-status.tmpl	1970-01-01 00:00:00 +0000
+++ templates/apache-server-status.tmpl	2016-04-22 15:53:25 +0000
@@ -0,0 +1,16 @@
+<VirtualHost 127.0.0.1:8080>
+    ServerName 127.0.0.1
+    ServerAdmin webmaster@localhost
+    DocumentRoot /var/www/html
+    LogLevel info
+    ErrorLog ${APACHE_LOG_DIR}/server-status-error.log
+    CustomLog ${APACHE_LOG_DIR}/server-status-access.log combined
+
+    <Location /server-status>
+        SetHandler server-status
+        Order deny,allow
+        Deny from all
+        Allow from localhost
+    </Location>
+</VirtualHost>
+