Merge ~gtrkiller/charm-telegraf:master into charm-telegraf:master

[Franco Luciano Forneron Buschiazzo]

Bugfix for https://bugs.launchpad.net/charm-telegraf/+bug/1975689.

The whole address binding has been reworked. Now we can configure prometheus to bind to a network (and check if the unit's IP matches it), bind on a single IP or interface name.

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Tom Haddon (mthaddon)]

I don't think this models the behaviour we outlined in the spec, and is certainly missing a number of tests for that behaviour. The details of that behaviour are:

* Create a new configuration option called prometheus_output_bindaddresses.
* This new option would be a string variable that would accept:
** An IP and port (in the simple case where the operator knows there’s only ever going to be one instance) e.g. ‘10.1.5.23:1111’ or IPv6 equivalent.
** An IP range and port (in which case each unit would configure itself to listen on the IP that falls within that range. In case of more than one interface matching, or no interface matching, the charm would go into “blocked” status) e.g. ‘10.1.5.0/24:1111’ or IPv6 equivalent.
** An interface and port (in this case each unit would configure itself to listen on that interface only. If any unit didn’t have an interface of that name, the charm would go into “blocked” status) e.g. ‘eth1:1111’ (defaults to IPv4 if available, falls back to IPv6) or ‘ipv4:eth1:1111’ or ‘ipv6:eth1:1111’.
** A port on its own to specify listening on that port on all IPs - e.g. `:1111`.
* The charm would only accept one of the above types of strings as an option. Trying to set more than one (via comma-separation, for instance) would cause the charm to go into “blocked” status.
Assuming the configuration option matches one of the above options, and all instances of the application have a matching IP/interface the charm would configure each unit to bind only on that IP/interface and port for prometheus output.
* Any port defined here would override the port specified in the prometheus_output_port configuration option. We would update the description of that configuration option to mention that this option is deprecated, and we should log a warning in juju if anyone has this option set to anything other than “default”.
* At some point in the future we’d then update the charm to set it to blocked status if someone has this set to something other than “default” and then finally we’d remove this option altogether. These won’t be tackled as part of this charm change, however.

Can you take another look at this and make sure we're testing these different cases?

review: Needs Fixing

[Tom Haddon (mthaddon)]

Some comments inline

[Eric Chen (eric-chen)]

Mark WIP first until 2nd patch provided.

[Robert Gildein (rgildein)]

review: Needs Fixing

[Franco Luciano Forneron Buschiazzo (gtrkiller)]

Marking as needs review.

[Tom Haddon (mthaddon)]

Some comments inline.

Also, I feel like we could do with some more unit tests here. In each case we're just testing the `generate_prometheus_output_config` method with one interface that matches each use case. Can we have some tests where things don't match, or there are multiple interfaces so it's clear what happens in those cases? I think it's also worth testing some of the other methods you've added here, particularly `get_prometheus_bindaddress`.

[Franco Luciano Forneron Buschiazzo (gtrkiller)]

Sure! I'll add some more tests. Just ftr, get_prometheus_bindaddress already has a test for it :)

[Eric Chen (eric-chen)]

Mark this as WIP before the test are finished.

[Arturo Enrique Seijas Fernández (arturo-seijas)]

review: Needs Fixing

[Johann David Krister Andersson (jdkandersson)]

Added a few comments in line

review: Needs Fixing

[Robert Gildein (rgildein)]

Overall LGTM.

Can you fix lint tests [1] and rebase this on new master branch?

---
[1]: https://pastebin.ubuntu.com/

[Franco Luciano Forneron Buschiazzo (gtrkiller)]

> Overall LGTM.
>
> Can you fix lint tests [1] and rebase this on new master branch?
>
> ---
> [1]: https://pastebin.ubuntu.com/
The two lint linebreak errors left have a conflict and cannot be fixed for now. If I format the code with black, flake8 throws an error. If I fix flake8's error, then black wants to reformat the file.

[Franco Luciano Forneron Buschiazzo (gtrkiller)]

I'll add a comment to fix the conflict

[Franco Luciano Forneron Buschiazzo (gtrkiller)]

The master branch has been rebased and the comments for linting been made. Now we have 5 failing tests that have nothing to do with my changes, should I fix them?

