From ccec34ff5da20140640b13b289abfedf7b3b3c7a Mon Sep 17 00:00:00 2001 From: Anthony Graignic Date: Tue, 23 Feb 2021 14:32:08 +0200 Subject: [PATCH] Add Discord notification (#35) add discord notification --- .github/workflows/deploy.yml | 3 +++ README.md | 7 ++++++- src/functions/cronTrigger.js | 10 ++++++++++ src/functions/helpers.js | 24 ++++++++++++++++++++++++ 4 files changed, 43 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index a6cbb8b61..ccfa3c403 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -34,15 +34,18 @@ jobs: [ -z "$SECRET_SLACK_WEBHOOK_URL" ] && echo "Secret SECRET_SLACK_WEBHOOK_URL not set, creating dummy one..." && SECRET_SLACK_WEBHOOK_URL="default-gh-action-secret" || true [ -z "$SECRET_TELEGRAM_API_TOKEN" ] && echo "Secret SECRET_TELEGRAM_API_TOKEN not set, creating dummy one..." && SECRET_TELEGRAM_API_TOKEN="default-gh-action-secret" || true [ -z "$SECRET_TELEGRAM_CHAT_ID" ] && echo "Secret SECRET_TELEGRAM_CHAT_ID not set, creating dummy one..." && SECRET_TELEGRAM_CHAT_ID="default-gh-action-secret" || true + [ -z "$SECRET_DISCORD_WEBHOOK_URL" ] && echo "Secret SECRET_DISCORD_WEBHOOK_URL not set, creating dummy one..." && SECRET_DISCORD_WEBHOOK_URL="default-gh-action-secret" || true postCommands: | yarn kv-gc secrets: | SECRET_SLACK_WEBHOOK_URL SECRET_TELEGRAM_API_TOKEN SECRET_TELEGRAM_CHAT_ID + SECRET_DISCORD_WEBHOOK_URL environment: production env: CF_ACCOUNT_ID: ${{ secrets.CF_ACCOUNT_ID }} SECRET_SLACK_WEBHOOK_URL: ${{secrets.SECRET_SLACK_WEBHOOK_URL}} SECRET_TELEGRAM_API_TOKEN: ${{secrets.SECRET_TELEGRAM_API_TOKEN}} SECRET_TELEGRAM_CHAT_ID: ${{secrets.SECRET_TELEGRAM_CHAT_ID}} + SECRET_DISCORD_WEBHOOK_URL: ${{secrets.SECRET_DISCORD_WEBHOOK_URL}} diff --git a/README.md b/README.md index 79afc4e9d..d59e00eac 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Also, prepare the following secrets - Cloudflare API token with `Edit Cloudflare Workers` permissions - Slack incoming webhook \(optional\) +- Discord incoming webhook \(optional\) ## Getting started @@ -38,6 +39,9 @@ You can either deploy with **Cloudflare Deploy Button** using GitHub Actions or - Name: SECRET_SLACK_WEBHOOK_URL (optional) - Value: your-slack-webhook-url + + - Name: SECRET_DISCORD_WEBHOOK_URL (optional) + - Value: your-discord-webhook-url ``` 3. Navigate to the **Actions** settings in your repository and enable them @@ -46,7 +50,7 @@ You can either deploy with **Cloudflare Deploy Button** using GitHub Actions or ```yaml settings: title: 'Status Page' - url: 'https://status-page.eidam.dev' # used for Slack messages + url: 'https://status-page.eidam.dev' # used for Slack & Discord messages logo: logo-192x192.png # image in ./public/ folder daysInHistogram: 90 # number of days you want to display in histogram collectResponseTimes: false # experimental feature, enable only for <5 monitors or on paid plans @@ -96,6 +100,7 @@ You can clone the repository yourself and use Wrangler CLI to develop/deploy, ex - create KV namespace and add the `KV_STATUS_PAGE` binding to [wrangler.toml](./wrangler.toml) - create Worker secrets _\(optional\)_ - `SECRET_SLACK_WEBHOOK_URL` + - `SECRET_DISCORD_WEBHOOK_URL` ## Workers KV free tier diff --git a/src/functions/cronTrigger.js b/src/functions/cronTrigger.js index e273de93f..f18a2601a 100644 --- a/src/functions/cronTrigger.js +++ b/src/functions/cronTrigger.js @@ -6,6 +6,7 @@ import { getCheckLocation, getKVMonitors, setKVMonitors, + notifyDiscord, } from './helpers' function getDate() { @@ -88,6 +89,15 @@ export async function processCronTrigger(event) { event.waitUntil(notifyTelegram(monitor, monitorOperational)) } + // Send Discord message on monitor change + if ( + monitorStatusChanged && + typeof SECRET_DISCORD_WEBHOOK_URL !== 'undefined' && + SECRET_DISCORD_WEBHOOK_URL !== 'default-gh-action-secret' + ) { + event.waitUntil(notifyDiscord(monitor, monitorOperational)) + } + // make sure checkDay exists in checks in cases when needed if ( (config.settings.collectResponseTimes || !monitorOperational) && diff --git a/src/functions/helpers.js b/src/functions/helpers.js index 2fa5a490c..f4f5327f1 100644 --- a/src/functions/helpers.js +++ b/src/functions/helpers.js @@ -90,6 +90,30 @@ export async function notifyTelegram(monitor, operational) { }) } +// Visualize your payload using https://leovoel.github.io/embed-visualizer/ +export async function notifyDiscord(monitor, operational) { + const payload = { + username: `${config.settings.title}`, + avatar_url: `${config.settings.url}/${config.settings.logo}`, + embeds: [ + { + title: `${monitor.name} is ${getOperationalLabel(operational)} ${ + operational ? ':white_check_mark:' : ':x:' + }`, + description: `\`${monitor.method ? monitor.method : 'GET'} ${ + monitor.url + }\` - :eyes: [Status Page](${config.settings.url})`, + color: operational ? 3581519 : 13632027, + }, + ], + } + return fetch(SECRET_DISCORD_WEBHOOK_URL, { + body: JSON.stringify(payload), + method: 'POST', + headers: { 'Content-Type': 'application/json' }, + }) +} + export function useKeyPress(targetKey) { const [keyPressed, setKeyPressed] = useState(false)