allow user to set listen address and port (#55)

* allow user to set listen address and port * bump rock version * changelog entry * update codeowners
canonical · Oct 31, 2023 · e058422 · e058422
1 parent a26342b
commit e058422
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,8 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2023-10-26
+
 - Added usage instructions to the readme (#51).
 - Added snapcraft build recipes and automation. (#52)
+- Added the ability to set the listen address and port for the web server. (#55)
 
 ## [0.4.0] - 2023-05-31
 

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1 @@
-*       @abuelodelanada @dstathis @lucabello @PietroPasotti @rbarry82 @sed-i @simskij
+*       @abuelodelanada @dstathis @lucabello @PietroPasotti @sed-i @simskij @mmkay @IbraAoad
diff --git a/cos_alerter/alerter.py b/cos_alerter/alerter.py
@@ -55,7 +55,7 @@ def deep_update(base: dict, new: typing.Optional[dict]):
     if new is None:
         return
     for key in base:
-        if key in new and type(base[key]) == dict:
+        if key in new and isinstance(base[key], dict):
             deep_update(base[key], new[key])
         elif key in new:
             base[key] = new[key]

diff --git a/cos_alerter/config-defaults.yaml b/cos_alerter/config-defaults.yaml
@@ -35,3 +35,7 @@ notify:
 # The logging level of COS Alerter
 # Levels available: critical, error, warning, info, debug
 log_level: "info"
+
+# The address to listen on for http traffic.
+# Format HOST:PORT
+web_listen_addr: "0.0.0.0:8080"
diff --git a/cos_alerter/daemon.py b/cos_alerter/daemon.py
@@ -95,7 +95,12 @@ def main(run_for: Optional[int] = None, argv: List[str] = sys.argv):
     # from the daemon. It also facilitates communication over memory rather than files.
     # clear_untrusted_proxy_headers is set to suppress a DeprecationWarning.
     server_thread = threading.Thread(
-        target=waitress.serve, args=(app,), kwargs={"clear_untrusted_proxy_headers": True}
+        target=waitress.serve,
+        args=(app,),
+        kwargs={
+            "clear_untrusted_proxy_headers": True,
+            "listen": config["web_listen_addr"],
+        },
     )
     server_thread.daemon = True  # Makes this thread exit when the main thread exits.
     logger.info("Starting the web server thread.")

diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cos-alerter"
-version = "0.4.0"
+version = "0.5.0"
 authors = [
   { name="Dylan Stephano-Shachter", email="dylan.stephano-shachter@canonical.com" }
 ]

diff --git a/rockcraft.yaml b/rockcraft.yaml
@@ -1,7 +1,7 @@
 name: cos-alerter
 summary: A liveness checker for self-monitoring.
 description: Receive regular pings from the cos stack and alert when they stop.
-version: "0.4.0"  # NOTE: Make sure this matches `cos-alerter` below
+version: "0.5.0"  # NOTE: Make sure this matches `cos-alerter` below
 base: ubuntu:22.04
 license: Apache-2.0
 platforms:
@@ -11,7 +11,7 @@ parts:
     plugin: python
     source: .
     python-packages:
-      - cos-alerter==0.4.0  # NOTE: Make sure this matches `version` above
+      - cos-alerter==0.5.0  # NOTE: Make sure this matches `version` above
     stage-packages:
       - python3-venv
 services:

diff --git a/snap/snapcraft.yaml b/snap/snapcraft.yaml
@@ -1,5 +1,5 @@
 name: cos-alerter
-version: '0.4.0'
+version: '0.5.0'
 summary: A watchdog alerting on alertmanager notification failures.
 license: Apache-2.0
 contact: simon.aronsson@canonical.com

diff --git a/tox.ini b/tox.ini
@@ -32,6 +32,8 @@ commands =
 [testenv:static]
 description = Run static analysis checks
 deps =
+    types-pyyaml
+    types-waitress
     pyright
 commands =
     pyright