ducted 2.1__tar.gz → 2.2__tar.gz

{ducted-2.1 → ducted-2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ducted
-Version: 2.1
+Version: 2.2
 Summary: A monitoring agent and event processor
 Author-email: Colin Alston <colin@tamvera.com>
 License: MIT

{ducted-2.1 → ducted-2.2}/README.md

@@ -1,5 +1,7 @@
 # Duct
 
+I want to talk to you about ducts. Do your ducts seem old-fashioned? Out of date?
+
 [![CI](https://github.com/Tamvera/ducted/actions/workflows/ci.yml/badge.svg)](https://github.com/Tamvera/ducted/actions/workflows/ci.yml)
 [![Latest Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://tamvera.github.io/ducted/)
 
@@ -31,6 +33,17 @@ Duct is an asyncio daemon that polls *sources* on configurable intervals and rou
 
 ## Installation
 
+### System wide on Linux, with a systemd script
+```bash
+curl -o - https://raw.githubusercontent.com/Tamvera/ducted/refs/heads/master/scripts/install.sh | sh
+```
+
+### With docker
+```bash
+docker run -i -v ./duct.yml:/duct/duct.yml ghcr.io/tamvera/ducted:latest
+```
+
+### With pip
 ```bash
 pip install ducted
 ```

{ducted-2.1 → ducted-2.2}/duct/outputs/nats.py

@@ -27,6 +27,11 @@ class Nats(Output):
     :param prefix: Prefix added to topics (default: "")
     :type prefix: str
 
+    :param topic: Topic template, formatted with the event's fields, e.g.
+                  "{hostname}.{service}" or "metrics.{attributes[region]}.{service}"
+                  (default: "{hostname}.{service}")
+    :type topic: str
+
     :param format: Serialisation format - json, senml-json, senml-cbor (default: senml-json)
     :type format: str
 
@@ -59,6 +64,7 @@ class Nats(Output):
 
         self.servers = self.config.get("servers", ["nats://localhost:4222"])
         self.prefix = self.config.get("prefix", "")
+        self.topic = self.config.get("topic", "{hostname}.{service}")
         self.format = self.config.get("format", "senml-json")
         self.inter = float(self.config.get("interval", 1.0))
         self.use_jetstream = bool(self.config.get("jetstream", False))
@@ -117,13 +123,21 @@ class Nats(Output):
     def _transform_event(self, event: Event) -> bytes:
         return self.transformers[self.format](event)
 
+    def _build_topic(self, event: Event) -> str:
+        topic = self.topic.format_map(vars(event))
+        if self.prefix:
+            topic = f"{self.prefix}.{topic}"
+        return topic
+
     async def sendEvents(self, events: list[Event]):
         "Send batches of events to NATS or JetStream"
         for ev in events:
-            if self.prefix:
-                topic = f"{self.prefix}.{ev.hostname}.{ev.service}"
-            else:
-                topic = f"{ev.hostname}.{ev.service}"
+            try:
+                topic = self._build_topic(ev)
+            except (KeyError, IndexError, AttributeError, TypeError):
+                log.exception("Failed to build topic from %r for event %s",
+                              self.topic, ev.service)
+                continue
             payload = self._transform_event(ev)
             try:
                 if self.use_jetstream:

{ducted-2.1 → ducted-2.2}/duct/sources/nats.py

@@ -41,6 +41,9 @@ class Nats(Source):
     :param durable: Durable consumer name for JetStream subscriptions (default: "ducted")
     :type durable: str
 
+    :param append_topic: Append the topic to the service name for events
+    :type append_topic: bool
+
     :param credentials_file: Path to NATS credentials (.creds) file
     :type credentials_file: str
 
@@ -66,6 +69,7 @@ class Nats(Source):
         self.format = self.config.get("format", "senml-json")
         self.use_jetstream = bool(self.config.get("jetstream", False))
         self.durable = self.config.get("durable", "ducted")
+        self.append_topic = self.config.get("append_topic", False)
 
         self.credentials_file = self.config.get("credentials_file")
         self.nkey_seed_file = self.config.get("nkey_seed_file")
@@ -147,6 +151,8 @@ class Nats(Source):
     async def _get_event(self, message):
         try:
             ev = self.transformers[self.format](message.data)
+            if self.append_topic:
+                ev.service = f"{message.subject}.{ev.service}"
             self.queueBack([ev])
         except Exception:
             log.exception(

{ducted-2.1 → ducted-2.2}/duct/tests/test_outputs.py

@@ -255,6 +255,31 @@ class TestNATSOutput:
         assert decoded.tags == ["prod", "eu"]
         assert decoded.attributes["chicken"] == "little"
 
+    @pytest.mark.asyncio
+    async def test_nats_output_topic_template(self, service):
+        ev = Event('ok', 'sky', 'Chicken alert', 2.0, 30.0,
+                   tags=['prod'], attributes={"region": "eu"},
+                   hostname='testhost')
+        nats_mod.nats = FakeNATS()
+        out = nats_mod.Nats({"topic": "{attributes[region]}.{state}.{service}",
+                             "prefix": "duct"}, service)
+        await out.createClient()
+        await out.eventsReceived([ev])
+        await out._tick()
+
+        topic, _ = out.nc.messages[0]
+        assert topic == "duct.eu.ok.sky"
+
+    @pytest.mark.asyncio
+    async def test_nats_output_topic_template_missing_key(self, service, event):
+        nats_mod.nats = FakeNATS()
+        out = nats_mod.Nats({"topic": "{attributes[nope]}.{service}"}, service)
+        await out.createClient()
+        await out.eventsReceived([event])
+        await out._tick()
+
+        assert out.nc.messages == []
+
     @pytest.mark.asyncio
     async def test_nats_output_cbor(self, service, event):
         nats_mod.nats = FakeNATS()

{ducted-2.1 → ducted-2.2}/ducted.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ducted
-Version: 2.1
+Version: 2.2
 Summary: A monitoring agent and event processor
 Author-email: Colin Alston <colin@tamvera.com>
 License: MIT

{ducted-2.1 → ducted-2.2}/ducted.egg-info/top_level.txt

@@ -2,3 +2,4 @@ dist
 docker
 docs
 duct
+scripts

{ducted-2.1 → ducted-2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ducted"
-version = "2.1"
+version = "2.2"
 description = "A monitoring agent and event processor"
 license = { text = "MIT" }
 authors = [{ name = "Colin Alston", email = "colin@tamvera.com" }]