ducted 2.2__tar.gz → 2.2.1__tar.gz

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

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

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

@@ -12,7 +12,7 @@ import nats
 from nats.aio.client import Client as NATS
 
 from duct.objects import Output, Event
-from duct.protocol.senml import event_to_senml, event_to_senml_cbor, event_to_json
+from duct.protocol.senml import event_to_senml, event_to_senml_cbor, event_to_senml_cbor_extended, event_to_json
 
 
 log = logging.getLogger(__name__)
@@ -78,6 +78,7 @@ class Nats(Output):
         self.transformers = {
             "senml-json": event_to_senml,
             "senml-cbor": event_to_senml_cbor,
+            "senml-cbor-extended": event_to_senml_cbor_extended,
             "json": event_to_json,
         }
 

{ducted-2.2 → ducted-2.2.1}/duct/protocol/senml.py

@@ -12,7 +12,7 @@ import cbor2
 from duct.objects import Event
 
 
-def event_to_senml_pack(event: Event) -> list:
+def event_to_senml_pack(event: Event, extended_attributes:bool=True) -> list:
     """Convert a Duct Event to a SenML record pack (list of dicts)."""
     pack = [
         {
@@ -22,20 +22,23 @@ def event_to_senml_pack(event: Event) -> list:
             "v": event.metric,
         }
     ]
-    if event.state:
-        pack.append({"n": event.service + "/state", "vs": event.state})
-    if event.description:
-        pack.append({"n": event.service + "/description", "vs": event.description})
-    if event.ttl:
-        pack.append({"n": event.service + "/ttl", "v": float(event.ttl)})
-    if event.tags:
-        pack.append({"n": event.service + "/tags", "vs": ",".join(event.tags)})
-    if event.attributes:
-        for k, v in event.attributes.items():
-            if isinstance(v, (int, float)):
-                pack.append({"n": f"{event.service}/attr/{k}", "v": float(v)})
-            else:
-                pack.append({"n": f"{event.service}/attr/{k}", "vs": str(v)})
+
+    if extended_attributes:
+        # We don't always want this extra overhead
+        if event.state:
+            pack.append({"n": event.service + "/state", "vs": event.state})
+        if event.description:
+            pack.append({"n": event.service + "/description", "vs": event.description})
+        if event.ttl:
+            pack.append({"n": event.service + "/ttl", "v": float(event.ttl)})
+        if event.tags:
+            pack.append({"n": event.service + "/tags", "vs": ",".join(event.tags)})
+        if event.attributes:
+            for k, v in event.attributes.items():
+                if isinstance(v, (int, float)):
+                    pack.append({"n": f"{event.service}/attr/{k}", "v": float(v)})
+                else:
+                    pack.append({"n": f"{event.service}/attr/{k}", "vs": str(v)})
     return pack
 
 
@@ -101,9 +104,12 @@ def senml_to_event(data: bytes | str, default_ttl: float = 60.0) -> Event:
 
 
 def event_to_senml_cbor(event: Event) -> bytes:
-    """Serialise a Duct Event to SenML-CBOR bytes."""
-    return cbor2.dumps(event_to_senml_pack(event))
+    """Serialise a Duct Event to SenML-CBOR bytes, only values."""
+    return cbor2.dumps(event_to_senml_pack(event, extended_attributes=False))
 
+def event_to_senml_cbor_extended(event: Event) -> bytes:
+    """Serialise a Duct Event to SenML-CBOR bytes with extended attributes."""
+    return cbor2.dumps(event_to_senml_pack(event))
 
 def senml_cbor_to_event(data: bytes, default_ttl: float = 60.0) -> Event:
     """Deserialise SenML-CBOR bytes to a Duct Event."""

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

@@ -280,6 +280,22 @@ class TestNATSOutput:
 
         assert out.nc.messages == []
 
+    @pytest.mark.asyncio
+    async def test_nats_output_cbor_ext(self, service, event):
+        nats_mod.nats = FakeNATS()
+        out = nats_mod.Nats({"format": "senml-cbor-extended"}, service)
+        await out.createClient()
+        await out.eventsReceived([event])
+        await out._tick()
+
+        topic, payload = out.nc.messages[0]
+        assert topic.endswith(".sky")
+
+        decoded = senml_cbor_to_event(payload)
+        assert decoded.service == "sky"
+        assert decoded.metric == pytest.approx(event.metric)
+        assert decoded.state == event.state
+
     @pytest.mark.asyncio
     async def test_nats_output_cbor(self, service, event):
         nats_mod.nats = FakeNATS()
@@ -294,7 +310,7 @@ class TestNATSOutput:
         decoded = senml_cbor_to_event(payload)
         assert decoded.service == "sky"
         assert decoded.metric == pytest.approx(event.metric)
