Skip to content

Commit

Permalink
Add Grafana Oncall notification provider (#2783)
Browse files Browse the repository at this point in the history
* Add Grafana Oncall notification provider

* Fix linter errors

* Remove useless variables

* Remove test message

Co-authored-by: Frank Elsinga <[email protected]>

* spelling consistency

* Update server/notification-providers/grafana-oncall.js

Co-authored-by: Frank Elsinga <[email protected]>

* Update server/notification-providers/grafana-oncall.js

Co-authored-by: Frank Elsinga <[email protected]>

* eslint requirements

Co-authored-by: Matthew Nickson <[email protected]>

* Add Grafana Oncall translation

* Update src/components/notifications/GrafanaOncall.vue

Co-authored-by: Frank Elsinga <[email protected]>

* Check empty url

---------

Co-authored-by: Emmanuel Cohen <[email protected]>
Co-authored-by: Frank Elsinga <[email protected]>
Co-authored-by: Matthew Nickson <[email protected]>
Co-authored-by: Louis Lam <[email protected]>
  • Loading branch information
5 people authored Oct 19, 2023
1 parent 8412e19 commit 9b599cc
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 1 deletion.
61 changes: 61 additions & 0 deletions server/notification-providers/grafana-oncall.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
const NotificationProvider = require("./notification-provider");
const axios = require("axios");
const { DOWN, UP } = require("../../src/util");

class GrafanaOncall extends NotificationProvider {

name = "GrafanaOncall";

/**
* @inheritdoc
*/
async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {

if (!notification.GrafanaOncallURL) {
throw new Error("GrafanaOncallURL cannot be empty");
}

let okMsg = "Sent Successfully.";
try {
if (heartbeatJSON === null) {
let grafanaupdata = {
title: "General notification",
message: msg,
state: "alerting",
};
await axios.post(
notification.GrafanaOncallURL,
grafanaupdata
);
return okMsg;
} else if (heartbeatJSON["status"] === DOWN) {
let grafanadowndata = {
title: monitorJSON["name"] + " is down",
message: heartbeatJSON["msg"],
state: "alerting",
};
await axios.post(
notification.GrafanaOncallURL,
grafanadowndata
);
return okMsg;
} else if (heartbeatJSON["status"] === UP) {
let grafanaupdata = {
title: monitorJSON["name"] + " is up",
message: heartbeatJSON["msg"],
state: "ok",
};
await axios.post(
notification.GrafanaOncallURL,
grafanaupdata
);
return okMsg;
}
} catch (error) {
this.throwGeneralAxiosError(error);
}

}
}

module.exports = GrafanaOncall;
2 changes: 2 additions & 0 deletions server/notification.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const FreeMobile = require("./notification-providers/freemobile");
const GoogleChat = require("./notification-providers/google-chat");
const Gorush = require("./notification-providers/gorush");
const Gotify = require("./notification-providers/gotify");
const GrafanaOncall = require("./notification-providers/grafana-oncall");
const HomeAssistant = require("./notification-providers/home-assistant");
const Kook = require("./notification-providers/kook");
const Line = require("./notification-providers/line");
Expand Down Expand Up @@ -84,6 +85,7 @@ class Notification {
new GoogleChat(),
new Gorush(),
new Gotify(),
new GrafanaOncall(),
new HomeAssistant(),
new Kook(),
new Line(),
Expand Down
1 change: 1 addition & 0 deletions src/components/NotificationDialog.vue
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ export default {
"GoogleChat": "Google Chat (Google Workspace)",
"gorush": "Gorush",
"gotify": "Gotify",
"GrafanaOncall": "Grafana Oncall",
"HomeAssistant": "Home Assistant",
"Kook": "Kook",
"line": "LINE Messenger",
Expand Down
7 changes: 7 additions & 0 deletions src/components/notifications/GrafanaOncall.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<template>
<div class="mb-3">
<label for="GrafanaOncallURL" class="form-label">{{ $t("GrafanaOncallURL") }}<span style="color: red;"><sup>*</sup></span></label>
<input id="GrafanaOncallURL" v-model="$parent.notification.GrafanaOncallURL" type="text" class="form-control" required>
</div>
</template>

2 changes: 2 additions & 0 deletions src/components/notifications/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import FreeMobile from "./FreeMobile.vue";
import GoogleChat from "./GoogleChat.vue";
import Gorush from "./Gorush.vue";
import Gotify from "./Gotify.vue";
import GrafanaOncall from "./GrafanaOncall.vue";
import HomeAssistant from "./HomeAssistant.vue";
import Kook from "./Kook.vue";
import Line from "./Line.vue";
Expand Down Expand Up @@ -71,6 +72,7 @@ const NotificationFormList = {
"GoogleChat": GoogleChat,
"gorush": Gorush,
"gotify": Gotify,
"GrafanaOncall": GrafanaOncall,
"HomeAssistant": HomeAssistant,
"Kook": Kook,
"line": Line,
Expand Down
3 changes: 2 additions & 1 deletion src/lang/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -856,5 +856,6 @@
"successDisabled": "Disabled Successfully.",
"successEnabled": "Enabled Successfully.",
"tagNotFound": "Tag not found.",
"foundChromiumVersion": "Found Chromium/Chrome. Version: {0}"
"foundChromiumVersion": "Found Chromium/Chrome. Version: {0}",
"GrafanaOncallUrl": "Grafana Oncall URL"
}

0 comments on commit 9b599cc

Please sign in to comment.