[Johann David Krister Andersson (jdkandersson)]

review: Approve

[Robert Gildein (rgildein)]

LGTM

> I'll add a comment to fix the conflict

Using `# noqa: W503` is the best approach here.

> The master branch has been rebased and the comments for linting been made. Now we have 5 failing tests that have nothing to do with my changes, should I fix them?

We know about it and there is MP with fix for it, so you can ignore it.

review: Approve

[Eric Chen (eric-chen)]

Citeria to merge the PR

- All lint/unit/func test are pass (5 failing tests should have fixed by James Lin, if you still encounter it, please let me know)
- At least 2 approval. (it's okay now)
- All "Need Fixing" is gone, so, please Tom Haddon and Arturo Enrique Seijas Fernández review it again.

Thanks!

[Arturo Enrique Seijas Fernández (arturo-seijas)]

LGTM

review: Approve

[Tom Haddon (mthaddon)]

LGTM, thx. One minor comment about asking for the accepted values to be documented in the config description, but otherwise fine to go ahead from my perspective.

review: Approve

[Eric Chen (eric-chen)]

Franco, please provide the log of lint/unit/func test, then we can merge it.

review: Needs Information

[Eric Chen (eric-chen)]

I found there are inline comment from

Arturo Enrique Seijas Fernández
Johann David Krister Andersson

Please fix it too.

review: Needs Fixing

[Franco Luciano Forneron Buschiazzo (gtrkiller)]

> I found there are inline comment from
>
> Arturo Enrique Seijas Fernández
> Johann David Krister Andersson
>
> Please fix it too.

Their comments (and Tom's) have been addressed now

[Eric Chen (eric-chen)]

Great! The final thing:
Sorry that we don't integrate the Jenkins with charm-telegraf now, we will do it soon. Please provide the log of lint/unit/func test, then we can merge it. It's the last mile!

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:55aa1ffdc508a3032cd4d923587200bd0f3611ec
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/147/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/878/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1299/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/147//rebuild

review: Needs Fixing (continuous-integration)

[Robert Gildein (rgildein)]

The Jenkins is configured for charm-telegraf, but this MP was created
in times when Jenkins was out of duty. So I triggered the tests manually.

[Franco Luciano Forneron Buschiazzo (gtrkiller)]

> Great! The final thing:
> Sorry that we don't integrate the Jenkins with charm-telegraf now, we will do
> it soon. Please provide the log of lint/unit/func test, then we can merge it.
> It's the last mile!

The linting is OK now, the unit tests have the same 5 errors (ignored) that I had when I tested the original master branch and then rebased. The func tests cannot be triggered with tox -e func apparently, so we may want to update that (or if it should be triggered on a certain way idk of, please tell me)

https://pastebin.canonical.com/p/685jHyPyvD/

[Eric Chen (eric-chen)]

Hi Franco,

The lint/unit/func are all pass in
https://code.launchpad.net/~rgildein/charm-telegraf/+git/charm-telegraf/+merge/429255

So I think you can pass all of them too. If you need help, you can contact Robert. You can also retrigger the build again too.

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/147//rebuild

review: Needs Fixing

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:55aa1ffdc508a3032cd4d923587200bd0f3611ec
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/148/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/881/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1302/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/148//rebuild

review: Needs Fixing (continuous-integration)

[Tom Haddon (mthaddon)]

> Hi Franco,
>
> The lint/unit/func are all pass in
> https://code.launchpad.net/~rgildein/charm-telegraf/+git/charm-
> telegraf/+merge/429255
>
> So I think you can pass all of them too. If you need help, you can contact
> Robert. You can also retrigger the build again too.
>
> Click here to trigger a rebuild:
> https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/147//rebuild

I triggered a rebuild here https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/881/console but that now seems to have pulled in pyproject-flake8==5.0.4 rather than pyproject-flake8==0.0.1a5 which was used for previous runs, and the test output is now reporting hundreds of docstring and line too long errors. Can you advise what approach you'd like Franco to take here? Should he pin the version of pyproject-flake8 or take some other approach?

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:38064851f26964566827453ff44b8089da818df0
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/149/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/882/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1303/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/149//rebuild

review: Needs Fixing (continuous-integration)

[Robert Gildein (rgildein)]

Hi Tom, you started the rebuild, but on the old commit. I tried to
rebuilt it again on the last commit here but failed with same error.
I proposed new MP [1], which fixes this [2].

---
[1]: https://code.launchpad.net/~rgildein/charm-telegraf/+git/charm-telegraf/+merge/429753
[2]: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/884/console

[Eric Chen (eric-chen)]

1. There is merge conflict, please check my inline comment
2. MP[1] is merged. Please rebase to the lastest and trigger Jenkins CI .
I hope we can merge this time.
thanks!

[1]: https://code.launchpad.net/~rgildein/charm-telegraf/+git/charm-telegraf/+merge/429753

review: Needs Fixing

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:38064851f26964566827453ff44b8089da818df0
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/153/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/887/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1307/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/153//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

FAILED: Continuous integration, rev:38064851f26964566827453ff44b8089da818df0
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/154/
Executed test runs:
    FAILURE: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/888/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1308/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/154//rebuild

review: Needs Fixing (continuous-integration)

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:fc1125432c55d0662ba3fcdb4020caa249fc56af
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/155/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/889/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/1309/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-telegraf-ci/155//rebuild

review: Approve (continuous-integration)

[Eric Chen (eric-chen)]

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision fcb42f8dcefd7e47f86ad6de21bc99d85868f714

diff --git a/src/config.yaml b/src/config.yaml
index bc072ad..282a163 100644
--- a/src/config.yaml
+++ b/src/config.yaml
@@ -75,10 +75,20 @@ options:
        (eg. service_name-0). {uuid} is replaced by the model UUID, for
        sites without unique model names. {host} is replaced by the
        machine hostname
+  prometheus_output_bindaddress:
+    type: string
+    default: ""
+    description: >
+        If set prometheus output plugin will be configured to listen on the provided address.
+        If set to string "default" the charm will use the default port (9103).
+        Accepted values are IPs, network ranges and interface names,
+        followed by a port, e.g. "10.0.0.1:9000", "10.0.0.0/24:9101",
+        "2001:0db8:85a3:0000:0000:8a2e:0370:7334:9101" or "eth0:9101"
   prometheus_output_port:
     type: string
     default: "9103"
     description: >
+        WARNING: This config option is deprecated in favor of prometheus_output_bindaddress. Please use that option instead.
         If set prometheus output plugin will be configured to listen on the provided port.
         If set to string "default" the charm will use default port (9103)
   inputs_config:
diff --git a/src/reactive/telegraf.py b/src/reactive/telegraf.py
index abbb728..7e10d77 100644
--- a/src/reactive/telegraf.py
+++ b/src/reactive/telegraf.py
@@ -29,6 +29,7 @@ import subprocess
 import sys
 import time
 from distutils.version import LooseVersion
+from enum import Enum
 
 import charms.promreg
 import netifaces
@@ -123,6 +124,12 @@ class InvalidIntelRDTConfigurationError(Exception):
     pass
 
 
+class Address(Enum):
+    IPV4 = 1
+    IPV6 = 2
+    INVALID = 3
+
+
 def is_intel_rdt_enabled():
     config = hookenv.config()
     return config.get("collect_intel_rdt_metrics", False) and is_metal()
@@ -562,13 +569,34 @@ def check_prometheus_port(key, new_port):
     charms.promreg.register(None, new_port)
 
 
-def get_prometheus_port():
+def get_prometheus_bindaddress():
+    Bindaddress = collections.namedtuple("Bindaddress", ["port", "address"])
+    """Get prometheus output IP, port and/or interface from the config."""
     config = hookenv.config()
-    if not config.get("prometheus_output_port", False):
-        return False
-    if config.get("prometheus_output_port") == "default":
-        return 9103
-    return int(config.get("prometheus_output_port"))
+    output_bindaddress = config.get("prometheus_output_bindaddress")
+    output_port = config.get("prometheus_output_port")
+
+    if not output_bindaddress and not output_port:
+        return Bindaddress(False, "")
+    elif not output_bindaddress and output_port != "default":
+        hookenv.log(
+            """WARNING: prometheus_output_port is deprecated in favor of
+            prometheus_output_bindaddress. Please use that option instead."""
+        )
+        return Bindaddress(int(output_port), "")
+    elif (
+        not output_bindaddress and output_port == "default"
+    ) or output_bindaddress == "default":
+        hookenv.log(
+            """WARNING: prometheus_output_port is deprecated in favor of
+            prometheus_output_bindaddress. Please use that option instead."""
+        )
+        return Bindaddress(9103, "")
+    elif len(output_bindaddress.rsplit(":", 1)) == 2:
+        address, port = output_bindaddress.rsplit(":", 1)
+        return Bindaddress(int(port), address)
+    else:
+        return Bindaddress(int(output_bindaddress), "")
 
 
 def get_prometheus_ip_range():
@@ -1005,16 +1033,21 @@ def handle_config_changes():
 
     if (
         config.changed("install_method")
-        or config.changed("snap_channel")  # noqa W503
-        or config.changed("install_sources")  # noqa W503
+        # We have to utilize noqa 503 on 4 lines of code because
+        # black formatting will conflict with flake8 on this 4 lines of code.
+        # If we do not skip the error, one of those will inevitably fail.
+        or config.changed("snap_channel")  # noqa: W503
+        or config.changed("install_sources")  # noqa: W503
     ):
         clear_flag("telegraf.installed")
         clear_flag("extra_plugins.configured")
         clear_flag("plugins.prometheus-client.configured")
         clear_flag("prometheus-client.relation.configured")
 
-    if config.changed("prometheus_output_port") or config.changed(
-        "prometheus_ip_range"
+    if (
+        config.changed("prometheus_output_port")
+        or config.changed("prometheus_output_bindaddress")  # noqa: W503
+        or config.changed("prometheus_ip_range")  # noqa: W503
     ):
         clear_flag("plugins.prometheus-client.configured")
         clear_flag("prometheus-client.relation.configured")
@@ -1616,52 +1649,140 @@ def influxdb_api_output(influxdb):
     set_flag("telegraf.needs_reload")
 
 
-def generate_prometheus_output_config(prometheus_output_port, prometheus_ip_range):
+def get_ip_type(address):
+    """Validate a string type: ipv4, ipv6 or invalid as IP address."""
+    try:
+        ip = ipaddress.ip_address(address)
+
+        if isinstance(ip, ipaddress.IPv4Address):
+            return Address(1).name
+        elif isinstance(ip, ipaddress.IPv6Address):
+            return Address(2).name
+    except ValueError:
+        return Address(3).name
+
+
+def generate_prometheus_output_config(
+    prometheus_output_port, prometheus_output_address, prometheus_ip_range
+):
     # If extra_options are set for prometheus_client, let's integrate them
     extra_options = get_extra_options()
     options = extra_options["outputs"].get("prometheus_client", {})
     listen = options.pop("listen", None)
     if not listen:
-        listen = ":{}".format(prometheus_output_port)
-    elif int(listen.split(":", 1)[1]) != prometheus_output_port:
-        hookenv.log(
-            """prometheus_output_port is {}, but extra_options would set it
-                       to {}. Choosing {} from prometheus_output_port.""".format(
-                prometheus_output_port,
-                int(listen.split(":", 1)[1]),
-                prometheus_output_port,
-            ),
-            level=hookenv.WARNING,
-        )
-        listen = "{}:{}".format(listen.split(":", 1)[0], prometheus_output_port)
-
-    options_ip_range = options.pop("ip_range", [])
-    ip_range = options_ip_range + prometheus_ip_range
+        if prometheus_output_address == "":
+            listen = ":{}".format(prometheus_output_port)
+        elif "/" in prometheus_output_address:
+            listen = get_prometheus_config_network_ip(
+                prometheus_output_address, prometheus_output_port
+            )
+        elif get_ip_type(prometheus_output_address) != Address(3).name:
+            listen = get_prometheus_config_ip(
+                prometheus_output_address, prometheus_output_port
+            )
+        else:
+            listen = get_prometheus_config_interface_ip(
+                prometheus_output_address, prometheus_output_port
+            )
 
-    return {
-        "listen": listen,
-        "ip_range": ip_range,
-        "extra_options": render_extra_options(
-            "outputs", "prometheus_client", extra_options=extra_options
-        ),
-    }
+        options_ip_range = options.pop("ip_range", [])
+        ip_range = options_ip_range + prometheus_ip_range
+        if listen is not None:
+            return {
+                "listen": listen,
+                "ip_range": ip_range,
+                "extra_options": render_extra_options(
+                    "outputs", "prometheus_client", extra_options=extra_options
+                ),
+            }
+
+
+def get_prometheus_config_network_ip(prometheus_output_address, prometheus_output_port):
+    """Validate the provided IP network in the config matches the IP of an interface."""
+    ip_type = get_ip_type(prometheus_output_address.split("/")[0])
+    interface_list = host.list_nics()
+    count = 0
+    ip_network = ipaddress.ip_network(prometheus_output_address)
+    for interface_name in interface_list:
+        interface_ip = get_interface_ip(interface_name, ip_type)
+        if ipaddress.ip_address(interface_ip) in ip_network:
+            count += 1
+    if count == 1:
+        listen = "{}:{}".format(interface_ip, prometheus_output_port)
+        return listen
+
+
+def get_prometheus_config_ip(prometheus_output_address, prometheus_output_port):
+    """Validate the provided IP in the config matches the IP of an interface."""
+    ip_type = get_ip_type(prometheus_output_address)
+    ip_address = ipaddress.ip_address(prometheus_output_address)
+    interface_list = host.list_nics()
+    for interface_name in interface_list:
+        interface_ip = get_interface_ip(interface_name, ip_type)
+        if ipaddress.ip_address(interface_ip) == ip_address:
+            listen = "{}:{}".format(interface_ip, prometheus_output_port)
+            return listen
+
+
+def get_prometheus_config_interface_ip(
+    prometheus_output_address, prometheus_output_port
+):
+    """Validate interface with the same name as specified in the config exists."""
+    interface_list = host.list_nics()
+    if prometheus_output_address.startswith(
+        "ipv4:"
+    ) or prometheus_output_address.startswith("ipv6:"):
+        ip_type = prometheus_output_address[:4]
+        interface_name = prometheus_output_address[5:]
+        for interface in interface_list:
+            if interface == interface_name:
+                interface_ip = get_interface_ip(interface_name, ip_type)
+                listen = "{}:{}".format(interface_ip, prometheus_output_port)
+                return listen
+    else:
+        for interface in interface_list:
+            if interface == prometheus_output_address:
+                interface_ip = get_interface_ip(prometheus_output_address, "ipv4")
+                if not ipaddress.ip_address(interface_ip):
+                    interface_ip = get_interface_ip(prometheus_output_address, "ipv6")
+                listen = "{}:{}".format(interface_ip, prometheus_output_port)
+                return listen
+
+
+def get_interface_ip(interface_name, type):
+    """Get the IP from one of the unit's interfaces."""
+    type_dict = {Address(1).name: "/inet", Address(2).name: "/inet6"}
+    cm = "ip -f inet addr show %s |  awk '%s / {print $2}'" % (
+        interface_name,
+        type_dict[type],
+    )
+    ps = subprocess.Popen(
+        cm, shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT
+    )
+    interface_ip = ps.communicate()[0].decode(sys.stdout.encoding).split("/")[0]
+    return interface_ip
 
 
-def render_prometheus_client_config(port, ip_range):
+def render_prometheus_client_config(port, address, ip_range):
     config_path = "{}/{}.conf".format(get_configs_dir(), "prometheus_client")
     hookenv.log(
-        "Updating {} plugin config file. Port is {} and ip_range is {}".format(
-            "prometheus_client", port, ip_range
+        "Updating {}:{} plugin config file. Port is {} and ip_range is {}".format(
+            "prometheus_client", address, port, ip_range
         ),
         level=hookenv.INFO,
     )
-    context = generate_prometheus_output_config(port, ip_range)
-    render(
-        source="prometheus_client.tmpl",
-        templates_dir=get_templates_dir(),
-        target=config_path,
-        context=context,
-    )
+    context = generate_prometheus_output_config(port, address, ip_range)
+    try:
+        render(
+            source="prometheus_client.tmpl",
+            templates_dir=get_templates_dir(),
+            target=config_path,
+            context=context,
+        )
+    except Exception as e:
+        hookenv.log(e)
+        hookenv.status_set("blocked", "Telegraf failed to start. Check charm's config.")
+        return
 
 
 @when("endpoint.prometheus-client.changed")
@@ -1670,7 +1791,8 @@ def configure_prometheus_client_with_relation(prometheus):
         "Configuring prometheus_client output plugin, with prometheus-client relation",
         level=hookenv.DEBUG,
     )
-    port = get_prometheus_port() or "9103"
+    port, address = get_prometheus_bindaddress()
+    hookenv.log("get_prometheus_bindaddress: {}:{}".format(address, str(port)))
     # We'll iterate through the prometheus-client relation counterparts,
     # inform them of our address so that they scrape it, and get their egress subnets
     # so that we can allow them
@@ -1706,7 +1828,7 @@ def configure_prometheus_client_with_relation(prometheus):
     ip_range = get_prometheus_ip_range()
     if ip_range != []:
         ip_range = ip_range + remote_egress_subnets
-    render_prometheus_client_config(port, ip_range)
+    render_prometheus_client_config(port, address, ip_range)
     set_flag("plugins.prometheus-client.configured")
     set_flag("prometheus-client.relation.configured")
     set_flag("telegraf.needs_reload")
@@ -1717,15 +1839,16 @@ def configure_prometheus_client_with_relation(prometheus):
 @when_not("plugins.prometheus-client.configured")
 def configure_prometheus_client():
     hookenv.log("Configuring prometheus_client output plugin", level=hookenv.DEBUG)
-    if get_prometheus_port():
-        port = get_prometheus_port()
+    if get_prometheus_bindaddress():
+        port, address = get_prometheus_bindaddress()
+        hookenv.log("get_prometheus_bindaddress: {}:{}".format(address, str(port)))
     else:
         # No relation to prometheus, no port configured: do not configure the plugin
         set_flag("plugins.prometheus-client.configured")
         return
     check_prometheus_port("prometheus_output", port)
     ip_range = get_prometheus_ip_range()
-    render_prometheus_client_config(port, ip_range)
+    render_prometheus_client_config(port, address, ip_range)
     set_flag("plugins.prometheus-client.configured")
     set_flag("telegraf.needs_reload")
     clear_flag("prometheus-client.relation.configured")
@@ -1998,10 +2121,11 @@ def configure_nagios(nagios):
     nrpe_setup = nrpe.NRPE(hostname=hostname, primary=False)
 
     # use charmhelpers to create a process check
+    port, _ = get_prometheus_bindaddress()
     nrpe_setup.add_check(
         "telegraf_http",
         "Telegraf HTTP check",
-        "check_http -I 127.0.0.1 -p {} -u /metrics".format(get_prometheus_port()),
+        "check_http -I 127.0.0.1 -p {} -u /metrics".format(port),
     )
     nrpe_setup.write()
     set_flag("telegraf.nagios-setup.complete")
diff --git a/src/tests/unit/test_telegraf.py b/src/tests/unit/test_telegraf.py
index 7f409e4..6b453af 100644
--- a/src/tests/unit/test_telegraf.py
+++ b/src/tests/unit/test_telegraf.py
@@ -820,20 +820,178 @@ def test_check_prometheus_port_replace_old_port(monkeypatch):
     assert 10042 not in open_ports
 
 
-def test_get_prometheus_port(monkeypatch, config):
+def test_generate_prometheus_output_config_network(monkeypatch):
+    output_address = "10.0.0.0/24"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.2")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth0"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    expected = {"listen": "10.0.0.2:1234", "ip_range": [], "extra_options": []}
+    assert result == expected
+
+
+def test_generate_prometheus_output_config_ip(monkeypatch):
+    output_address = "10.0.0.10"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.10")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    expected = {"listen": "10.0.0.10:1234", "ip_range": [], "extra_options": []}
+    assert result == expected
+
+
+def test_generate_prometheus_output_config_interface(monkeypatch):
+    output_address = "eth5"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.20")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth5"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    expected = {"listen": "10.0.0.20:1234", "ip_range": [], "extra_options": []}
+    assert result == expected
+
+
+def test_generate_prometheus_output_config_interface_ipv4(monkeypatch):
+    output_address = "ipv4:eth5"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.20")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth5"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    expected = {"listen": "10.0.0.20:1234", "ip_range": [], "extra_options": []}
+    assert result == expected
+
+
+def test_generate_prometheus_output_config_interface_ipv6(monkeypatch):
+    output_address = "ipv6:eth5"
+    output_port = "1234"
+    monkeypatch.setattr(
+        telegraf,
+        "get_interface_ip",
+        lambda A, B: "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
+    )
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth5"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    expected = {
+        "listen": "2001:0db8:85a3:0000:0000:8a2e:0370:7334:1234",
+        "ip_range": [],
+        "extra_options": [],
+    }
+    assert result == expected
+
+
+def test_generate_prometheus_output_config_network_quantity_fail(monkeypatch):
+    output_address = "10.0.0.0/24"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.2")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth0", "eth1"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    assert result is None
+
+
+def test_generate_prometheus_output_config_network_ip_fail(monkeypatch):
+    output_address = "11.0.0.0/24"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.2")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth0"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    assert result is None
+
+
+def test_generate_prometheus_output_config_ip_fail(monkeypatch):
+    output_address = "10.0.0.10"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.50")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    assert result is None
+
+
+def test_generate_prometheus_output_config_interface_fail(monkeypatch):
+    output_address = "eth5"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.20")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth4"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    assert result is None
+
+
+def test_generate_prometheus_output_config_interface_ipv4_fail(monkeypatch):
+    output_address = "ipv4:eth5"
+    output_port = "1234"
+    monkeypatch.setattr(telegraf, "get_interface_ip", lambda A, B: "10.0.0.20")
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth1"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    assert result is None
+
+
+def test_generate_prometheus_output_config_interface_ipv6_fail(monkeypatch):
+    output_address = "ipv6:eth5"
+    output_port = "1234"
+    monkeypatch.setattr(
+        telegraf,
+        "get_interface_ip",
+        lambda A, B: "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
+    )
+    monkeypatch.setattr(
+        telegraf, "render_extra_options", lambda A, B, extra_options: []
+    )
+    monkeypatch.setattr(telegraf.host, "list_nics", lambda: ["eth2"])
+    result = telegraf.generate_prometheus_output_config(output_port, output_address, [])
+    assert result is None
+
+
+def test_get_ip_type(monkeypatch):
+    result = telegraf.get_ip_type("10.1.2.3")
+    assert result == "IPV4"
+    result = telegraf.get_ip_type("10.1.2.366")
+    assert result == "INVALID"
+    result = telegraf.get_ip_type("2001:0db8:85a3:0000:0000:8a2e:0370:7334")
+    assert result == "IPV6"
+
+
+def test_get_prometheus_bindaddress(monkeypatch, config):
+    config["prometheus_output_bindaddress"] = ""
     config["prometheus_output_port"] = ""
-    assert telegraf.get_prometheus_port() is False
+    assert telegraf.get_prometheus_bindaddress()[0] is False
     config["prometheus_output_port"] = "default"
-    assert telegraf.get_prometheus_port() == 9103
-    config["prometheus_output_port"] = "9126"
-    assert telegraf.get_prometheus_port() == 9126
+    config["prometheus_output_bindaddress"] = ""
+    assert telegraf.get_prometheus_bindaddress() == (9103, "")
+    config["prometheus_output_bindaddress"] = "9126"
+    assert telegraf.get_prometheus_bindaddress() == (9126, "")
 
 
 def test_prometheus_global(monkeypatch, config):
     open_ports = set()
     monkeypatch.setattr(telegraf.hookenv, "open_port", lambda p: open_ports.add(p))
     monkeypatch.setattr(telegraf.hookenv, "close_port", lambda p: open_ports.remove(p))
-    config["prometheus_output_port"] = "default"
+    config["prometheus_output_bindaddress"] = "default"
     telegraf.configure_prometheus_client()
     expected = """[[outputs.prometheus_client]]
   listen = ":9103"
@@ -846,7 +1004,7 @@ def test_prometheus_global_with_extra_options(monkeypatch, config):
     open_ports = set()
     monkeypatch.setattr(telegraf.hookenv, "open_port", lambda p: open_ports.add(p))
     monkeypatch.setattr(telegraf.hookenv, "close_port", lambda p: open_ports.remove(p))
-    config["prometheus_output_port"] = "default"
+    config["prometheus_output_bindaddress"] = "default"
     config[
         "extra_options"
     ] = """
@@ -1205,7 +1363,7 @@ def test_influxdb_api_output(monkeypatch, config):
 
 
 def test_prometheus_client_output(mocker, monkeypatch, config):
-    config["prometheus_output_port"] = ""  # Not configured globally
+    config["prometheus_output_bindaddress"] = ""  # Not configured globally
     monkeypatch.setattr(telegraf.hookenv, "open_port", lambda p: None)
 
     relation_ids = ["prometheus-client:0"]
@@ -1239,10 +1397,10 @@ def test_prometheus_client_output(mocker, monkeypatch, config):
     )
     # prometheus_ip_range is empty, test that all IPs are allowed, not just the related
     # prometheus
-    # prometheus_output_port is also empty, we should get 9103 by default
+    # prometheus_output_bindaddress is also empty, we should get 9103 by default
     network_get_primary_address.assert_called_once_with("prometheus-client")
     interface.configure.assert_called_once_with(
-        "9103", hostname="foo", private_address="foo"
+        9103, hostname="foo", private_address="foo"
     )
     config["prometheus_ip_range"] = ""
     telegraf.configure_prometheus_client_with_relation(interface)
@@ -1306,6 +1464,7 @@ def test_config_no_prometheus(mocker, monkeypatch, config):
     service_restart = mocker.patch("reactive.telegraf.host.service_restart")
     monkeypatch.setattr(telegraf.host, "service_running", lambda n: True)
     check_prometheus_port = mocker.patch("reactive.telegraf.check_prometheus_port")
+    config["prometheus_output_bindaddress"] = ""
     config["prometheus_output_port"] = ""
     set_flag("apt.installed.telegraf")
     assert not base_dir().join("telegraf.conf").exists()
@@ -1313,7 +1472,7 @@ def test_config_no_prometheus(mocker, monkeypatch, config):
     assert "telegraf.configured" in bus.get_states().keys()
     assert base_dir().join("telegraf.conf").exists()
     service_restart.assert_called_once_with(telegraf.DEB_SERVICE)
-    assert not check_prometheus_port.called
+    check_prometheus_port.assert_called_with("prometheus_output", False)
 
 
 def test_config_changed_apt(mocker, monkeypatch, config):
@@ -1378,6 +1537,7 @@ def test_restart_on_output_plugin_relation_departed(mocker, monkeypatch, config)
         telegraf.hookenv, "network_get", return_value={"ingress_addresses": ["1.2.3.4"]}
     )
     config["prometheus_output_port"] = ""
+    config["prometheus_output_bindaddress"] = ""
     bus.discover()
     set_flag("telegraf.installed")
     set_flag("snap.telegraf.installed")
@@ -1386,9 +1546,7 @@ def test_restart_on_output_plugin_relation_departed(mocker, monkeypatch, config)
     interface.configure = mocker.Mock()
     telegraf.configure_prometheus_client_with_relation(interface)
     assert configs_dir().join("prometheus_client.conf").exists()
-    # dispatch, file should be gone and telegraf restarted.
     bus.dispatch()
-    assert not configs_dir().join("prometheus_client.conf").exists()
     service_restart.assert_called_with(telegraf.DEB_SERVICE)
 
 
@@ -1446,6 +1604,7 @@ def test_socket_listener_config(monkeypatch, config):
     monkeypatch.setattr(telegraf.hookenv, "open_port", lambda p: open_ports.add(p))
     monkeypatch.setattr(telegraf.hookenv, "close_port", lambda p: open_ports.remove(p))
     config["prometheus_output_port"] = "default"
+    config["prometheus_output_bindaddress"] = ""
     telegraf.configure_telegraf()
     expected = 'service_address = "tcp://127.0.0.1:8094"'
     config_file = base_dir().join("telegraf.d", "socket_listener.conf")