-        assert decoded.state == event.state
+        assert decoded.state == 'ok'
 
     @pytest.mark.asyncio
     async def test_nats_output_json(self, service, event):

{ducted-2.2 → ducted-2.2.1}/duct/tests/test_protocol.py

@@ -9,6 +9,7 @@ from duct.protocol.senml import (
     event_to_senml,
     senml_to_event,
     event_to_senml_cbor,
+    event_to_senml_cbor_extended,
     senml_cbor_to_event,
     event_to_json,
     json_to_event,
@@ -54,7 +55,7 @@ class TestSenMLPack:
     def test_pack_secondary_records(self):
         ev = _make_event(state="critical", description="high load",
                          tags=["prod"], hostname="h", service="cpu")
-        pack = event_to_senml_pack(ev)
+        pack = event_to_senml_pack(ev, True)
         names = {r["n"] for r in pack}
         assert "cpu/state" in names
         assert "cpu/description" in names
@@ -63,39 +64,39 @@ class TestSenMLPack:
 
     def test_pack_state_value(self):
         ev = _make_event(state="warning", service="mem", hostname="h")
-        pack = event_to_senml_pack(ev)
+        pack = event_to_senml_pack(ev, True)
         state_rec = next(r for r in pack if r.get("n") == "mem/state")
         assert state_rec["vs"] == "warning"
 
     def test_pack_tags_joined(self):
         ev = _make_event(tags=["a", "b", "c"], service="s", hostname="h")
-        pack = event_to_senml_pack(ev)
+        pack = event_to_senml_pack(ev, True)
         tags_rec = next(r for r in pack if r.get("n") == "s/tags")
         assert tags_rec["vs"] == "a,b,c"
 
     def test_pack_numeric_attribute(self):
         ev = _make_event(attributes={"count": 5}, service="s", hostname="h")
-        pack = event_to_senml_pack(ev)
+        pack = event_to_senml_pack(ev, True)
         attr_rec = next(r for r in pack if r.get("n") == "s/attr/count")
         assert attr_rec.get("v") == 5.0
         assert "vs" not in attr_rec
 
     def test_pack_string_attribute(self):
         ev = _make_event(attributes={"zone": "eu-west"}, service="s", hostname="h")
-        pack = event_to_senml_pack(ev)
+        pack = event_to_senml_pack(ev, True)
         attr_rec = next(r for r in pack if r.get("n") == "s/attr/zone")
         assert attr_rec.get("vs") == "eu-west"
         assert "v" not in attr_rec
 
     def test_pack_no_tags_when_empty(self):
         ev = _make_event(tags=[], service="s", hostname="h")
-        pack = event_to_senml_pack(ev)
+        pack = event_to_senml_pack(ev, True)
         names = [r.get("n") for r in pack]
         assert "s/tags" not in names
 
     def test_pack_no_attributes_when_none(self):
         ev = _make_event(attributes=None, service="s", hostname="h")
-        pack = event_to_senml_pack(ev)
+        pack = event_to_senml_pack(ev, True)
         names = [r.get("n") for r in pack]
         assert not any("attr" in (n or "") for n in names)
 
@@ -106,7 +107,7 @@ class TestSenMLPack:
 
 class TestSenMLRoundTrip:
     def _roundtrip(self, ev):
-        return senml_pack_to_event(event_to_senml_pack(ev))
+        return senml_pack_to_event(event_to_senml_pack(ev, True))
 
     def test_hostname_preserved(self):
         ev = _make_event(hostname="myhost.local")
@@ -192,14 +193,19 @@ class TestSenMLCBOR:
         ev = _make_event(service="temp.sensor")
         assert senml_cbor_to_event(event_to_senml_cbor(ev)).service == "temp.sensor"
 
-    def test_roundtrip_full(self):
+    def test_roundtrip_full_extended(self):
         ev = _make_event()
-        rt = senml_cbor_to_event(event_to_senml_cbor(ev))
+        rt = senml_cbor_to_event(event_to_senml_cbor_extended(ev))
         assert rt.hostname == ev.hostname
         assert rt.metric == pytest.approx(ev.metric)
         assert rt.state == ev.state
-        assert rt.tags == ev.tags
 
+    def test_roundtrip_full(self):
+        ev = _make_event()
+        rt = senml_cbor_to_event(event_to_senml_cbor(ev))
+        assert rt.hostname == ev.hostname
+        assert rt.metric == pytest.approx(ev.metric)
+        assert rt.description == ""
 
 class TestPlainJSON:
     def test_returns_bytes(self):

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

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

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

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