omdnotificationforwarder 4.2__tar.gz → 4.3__tar.gz

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: omdnotificationforwarder
-Version: 4.2
+Version: 4.3
 Summary: A framework for notification scripts for OMD
 Project-URL: Homepage, https://github.com/lausser/noteventificationforhandlerwarder
 Project-URL: Bug Tracker, https://github.com/lausser/noteventificationforhandlerwarder/issues
@@ -9,10 +9,9 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.6.1
-Requires-Dist: coshsh
 Requires-Dist: jinja2
 Provides-Extra: nostr
-Requires-Dist: pynostr; extra == 'nostr'
+Requires-Dist: nostr-sdk; extra == 'nostr'
 Provides-Extra: test
 Requires-Dist: flake8; extra == 'test'
 Requires-Dist: pytest; extra == 'test'
@@ -25,6 +24,7 @@ Description-Content-Type: text/markdown
 In this framework, two aspects are in the focus. How to transport a notification to the recipient system and in which format.
 In the beginning, Naemon or one of the other monitoring cores will execute a command line. The actual script and the individual command line parameters are defined in a command definition. Typical parameters are (i use the notation of Nagios macros) HOSTNAME, SERVICEDESC, SERVICESTATE, SERVICEOUTPUT. These snippets need to be put together to some kind of payload suitable for the receiving system. And then this payload must be transported to it. We call the two components *formatter* and *forwarder*. The formatter takes the raw input data and creates a payload and the forwarder transmits the payload to the destination.
 What the framework does for you behind the scenes: When forwarding to a recipient fails, the event is saved in a local sqlite database for a certain time and re-sent when the script is called next time and the recipient is available again. Logging of successful and of course failed deliveries is also done automatically.  
+Logging uses the framework's native setup with the standard logfile naming and format used by the built-in tools.
 There is also a component *reporter* which will rarely be used. It's purpose is to run additional code after a successful or failed delivery.  
 
 Let me list some of the formatter/forwarder combinations which are usually found in enterprise environments:

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/README.md

@@ -3,6 +3,7 @@
 In this framework, two aspects are in the focus. How to transport a notification to the recipient system and in which format.
 In the beginning, Naemon or one of the other monitoring cores will execute a command line. The actual script and the individual command line parameters are defined in a command definition. Typical parameters are (i use the notation of Nagios macros) HOSTNAME, SERVICEDESC, SERVICESTATE, SERVICEOUTPUT. These snippets need to be put together to some kind of payload suitable for the receiving system. And then this payload must be transported to it. We call the two components *formatter* and *forwarder*. The formatter takes the raw input data and creates a payload and the forwarder transmits the payload to the destination.
 What the framework does for you behind the scenes: When forwarding to a recipient fails, the event is saved in a local sqlite database for a certain time and re-sent when the script is called next time and the recipient is available again. Logging of successful and of course failed deliveries is also done automatically.  
+Logging uses the framework's native setup with the standard logfile naming and format used by the built-in tools.
 There is also a component *reporter* which will rarely be used. It's purpose is to run additional code after a successful or failed delivery.  
 
 Let me list some of the formatter/forwarder combinations which are usually found in enterprise environments:

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/bin/notificationforwarder

@@ -6,7 +6,7 @@ import logging.handlers
 import os
 import sys
 #import logging
-from coshsh.util import setup_logging
+from notificationforwarder.util import setup_logging
 from notificationforwarder import baseclass
 import traceback
 
@@ -78,7 +78,7 @@ Example for an HTTP-based reporter:
                       help='Logger type: text (default) or json, or custom logger module',
                       default='text')
     parser.add_argument('--version', action='version',
-                      version=f'%(prog)s 4.2')
+                      version=f'%(prog)s 4.3')
 
     args = parser.parse_args()
     if not hasattr(args, 'formatter'):

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["hatchling", "coshsh"]
+requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build]
@@ -21,7 +21,7 @@ packages = ["src/notificationforwarder"]
 
 [project]
 name = "omdnotificationforwarder"
-version = "4.2"
+version = "4.3"
 authors = [
   { name="Gerhard Lausser", email="lausser@yahoo.com" },
 ]
