feat: add discord embed notification

Author: janezicmatej

configuration/config.py

@@ -100,6 +100,11 @@ def get_notification_config() -> Notification:
     if discord_webhook is not None:
         discord.extend(discord_webhook.split(","))
 
+    discord_embed_webhook = os.environ.get("NOTIFICATION_DISCORD_EMBED_WEBHOOK")
+    discord_embed = []
+    if discord_embed_webhook is not None:
+        discord_embed.extend(discord_embed_webhook.split(","))
+
     slack_webhook = os.environ.get("NOTIFICATION_SLACK_WEBHOOK")
     slack = []
     if slack_webhook is not None:
@@ -120,6 +125,7 @@ def get_notification_config() -> Notification:
 
     return Notification(
         discord=NotificationDiscord(discord),
+        discord_embed=NotificationDiscord(discord_embed),
         slack=NotificationSlack(slack),
         telegram=NotificationTelegram(telegram),
         generic=NotificationGeneric(generic),

configuration/types.py

@@ -244,6 +244,7 @@ class NotificationGeneric:
 @frozen
 class Notification:
     discord: NotificationDiscord
+    discord_embed: NotificationDiscord
     slack: NotificationSlack
     telegram: NotificationTelegram
     generic: NotificationGeneric

observer/message.py

@@ -22,29 +22,20 @@ class Message:
     level: MessageLevel
     message: str
 
-    @classmethod
-    def builder(cls) -> "MessageBuilder":
-        return MessageBuilder()
-
-
-@define
-class MessageBuilder:
-    level: MessageLevel | None = None
-    message: str | None = None
-
     network: int | None = None
     round: VotingEpoch | None = None
     protocol: ProtocolId | None = None
 
-    def copy(self) -> Self:
-        return copy.copy(self)
-
-    def _build(self) -> Message:
-        assert self.level is not None
-        assert self.message is not None
+    @classmethod
+    def builder(cls) -> "MessageBuilder":
+        return MessageBuilder()
 
+    def build_str(self, with_log=False) -> str:
         s = io.StringIO()
 
+        if with_log:
+            s.write(f"[{self.level.name}] ")
+
         if self.network is not None:
             network = ChainId.id_to_name(self.network)
             s.write(f"network:{network} ")
@@ -59,7 +50,32 @@ def _build(self) -> Message:
         s.write(self.message)
 
         s.seek(0)
-        return Message(level=self.level, message=s.read())
+        return s.read()
+
+
+@define
+class MessageBuilder:
+    level: MessageLevel | None = None
+    message: str | None = None
+
+    network: int | None = None
+    round: VotingEpoch | None = None
+    protocol: ProtocolId | None = None
+
+    def copy(self) -> Self:
+        return copy.copy(self)
+
+    def _build(self) -> Message:
+        assert self.level is not None
+        assert self.message is not None
+
+        return Message(
+            level=self.level,
+            message=self.message,
+            network=self.network,
+            round=self.round,
+            protocol=self.protocol,
+        )
 
     def build(self, level: MessageLevel, message: str) -> Message:
         return self.copy().add(level=level, message=message)._build()

observer/notification.py

@@ -1,15 +1,18 @@
+from collections import defaultdict
+from datetime import datetime, timezone
 from typing import Any
 
 import requests
 
+from configuration.config import ChainId, Protocol
 from configuration.types import (
     NotificationDiscord,
     NotificationGeneric,
     NotificationSlack,
     NotificationTelegram,
 )
 
-from .message import Message
+from .message import Message, MessageLevel
 
 
 def notify(
@@ -26,37 +29,111 @@ def notify(
         pass
 
 
-def notify_discord(config: NotificationDiscord, message: str) -> None:
+def notify_discord(config: NotificationDiscord, message: Message) -> None:
     for u in config.webhook_url:
         notify(
             u,
             "POST",
             headers={"Content-Type": "application/json"},
-            json={"content": message},
+            json={"content": message.build_str(with_log=True)},
         )
 
 
-def notify_slack(config: NotificationSlack, message: str) -> None:
+LEVEL_COLORS = defaultdict(
+    lambda: 0x95A5A6,
+    {
+        MessageLevel.DEBUG: 0x3498DB,  # Blue
+        MessageLevel.INFO: 0x2ECC71,  # Green
+        MessageLevel.WARNING: 0xF1C40F,  # Yellow
+        MessageLevel.ERROR: 0xE74C3C,  # Red
+        MessageLevel.CRITICAL: 0x992D22,  # Dark Red
+    },
+)
+
+
+def get_icon_url(network: int) -> str:
+    network_name = ChainId.id_to_name(network)
+    return (
+        "https://raw.githubusercontent.com/flare-foundation/fsp-observer/main"
+        f"/assets/{network_name}.png"
+    )
+
+
+def notify_discord_embed(config: NotificationDiscord, message: Message) -> None:
+    color = LEVEL_COLORS[message.level]
+
+    fields = []
+    if message.protocol is not None:
+        fields.append(
+            {
+                "name": "Protocol",
+                "value": Protocol.id_to_name(message.protocol).upper(),
+                "inline": True,
+            }
+        )
+
+    if message.round is not None:
+        fields.append(
+            {
+                "name": "Round",
+                "value": str(message.round.id),
+                "inline": True,
+            }
+        )
+
+    embed = {
+        "author": {
+            "name": f"fsp-observer @ {ChainId.id_to_name(message.network)}",
+            "url": "https://github.com/flare-foundation/fsp-observer",
+        },
+        "title": f"{message.level.name.title()}",
+        "description": f"{message.message}",
+        "color": color,
+        "fields": fields,
+        "timestamp": datetime.now(timezone.utc).isoformat(),
+        "footer": {
+            "text": "Flare Network",
+            "icon_url": get_icon_url(ChainId.FLARE),
+        },
+    }
+
+    if message.network is not None:
+        embed["thumbnail"] = {
+            "url": get_icon_url(message.network),
+            "height": 32,
+            "width": 32,
+        }
+
+    for u in config.webhook_url:
+        notify(
+            u,
+            "POST",
+            headers={"Content-Type": "application/json"},
+            json={"embeds": [embed]},
+        )
+
+
+def notify_slack(config: NotificationSlack, message: Message) -> None:
     for u in config.webhook_url:
         notify(
             u,
             "POST",
             headers={"Content-Type": "application/json"},
-            json={"text": message},
+            json={"text": message.build_str(with_log=True)},
         )
 
 
-def notify_telegram(config: NotificationTelegram, message: str) -> None:
+def notify_telegram(config: NotificationTelegram, message: Message) -> None:
     for t in config.bot:
         notify(
             f"https://api.telegram.org/bot{t.bot_token}/sendMessage",
             "POST",
             headers={"Content-Type": "application/json"},
-            json={"chat_id": t.chat_id, "text": message},
+            json={"chat_id": t.chat_id, "text": message.build_str(with_log=True)},
         )
 
 
-def notify_generic(config: NotificationGeneric, issue: "Message") -> None:
+def notify_generic(config: NotificationGeneric, issue: Message) -> None:
     for u in config.webhook_url:
         notify(
             u,

observer/observer.py

@@ -55,7 +55,13 @@
 from observer.validation.validation import extract_round_for_entity, validate_round
 
 from .message import Message, MessageLevel
-from .notification import notify_discord, notify_generic, notify_slack, notify_telegram
+from .notification import (
+    notify_discord,
+    notify_discord_embed,
+    notify_generic,
+    notify_slack,
+    notify_telegram,
+)
 from .voting_round import (
     VotingRoundManager,
     WTxData,
@@ -294,11 +300,10 @@ def log_message(config: Configuration, message: Message):
 
     n = config.notification
 
-    lvl_msg = f"{message.level.name} {message.message}"
-
-    notify_discord(n.discord, lvl_msg)
-    notify_slack(n.slack, lvl_msg)
-    notify_telegram(n.telegram, lvl_msg)
+    notify_discord(n.discord, message)
+    notify_discord_embed(n.discord_embed, message)
+    notify_slack(n.slack, message)
+    notify_telegram(n.telegram, message)
     notify_generic(n.generic, message)