Dj Isaac
1 month ago
committed by
GitHub
commit
64f528456d
@ -0,0 +1,17 @@
|
|||||||
|
exports.up = function (knex) {
|
||||||
|
return knex.schema.alterTable("monitor", function (table) {
|
||||||
|
table.text("rabbitmq_nodes");
|
||||||
|
table.string("rabbitmq_username");
|
||||||
|
table.string("rabbitmq_password");
|
||||||
|
});
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
exports.down = function (knex) {
|
||||||
|
return knex.schema.alterTable("monitor", function (table) {
|
||||||
|
table.dropColumn("rabbitmq_nodes");
|
||||||
|
table.dropColumn("rabbitmq_username");
|
||||||
|
table.dropColumn("rabbitmq_password");
|
||||||
|
});
|
||||||
|
|
||||||
|
};
|
||||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,67 @@
|
|||||||
|
const { MonitorType } = require("./monitor-type");
|
||||||
|
const { log, UP, DOWN } = require("../../src/util");
|
||||||
|
const { axiosAbortSignal } = require("../util-server");
|
||||||
|
const axios = require("axios");
|
||||||
|
|
||||||
|
class RabbitMqMonitorType extends MonitorType {
|
||||||
|
name = "rabbitmq";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @inheritdoc
|
||||||
|
*/
|
||||||
|
async check(monitor, heartbeat, server) {
|
||||||
|
let baseUrls = [];
|
||||||
|
try {
|
||||||
|
baseUrls = JSON.parse(monitor.rabbitmqNodes);
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error("Invalid RabbitMQ Nodes");
|
||||||
|
}
|
||||||
|
|
||||||
|
heartbeat.status = DOWN;
|
||||||
|
for (let baseUrl of baseUrls) {
|
||||||
|
try {
|
||||||
|
// Without a trailing slash, path in baseUrl will be removed. https://example.com/api -> https://example.com
|
||||||
|
if ( !baseUrl.endsWith("/") ) {
|
||||||
|
baseUrl += "/";
|
||||||
|
}
|
||||||
|
const options = {
|
||||||
|
// Do not start with slash, it will strip the trailing slash from baseUrl
|
||||||
|
url: new URL("api/health/checks/alarms/", baseUrl).href,
|
||||||
|
method: "get",
|
||||||
|
timeout: monitor.timeout * 1000,
|
||||||
|
headers: {
|
||||||
|
"Accept": "application/json",
|
||||||
|
"Authorization": "Basic " + Buffer.from(`${monitor.rabbitmqUsername || ""}:${monitor.rabbitmqPassword || ""}`).toString("base64"),
|
||||||
|
},
|
||||||
|
signal: axiosAbortSignal((monitor.timeout + 10) * 1000),
|
||||||
|
// Capture reason for 503 status
|
||||||
|
validateStatus: (status) => status === 200 || status === 503,
|
||||||
|
};
|
||||||
|
log.debug("monitor", `[${monitor.name}] Axios Request: ${JSON.stringify(options)}`);
|
||||||
|
const res = await axios.request(options);
|
||||||
|
log.debug("monitor", `[${monitor.name}] Axios Response: status=${res.status} body=${JSON.stringify(res.data)}`);
|
||||||
|
if (res.status === 200) {
|
||||||
|
heartbeat.status = UP;
|
||||||
|
heartbeat.msg = "OK";
|
||||||
|
break;
|
||||||
|
} else if (res.status === 503) {
|
||||||
|
heartbeat.msg = res.data.reason;
|
||||||
|
} else {
|
||||||
|
heartbeat.msg = `${res.status} - ${res.statusText}`;
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
if (axios.isCancel(error)) {
|
||||||
|
heartbeat.msg = "Request timed out";
|
||||||
|
log.debug("monitor", `[${monitor.name}] Request timed out`);
|
||||||
|
} else {
|
||||||
|
log.debug("monitor", `[${monitor.name}] Axios Error: ${JSON.stringify(error.message)}`);
|
||||||
|
heartbeat.msg = error.message;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
RabbitMqMonitorType,
|
||||||
|
};
|
||||||
@ -0,0 +1,35 @@
|
|||||||
|
const NotificationProvider = require("./notification-provider");
|
||||||
|
const axios = require("axios");
|
||||||
|
|
||||||
|
class Elks extends NotificationProvider {
|
||||||
|
name = "Elks";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @inheritdoc
|
||||||
|
*/
|
||||||
|
async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
|
||||||
|
const okMsg = "Sent Successfully.";
|
||||||
|
const url = "https://api.46elks.com/a1/sms";
|
||||||
|
|
||||||
|
try {
|
||||||
|
let data = new URLSearchParams();
|
||||||
|
data.append("from", notification.elksFromNumber);
|
||||||
|
data.append("to", notification.elksToNumber );
|
||||||
|
data.append("message", msg);
|
||||||
|
|
||||||
|
const config = {
|
||||||
|
headers: {
|
||||||
|
"Authorization": "Basic " + Buffer.from(`${notification.elksUsername}:${notification.elksAuthToken}`).toString("base64")
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
await axios.post(url, data, config);
|
||||||
|
|
||||||
|
return okMsg;
|
||||||
|
} catch (error) {
|
||||||
|
this.throwGeneralAxiosError(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = Elks;
|
||||||
@ -0,0 +1,65 @@
|
|||||||
|
const NotificationProvider = require("./notification-provider");
|
||||||
|
const axios = require("axios");
|
||||||
|
|
||||||
|
class SendGrid extends NotificationProvider {
|
||||||
|
name = "SendGrid";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @inheritdoc
|
||||||
|
*/
|
||||||
|
async send(notification, msg, monitorJSON = null, heartbeatJSON = null) {
|
||||||
|
const okMsg = "Sent Successfully.";
|
||||||
|
|
||||||
|
try {
|
||||||
|
let config = {
|
||||||
|
headers: {
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
Authorization: `Bearer ${notification.sendgridApiKey}`,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
let personalizations = {
|
||||||
|
to: [{ email: notification.sendgridToEmail }],
|
||||||
|
};
|
||||||
|
|
||||||
|
// Add CC recipients if provided
|
||||||
|
if (notification.sendgridCcEmail) {
|
||||||
|
personalizations.cc = notification.sendgridCcEmail
|
||||||
|
.split(",")
|
||||||
|
.map((email) => ({ email: email.trim() }));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add BCC recipients if provided
|
||||||
|
if (notification.sendgridBccEmail) {
|
||||||
|
personalizations.bcc = notification.sendgridBccEmail
|
||||||
|
.split(",")
|
||||||
|
.map((email) => ({ email: email.trim() }));
|
||||||
|
}
|
||||||
|
|
||||||
|
let data = {
|
||||||
|
personalizations: [ personalizations ],
|
||||||
|
from: { email: notification.sendgridFromEmail.trim() },
|
||||||
|
subject:
|
||||||
|
notification.sendgridSubject ||
|
||||||
|
"Notification from Your Uptime Kuma",
|
||||||
|
content: [
|
||||||
|
{
|
||||||
|
type: "text/plain",
|
||||||
|
value: msg,
|
||||||
|
},
|
||||||
|
],
|
||||||
|
};
|
||||||
|
|
||||||
|
await axios.post(
|
||||||
|
"https://api.sendgrid.com/v3/mail/send",
|
||||||
|
data,
|
||||||
|
config
|
||||||
|
);
|
||||||
|
return okMsg;
|
||||||
|
} catch (error) {
|
||||||
|
this.throwGeneralAxiosError(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = SendGrid;
|
||||||
@ -0,0 +1,48 @@
|
|||||||
|
<template>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="ElksUsername" class="form-label">{{ $t("Username") }}</label>
|
||||||
|
<input id="ElksUsername" v-model="$parent.notification.elksUsername" type="text" class="form-control" required>
|
||||||
|
<label for="ElksPassword" class="form-label">{{ $t("Password") }}</label>
|
||||||
|
</div>
|
||||||
|
<div class="form-text">
|
||||||
|
<HiddenInput id="ElksPassword" v-model="$parent.notification.elksAuthToken" :required="true" autocomplete="new-password"></HiddenInput>
|
||||||
|
<i18n-t tag="p" keypath="Can be found on:">
|
||||||
|
<a href="https://46elks.com/account" target="_blank">https://46elks.com/account</a>
|
||||||
|
</i18n-t>
|
||||||
|
</div>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="Elks-from-number" class="form-label">{{ $t("From") }}</label>
|
||||||
|
<input id="Elks-from-number" v-model="$parent.notification.elksFromNumber" type="text" class="form-control" required>
|
||||||
|
<div class="form-text">
|
||||||
|
{{ $t("Either a text sender ID or a phone number in E.164 format if you want to be able to receive replies.") }}
|
||||||
|
<i18n-t tag="p" keypath="More info on:">
|
||||||
|
<a href="https://46elks.se/kb/text-sender-id" target="_blank">https://46elks.se/kb/text-sender-id</a>
|
||||||
|
</i18n-t>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="Elks-to-number" class="form-label">{{ $t("To Number") }}</label>
|
||||||
|
<input id="Elks-to-number" v-model="$parent.notification.elksToNumber" type="text" class="form-control" required>
|
||||||
|
<div class="form-text">
|
||||||
|
{{ $t("The phone number of the recipient in E.164 format.") }}
|
||||||
|
<i18n-t tag="p" keypath="More info on:">
|
||||||
|
<a href="https://46elks.se/kb/e164" target="_blank">https://46elks.se/kb/e164</a>
|
||||||
|
</i18n-t>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<i18n-t tag="p" keypath="More info on:" style="margin-top: 8px;">
|
||||||
|
<a href="https://46elks.com/docs/send-sms" target="_blank">https://46elks.com/docs/send-sms</a>
|
||||||
|
</i18n-t>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
import HiddenInput from "../HiddenInput.vue";
|
||||||
|
|
||||||
|
export default {
|
||||||
|
components: {
|
||||||
|
HiddenInput,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
</script>
|
||||||
@ -0,0 +1,47 @@
|
|||||||
|
<template>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="sendgrid-api-key" class="form-label">{{ $t("SendGrid API Key") }}</label>
|
||||||
|
<HiddenInput id="push-api-key" v-model="$parent.notification.sendgridApiKey" :required="true" autocomplete="new-password"></HiddenInput>
|
||||||
|
</div>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="sendgrid-from-email" class="form-label">{{ $t("From Email") }}</label>
|
||||||
|
<input id="sendgrid-from-email" v-model="$parent.notification.sendgridFromEmail" type="email" class="form-control" required>
|
||||||
|
</div>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="sendgrid-to-email" class="form-label">{{ $t("To Email") }}</label>
|
||||||
|
<input id="sendgrid-to-email" v-model="$parent.notification.sendgridToEmail" type="email" class="form-control" required>
|
||||||
|
</div>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="sendgrid-cc-email" class="form-label">{{ $t("smtpCC") }}</label>
|
||||||
|
<input id="sendgrid-cc-email" v-model="$parent.notification.sendgridCcEmail" type="email" class="form-control">
|
||||||
|
<div class="form-text">{{ $t("Separate multiple email addresses with commas") }}</div>
|
||||||
|
</div>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="sendgrid-bcc-email" class="form-label">{{ $t("smtpBCC") }}</label>
|
||||||
|
<input id="sendgrid-bcc-email" v-model="$parent.notification.sendgridBccEmail" type="email" class="form-control">
|
||||||
|
<small class="form-text text-muted">{{ $t("Separate multiple email addresses with commas") }}</small>
|
||||||
|
</div>
|
||||||
|
<div class="mb-3">
|
||||||
|
<label for="sendgrid-subject" class="form-label">{{ $t("Subject:") }}</label>
|
||||||
|
<input id="sendgrid-subject" v-model="$parent.notification.sendgridSubject" type="text" class="form-control">
|
||||||
|
<small class="form-text text-muted">{{ $t("leave blank for default subject") }}</small>
|
||||||
|
</div>
|
||||||
|
<i18n-t tag="p" keypath="More info on:" style="margin-top: 8px;">
|
||||||
|
<a href="https://docs.sendgrid.com/api-reference/mail-send/mail-send" target="_blank">https://docs.sendgrid.com/api-reference/mail-send/mail-send</a>
|
||||||
|
</i18n-t>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
import HiddenInput from "../HiddenInput.vue";
|
||||||
|
|
||||||
|
export default {
|
||||||
|
components: {
|
||||||
|
HiddenInput,
|
||||||
|
},
|
||||||
|
mounted() {
|
||||||
|
if (typeof this.$parent.notification.sendgridSubject === "undefined") {
|
||||||
|
this.$parent.notification.sendgridSubject = "Notification from Your Uptime Kuma";
|
||||||
|
}
|
||||||
|
},
|
||||||
|
};
|
||||||
|
</script>
|
||||||
@ -0,0 +1 @@
|
|||||||
|
{}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
{}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
{}
|
||||||
@ -0,0 +1,102 @@
|
|||||||
|
const { describe, test } = require("node:test");
|
||||||
|
const assert = require("node:assert");
|
||||||
|
const { HiveMQContainer } = require("@testcontainers/hivemq");
|
||||||
|
const mqtt = require("mqtt");
|
||||||
|
const { MqttMonitorType } = require("../../server/monitor-types/mqtt");
|
||||||
|
const { UP, PENDING } = require("../../src/util");
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs an MQTT test with the
|
||||||
|
* @param {string} mqttSuccessMessage the message that the monitor expects
|
||||||
|
* @param {null|"keyword"|"json-query"} mqttCheckType the type of check we perform
|
||||||
|
* @param {string} receivedMessage what message is recieved from the mqtt channel
|
||||||
|
* @returns {Promise<Heartbeat>} the heartbeat produced by the check
|
||||||
|
*/
|
||||||
|
async function testMqtt(mqttSuccessMessage, mqttCheckType, receivedMessage) {
|
||||||
|
const hiveMQContainer = await new HiveMQContainer().start();
|
||||||
|
const connectionString = hiveMQContainer.getConnectionString();
|
||||||
|
const mqttMonitorType = new MqttMonitorType();
|
||||||
|
const monitor = {
|
||||||
|
jsonPath: "firstProp", // always return firstProp for the json-query monitor
|
||||||
|
hostname: connectionString.split(":", 2).join(":"),
|
||||||
|
mqttTopic: "test",
|
||||||
|
port: connectionString.split(":")[2],
|
||||||
|
mqttUsername: null,
|
||||||
|
mqttPassword: null,
|
||||||
|
interval: 20, // controls the timeout
|
||||||
|
mqttSuccessMessage: mqttSuccessMessage, // for keywords
|
||||||
|
expectedValue: mqttSuccessMessage, // for json-query
|
||||||
|
mqttCheckType: mqttCheckType,
|
||||||
|
};
|
||||||
|
const heartbeat = {
|
||||||
|
msg: "",
|
||||||
|
status: PENDING,
|
||||||
|
};
|
||||||
|
|
||||||
|
const testMqttClient = mqtt.connect(hiveMQContainer.getConnectionString());
|
||||||
|
testMqttClient.on("connect", () => {
|
||||||
|
testMqttClient.subscribe("test", (error) => {
|
||||||
|
if (!error) {
|
||||||
|
testMqttClient.publish("test", receivedMessage);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
try {
|
||||||
|
await mqttMonitorType.check(monitor, heartbeat, {});
|
||||||
|
} finally {
|
||||||
|
testMqttClient.end();
|
||||||
|
hiveMQContainer.stop();
|
||||||
|
}
|
||||||
|
return heartbeat;
|
||||||
|
}
|
||||||
|
|
||||||
|
describe("MqttMonitorType", {
|
||||||
|
concurrency: true,
|
||||||
|
skip: !!process.env.CI && (process.platform !== "linux" || process.arch !== "x64")
|
||||||
|
}, () => {
|
||||||
|
test("valid keywords (type=default)", async () => {
|
||||||
|
const heartbeat = await testMqtt("KEYWORD", null, "-> KEYWORD <-");
|
||||||
|
assert.strictEqual(heartbeat.status, UP);
|
||||||
|
assert.strictEqual(heartbeat.msg, "Topic: test; Message: -> KEYWORD <-");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("valid keywords (type=keyword)", async () => {
|
||||||
|
const heartbeat = await testMqtt("KEYWORD", "keyword", "-> KEYWORD <-");
|
||||||
|
assert.strictEqual(heartbeat.status, UP);
|
||||||
|
assert.strictEqual(heartbeat.msg, "Topic: test; Message: -> KEYWORD <-");
|
||||||
|
});
|
||||||
|
test("invalid keywords (type=default)", async () => {
|
||||||
|
await assert.rejects(
|
||||||
|
testMqtt("NOT_PRESENT", null, "-> KEYWORD <-"),
|
||||||
|
new Error("Message Mismatch - Topic: test; Message: -> KEYWORD <-"),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("invalid keyword (type=keyword)", async () => {
|
||||||
|
await assert.rejects(
|
||||||
|
testMqtt("NOT_PRESENT", "keyword", "-> KEYWORD <-"),
|
||||||
|
new Error("Message Mismatch - Topic: test; Message: -> KEYWORD <-"),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
test("valid json-query", async () => {
|
||||||
|
// works because the monitors' jsonPath is hard-coded to "firstProp"
|
||||||
|
const heartbeat = await testMqtt("present", "json-query", "{\"firstProp\":\"present\"}");
|
||||||
|
assert.strictEqual(heartbeat.status, UP);
|
||||||
|
assert.strictEqual(heartbeat.msg, "Message received, expected value is found");
|
||||||
|
});
|
||||||
|
test("invalid (because query fails) json-query", async () => {
|
||||||
|
// works because the monitors' jsonPath is hard-coded to "firstProp"
|
||||||
|
await assert.rejects(
|
||||||
|
testMqtt("[not_relevant]", "json-query", "{}"),
|
||||||
|
new Error("Message received but value is not equal to expected value, value was: [undefined]"),
|
||||||
|
);
|
||||||
|
});
|
||||||
|
test("invalid (because successMessage fails) json-query", async () => {
|
||||||
|
// works because the monitors' jsonPath is hard-coded to "firstProp"
|
||||||
|
await assert.rejects(
|
||||||
|
testMqtt("[wrong_success_messsage]", "json-query", "{\"firstProp\":\"present\"}"),
|
||||||
|
new Error("Message received but value is not equal to expected value, value was: [present]")
|
||||||
|
);
|
||||||
|
});
|
||||||
|
});
|
||||||
@ -0,0 +1,53 @@
|
|||||||
|
const { describe, test } = require("node:test");
|
||||||
|
const assert = require("node:assert");
|
||||||
|
const { RabbitMQContainer } = require("@testcontainers/rabbitmq");
|
||||||
|
const { RabbitMqMonitorType } = require("../../server/monitor-types/rabbitmq");
|
||||||
|
const { UP, DOWN, PENDING } = require("../../src/util");
|
||||||
|
|
||||||
|
describe("RabbitMQ Single Node", {
|
||||||
|
skip: !!process.env.CI && (process.platform !== "linux" || process.arch !== "x64"),
|
||||||
|
}, () => {
|
||||||
|
test("RabbitMQ is running", async () => {
|
||||||
|
// The default timeout of 30 seconds might not be enough for the container to start
|
||||||
|
const rabbitMQContainer = await new RabbitMQContainer().withStartupTimeout(60000).start();
|
||||||
|
const rabbitMQMonitor = new RabbitMqMonitorType();
|
||||||
|
const connectionString = `http://${rabbitMQContainer.getHost()}:${rabbitMQContainer.getMappedPort(15672)}`;
|
||||||
|
|
||||||
|
const monitor = {
|
||||||
|
rabbitmqNodes: JSON.stringify([ connectionString ]),
|
||||||
|
rabbitmqUsername: "guest",
|
||||||
|
rabbitmqPassword: "guest",
|
||||||
|
};
|
||||||
|
|
||||||
|
const heartbeat = {
|
||||||
|
msg: "",
|
||||||
|
status: PENDING,
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
await rabbitMQMonitor.check(monitor, heartbeat, {});
|
||||||
|
assert.strictEqual(heartbeat.status, UP);
|
||||||
|
assert.strictEqual(heartbeat.msg, "OK");
|
||||||
|
} finally {
|
||||||
|
rabbitMQContainer.stop();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("RabbitMQ is not running", async () => {
|
||||||
|
const rabbitMQMonitor = new RabbitMqMonitorType();
|
||||||
|
const monitor = {
|
||||||
|
rabbitmqNodes: JSON.stringify([ "http://localhost:15672" ]),
|
||||||
|
rabbitmqUsername: "rabbitmqUser",
|
||||||
|
rabbitmqPassword: "rabbitmqPass",
|
||||||
|
};
|
||||||
|
|
||||||
|
const heartbeat = {
|
||||||
|
msg: "",
|
||||||
|
status: PENDING,
|
||||||
|
};
|
||||||
|
|
||||||
|
await rabbitMQMonitor.check(monitor, heartbeat, {});
|
||||||
|
assert.strictEqual(heartbeat.status, DOWN);
|
||||||
|
});
|
||||||
|
|
||||||
|
});
|
||||||
Loading…
Reference in new issue