@@ -34,13 +34,12 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "coshsh",
     "jinja2",
 ]
 
 [project.optional-dependencies]
 nostr = [
-    "pynostr",
+    "nostr-sdk",
 ]
 test = [
     "requests",

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/src/notificationforwarder/baseclass.py

@@ -11,7 +11,7 @@ except ImportError:
     import json
 
 import logging
-from coshsh.util import setup_logging
+from notificationforwarder.util import setup_logging
 from importlib import import_module
 
 from notificationforwarder.component_loader import (

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/src/notificationforwarder/nostr/formatter.py

@@ -1,14 +1,3 @@
-"""Generate a Nostr keypair and derive bech32 values.
-
-```python
-from pynostr.key import PrivateKey
-
-private_key = PrivateKey()
-print(private_key.bech32())          # nsec1...
-print(private_key.public_key.bech32())  # npub1...
-```
-"""
-
 import json
 
 from notificationforwarder.baseclass import NotificationFormatter
@@ -25,11 +14,11 @@ class NostrFormatter(NotificationFormatter):
     def _build_tags(self, host, service, state, extra_tags=None):
         tags = [["t", "monitoring"]]
         if host:
-            tags.append(["host", host])
+            tags.append(["t", "host=" + host])
         if service:
-            tags.append(["service", service])
+            tags.append(["t", "service=" + service])
         if state:
-            tags.append(["state", state])
+            tags.append(["t", "state=" + state])
         if isinstance(extra_tags, str):
             try:
                 extra_tags = json.loads(extra_tags)
@@ -54,7 +43,6 @@ class NostrFormatter(NotificationFormatter):
         ]
         content = "\n".join(lines)
         event.payload = {
-            "kind": 4,
             "content": content,
             "tags": self._build_tags(
                 host,

omdnotificationforwarder-4.3/src/notificationforwarder/nostr/forwarder.py

@@ -0,0 +1,130 @@
+import asyncio
+
+try:
+    from nostr_sdk import Client, Keys, NostrSigner, PublicKey, RelayUrl, Tag, uniffi_set_event_loop
+except ImportError as exc:
+    raise ImportError("missing nostr-sdk") from exc
+
+from notificationforwarder.baseclass import NotificationForwarder, timeout
+
+
+class NostrForwarder(NotificationForwarder):
+    def __init__(self, opts):
+        super(self.__class__, self).__init__(opts)
+        setattr(self, "relays", getattr(self, "relays", "wss://relay.damus.io"))
+        setattr(self, "relay_urls", getattr(self, "relay_urls", self.relays))
+        setattr(self, "nsec", getattr(self, "nsec", None))
+        setattr(self, "timeout_seconds", int(getattr(self, "timeout_seconds", 6)))
+
+    def _relay_list(self):
+        relays = self.relay_urls if self.relay_urls is not None else self.relays
+        if isinstance(relays, str):
+            return [relay.strip() for relay in relays.split(",") if relay.strip()]
+        if isinstance(relays, (list, tuple)):
+            return [str(relay).strip() for relay in relays if str(relay).strip()]
+        return []
+
+    def _keys(self):
+        if not self.nsec:
+            raise ValueError("nsec is required for Nostr publishing")
+        return Keys.parse(self.nsec)
+
+    def _public_key(self, value):
+        if isinstance(value, PublicKey):
+            return value
+        if not isinstance(value, str):
+            raise ValueError("receiver public key must be a string or PublicKey")
+        return PublicKey.parse(value)
+
+    def _tags(self, formatted_event):
+        tags = []
+        payload = formatted_event.payload or {}
+        tag_values = payload.get("tags", [])
+        if isinstance(tag_values, str):
+            import json
+
+            try:
+                tag_values = json.loads(tag_values)
+            except Exception:
+                tag_values = []
+        if isinstance(tag_values, (list, tuple)):
+            for tag in tag_values:
+                if isinstance(tag, (list, tuple)) and tag:
+                    tags.append(Tag.parse(list(tag)))
+        return tags
+
+    def _configured_tags(self):
+        tag_values = getattr(self, "tags", [])
+        if isinstance(tag_values, str):
+            import json
+
+            try:
+                tag_values = json.loads(tag_values)
+            except Exception:
+                tag_values = []
+        return tag_values if isinstance(tag_values, (list, tuple)) else []
+
+    def _nip_mode(self):
+        return getattr(self, "nip_mode", "nip04")
+
+    async def _send_private_msg(self, relay_urls, receiver_pubkey, message, tags):
+        uniffi_set_event_loop(asyncio.get_running_loop())
+        keys = self._keys()
+        signer = NostrSigner.keys(keys)
+        client = Client(signer)
+        relay_urls = [RelayUrl.parse(url) for url in relay_urls]
+
+        for relay_url in relay_urls:
+            await client.add_relay(relay_url)
+
+        await client.connect()
+        return await client.send_private_msg_to(relay_urls, receiver_pubkey, message, tags)
+
+    async def _send_nip04_dm(self, relay_urls, receiver_pubkey, message):
+        uniffi_set_event_loop(asyncio.get_running_loop())
+        keys = self._keys()
+        signer = NostrSigner.keys(keys)
+        client = Client(signer)
+        relay_urls = [RelayUrl.parse(url) for url in relay_urls]
+
+        for relay_url in relay_urls:
+            await client.add_relay(relay_url)
+
+        await client.connect()
+        return await client.send_private_msg_to(relay_urls, receiver_pubkey, message, [])
+
+    @timeout(30)
+    def submit(self, event):
+        relay_urls = self._relay_list()
+        if not relay_urls:
+            logger.critical("Nostr publish failed: no relays configured")
+            return False
+
+        payload = event.payload or {}
+        nip_mode = self._nip_mode()
+        tags = self._configured_tags() or payload.get("tags", [])
+        recipient_pubkey = None
+        for tag in tags or []:
+            if isinstance(tag, (list, tuple)) and len(tag) > 1 and tag[0] == "p":
+                recipient_pubkey = self._public_key(tag[1])
+                break
+        if recipient_pubkey is None:
+            raise ValueError("Nostr DM requires a recipient p tag")
+
+        try:
+            message = payload.get("content", event.summary or str(payload))
+            nip_mode = self._nip_mode()
+            logger.debug("Nostr NIP mode: {}".format(nip_mode))
+            if nip_mode == "nip17":
+                # For NIP-17, use tags from payload (like [["t", "monitoring"]])
+                tags = self._tags(event)
+                asyncio.run(self._send_private_msg(relay_urls, recipient_pubkey, message, tags))
+            else:
+                # NIP-04: send without tags (nostr-sdk doesn't support NIP-04 tags easily)
+                asyncio.run(self._send_nip04_dm(relay_urls, recipient_pubkey, message))
+            logger.info("published Nostr DM: {}".format(event.summary))
+            self.no_more_logging()
+            return True
+        except Exception as exc:
+            logger.critical("Nostr publish failed: {}".format(str(exc)))
+            return False

omdnotificationforwarder-4.3/src/notificationforwarder/util.py

@@ -0,0 +1,37 @@
+import logging
+from logging.handlers import RotatingFileHandler
+from pathlib import Path
+import sys
+
+
+def setup_logging(logdir=".", logfile="notificationforwarder.log", scrnloglevel=logging.INFO, txtloglevel=logging.INFO, format="%(asctime)s %(process)d - %(levelname)s - %(message)s", backup_count=3):
+    logdir_path = Path(logdir)
+    logdir_path.mkdir(parents=True, exist_ok=True)
+
+    logfile_path = Path(logfile)
+    abs_logfile = logfile_path if logfile_path.is_absolute() else logdir_path / logfile_path
+    abs_logfile.touch(exist_ok=True)
+    logger_name = abs_logfile.name[:-4] if abs_logfile.name.endswith(".log") else abs_logfile.name
+    logger = logging.getLogger(logger_name)
+    logger.setLevel(logging.DEBUG)
+    logger.propagate = False
+
+    for handler in list(logger.handlers):
+        handler.close()
+        logger.removeHandler(handler)
+
+    formatter = logging.Formatter(format)
+
+    file_handler = RotatingFileHandler(str(abs_logfile), maxBytes=20 * 1024 * 1024, backupCount=backup_count, delay=True)
+    file_handler.setFormatter(formatter)
+    file_handler.setLevel(txtloglevel)
+    logger.addHandler(file_handler)
+
+    console_handler = logging.StreamHandler(sys.stderr)
+    console_handler.setFormatter(formatter)
+    console_handler.setLevel(scrnloglevel)
+    logger.addHandler(console_handler)
+
+    logger.debug("Logger initialized.")
+
+    return logger

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/tests/test_alertmanager.py

@@ -149,7 +149,7 @@ def test_alertmanager_forwarder(setup):
     }
 
 
-    amgw = notificationforwarder.baseclass.new("webhook", None, "alertmanager_servicenow", False, False,  forwarderopts)
+    amgw = notificationforwarder.baseclass.new("webhook", None, "alertmanager_servicenow", True, True,  forwarderopts)
     famgw = amgw.new_formatter()
     assert famgw.__class__.__name__ == "AlertmanagerServicenowFormatter"
     assert famgw.__module_file__.endswith("pythonpath/local/lib/python/notificationforwarder/alertmanager_servicenow/formatter.py")
@@ -158,9 +158,10 @@ def test_alertmanager_forwarder(setup):
 
     amgw.forward(eventopts)
     log = open(get_logfile(amgw)).read()
+    assert "event has no node" in log
+    assert "replace node with 4490.example.net" in log
     assert re.search(r'success: alertmanager sends 2 alarms.*result is .*"records": 2.*4490.*4491.*', log, flags=re.MULTILINE)
 
     http_server.shutdown()
 
 
-

{omdnotificationforwarder-4.2 → omdnotificationforwarder-4.3}/tests/test_formatter.py

@@ -91,6 +91,64 @@ def test_split3_forwarder_split4_formatter(setup):
     assert re.search(r'forwarder '+split3.__module_file__, log)
     assert re.search(r'formatter '+fsplit3.__module_file__, log)
 
+
+def test_formatter_module_logging_uses_runtime_logfile(setup):
+    forwarderopts = {
+        "username": "i_bims",
+        "password": "dem_is_geheim"
+    }
+    eventopts = {
+        "alertmanager_payload": {
+            "receiver": "omd-servicenow-webhook",
+            "status": "firing",
+            "alerts": [
+                {
+                    "status": "firing",
+                    "labels": {
+                        "alertname": "4490",
+                        "instance": "4490.example.net",
+                        "service": "my-service",
+                        "severity": "critical",
+                        "snow_service_name": "routemetosvcnow"
+                    },
+                    "annotations": {
+                        "summary": "Testing summary!"
+                    },
+                    "startsAt": "2024-03-15T19:51:51.78480206Z",
+                    "endsAt": "0001-01-01T00:00:00Z",
+                    "generatorURL": "https://prometheus.local/<generating_expression>",
+                    "fingerprint": "5de8a3a5c73e68d4"
+                }
+            ],
+            "groupLabels": {
+                "alertname": "4490",
+                "service": "my-service"
+            },
+            "commonLabels": {
+                "alertname": "4490",
+                "instance": "4490.example.net",
+                "service": "my-service",
+                "severity": "critical",
+                "snow_service_name": "routemetosvcnow"
+            },
+            "commonAnnotations": {
+                "summary": "Testing summary!"
+            },
+            "externalURL": "http://omd-lx01.example.com/alertmanager/alertmanager",
+            "version": "4",
+            "groupKey": "{}/{alertname=~\"^(?:.*)$\",snow_service_name=~\"^(?:..*)$\"}:{alertname=\"4490\", service=\"my-service\"}",
+            "truncatedAlerts": 0
+        }
+    }
+
+    amgw = notificationforwarder.baseclass.new("webhook", None, "alertmanager_servicenow", True, True, forwarderopts)
+    amgw.forward(eventopts)
+
+    log = open(get_logfile(amgw)).read()
+    assert "event has no node" in log
+    assert "replace node with 4490.example.net" in log
+    assert "job: " in log
+
 def test_split3_forwarder_split4_formatter_bin_old(setup):
     # this is used to find out the logfile
     forwarderopts = {
@@ -123,4 +181,3 @@ def test_split3_forwarder_split4_formatter_bin(setup):
     log = open(get_logfile(split3)).read()
     assert "split4_"+signature+"_split4" in log
 
-