Add Opsgenie notification support. (#12)

devopsforhumans · Apr 24, 2024 · d0b24c8 · d0b24c8
1 parent 51e245c
commit d0b24c8
Show file tree

Hide file tree

Showing 10 changed files with 413 additions and 413 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,12 @@
 # Changelog
 
-## 0.0.1-alpha.4(25.01.2024)
+## 0.0.1-alpha.5 (25.04.2024)
+
+- Add `Opsgenie` notification support
+- Update documentation
+- Update dependencies
+
+## 0.0.1-alpha.4 (25.01.2024)
 
 - Add delete monitor by monitor id
 - Add `bump-my-version` for version handling

diff --git a/Pipfile b/Pipfile
@@ -7,7 +7,7 @@ name = "pypi"
 "python-socketio[client]" = ">=5.11.0"
 pyyaml = ">=6.0.1"
 requests = ">=2.31.0"
-"typer[all]" = ">=0.9.0"
+typer = ">=0.12.3"
 validators = ">=0.22.0"
 
 [dev-packages]

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -103,9 +103,10 @@ pip install -e .
 ### Notification
 
 - Supported notification providers (tested)
+    [x] Opsgenie
   - [x] Rocket.Chat
   - [x] Slack
-  - [x] MS Teams
+  - [x] Teams
   - [x] Webhook
 - [x] List all `notification`(s).
 - [x] See details of a `single notification` by name/id.

diff --git a/docs/source/notifications.md b/docs/source/notifications.md
@@ -12,8 +12,16 @@ Example configuration of `notificaiton` provider config file
 ```yaml
 ---
 notifications:
+  - opsgenie:
+      name: "Opsgenie Nofification"
+      type: "Opsgenie"
+      is_default: false
+      apply_existing: false
+      opsgeniePriority: 1
+      opsgenieRegion: "eu" # us(default)/eu
+      opsgenieApiKey: "something"
   - rocketchat:
-      name: "Uptime notification"
+      name: "RocketChat Notification"
       type: "rocket.chat"
       is_default: false
       apply_existing: false
@@ -36,9 +44,10 @@ Following notification providers are supported by **`kumaone`** NOT `uptime kuma
 support for `uptime kuma` [please see here](https://github.com/louislam/uptime-kuma/wiki/Notification-Methods).
 ```
 
-- MS Teams
+- Opsgenie
 - Rocket.Chat
 - Slack
+- Teams
 - Webhook
 
 ```{seealso}

diff --git a/examples/notification.config.example.yaml b/examples/notification.config.example.yaml
@@ -1,7 +1,15 @@
 ---
 notifications:
+  - opsgenie:
+      name: "Opsgenie Nofification"
+      type: "Opsgenie"
+      is_default: false
+      apply_existing: false
+      opsgeniePriority: 1
+      opsgenieRegion: "eu" # us(default)/eu
+      opsgenieApiKey: "something"
   - rocketchat:
-      name: "Uptime notification"
+      name: "RocketChat Notification"
       type: "rocket.chat"
       is_default: false
       apply_existing: false

diff --git a/pyproject.toml b/pyproject.toml
@@ -29,7 +29,7 @@ dependencies = [
   "python-socketio[client] >= 5.11.0",
   "pyyaml >= 6.0.1",
   "requests >= 2.31.0",
-  "typer[all] >= 0.9.0",
+  "typer >= 0.12.3",
   "validators >= 0.22.0"
 ]
 
@@ -182,7 +182,7 @@ exclude_lines = [
 ]
 
 [tool.bumpversion]
-current_version = "0.0.1-alpha.4"
+current_version = "0.0.1-alpha.5"
 #parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 #serialize = ["{major}.{minor}.{patch}"]
 parse = """(?x)

diff --git a/src/kumaone/__about__.py b/src/kumaone/__about__.py
@@ -7,7 +7,7 @@
 
 year = datetime.now().year
 
-__version__ = "0.0.1-alpha.4"
+__version__ = "0.0.1-alpha.5"
 __author__ = "Dalwar Hossain"
 __license__ = "BSD 3-Clause"
 __home_page__ = "https://kumaone.rtfd.io"

diff --git a/src/kumaone/notification_settings.py b/src/kumaone/notification_settings.py
@@ -7,6 +7,11 @@
 __email__ = "dalwar23@pm.me"
 
 notification_providers = {
+    "opsgenie":{
+        "opsgeniePriority": "",
+        "opsgenieRegion": "",
+        "opsgenieApiKey": "",
+    },
     "rocket.chat": {
         "rocketchannel": "",
         "rocketusername": "",

diff --git a/src/kumaone/payload_handler.py b/src/kumaone/payload_handler.py
@@ -120,7 +120,7 @@ def _get_monitor_payload(
         accepted_statuscodes = ["200-299"]
 
     if notificationIDList is None:
-        notificationIDList = []
+        notificationIDList = {}
 
     monitor_data = {
         "type": type,