search

bgptools / issues

The public issue tracker for bgp.tools
29 stars 8 forks source link

feat/chore: improved Discord webhooks #153

Open mymindishazel opened 1 month ago

mymindishazel commented 1 month ago

I have four ideas on things that would make understanding the notifications at a glance easier:

  1. use new Discord markdown features to reduce cognitive load
    • masked links ([example](https://example.com)) can hide away long URLs
    • smallprint (-# example) can visually deprioritize less important or repetitive information
  2. highlight what is important, e.g. through bold text
  3. suppress embeds (<https://example.com>) for URLs sent in the message to further reduce cognitive load
  4. use different icons for each action to be able to quickly tell them apart; right now e.g. new upstream :chart_with_upwards_trend: and new route :chart_with_upwards_trend: share the same icon

as a visual example: before screenshot of the current Discord webhook notifications showcasing the following notification types: upstream gained, upstream lost, new route originated, route lost connectivity after screenshot of redesigned Discord webhook notifications utilizing the above talking points

mymindishazel commented 1 month ago

Source for the example messages:

🔺 **AS23456** (4-Byte Autonomous System Number Placeholder) has been detected as a new upstream
-# bgp.tools alert for AS65534 â‹… [more details](<https://bgp.tools/authed/manage-alerts?detail=e9e80e88-c2c3-4a5f-84c0-f4b5c0a3e366>)
🔻 **AS23456** (4-Byte Autonomous System Number Placeholder) has been lost as an upstream
-# bgp.tools alert for AS65534
📈 The prefix **2001:db8::/32** is now being originated
-# bgp.tools alert for AS65534
📉 The prefix **2001:db8::/32** has lost visibility from the global routing table
-# bgp.tools alert for AS65534