Skip to content

Commit

Permalink
dynamic prometheus labels
Browse files Browse the repository at this point in the history 
fixes louislam#680
replaces louislam#898
  • Loading branch information
@spali
spali committed Apr 30, 2024
1 parent 19e8c75 commit cea0138
Show file tree
Hide file tree
Showing 3 changed files with 123 additions and 39 deletions.
4 changes: 2 additions & 2 deletions server/model/monitor.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ class Monitor extends BeanModel {
let previousBeat = null;
let retries = 0;

this.prometheus = new Prometheus(this);
this.prometheus = await Prometheus.createAndInitMetrics(this);

const beat = async () => {

Expand Down Expand Up @@ -997,7 +997,7 @@ class Monitor extends BeanModel {
await R.store(bean);

log.debug("monitor", `[${this.name}] prometheus.update`);
this.prometheus?.update(bean, tlsInfo);
await this.prometheus?.update(bean, tlsInfo);

previousBeat = bean;

Expand Down
146 changes: 109 additions & 37 deletions server/prometheus.js
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
const { R } = require("redbean-node");
const PrometheusClient = require("prom-client");
const { log } = require("../src/util");

Expand All @@ -9,43 +10,115 @@ const commonLabels = [
"monitor_port",
];

const monitorCertDaysRemaining = new PrometheusClient.Gauge({
name: "monitor_cert_days_remaining",
help: "The number of days remaining until the certificate expires",
labelNames: commonLabels
});

const monitorCertIsValid = new PrometheusClient.Gauge({
name: "monitor_cert_is_valid",
help: "Is the certificate still valid? (1 = Yes, 0= No)",
labelNames: commonLabels
});
const monitorResponseTime = new PrometheusClient.Gauge({
name: "monitor_response_time",
help: "Monitor Response Time (ms)",
labelNames: commonLabels
});

const monitorStatus = new PrometheusClient.Gauge({
name: "monitor_status",
help: "Monitor Status (1 = UP, 0= DOWN, 2= PENDING, 3= MAINTENANCE)",
labelNames: commonLabels
});

class Prometheus {
monitorLabelValues = {};

/**
* @param {object} monitor Monitor object to monitor
* Metric: monitor_cert_days_remaining
* @type {PrometheusClient.Gauge<string> | null}
*/
static monitorCertDaysRemaining = null;

/**
* Metric: monitor_cert_is_valid
* @type {PrometheusClient.Gauge<string> | null}
*/
static monitorCertIsValid = null;

/**
* Metric: monitor_response_time
* @type {PrometheusClient.Gauge<string> | null}
*/
static monitorResponseTime = null;

/**
* Metric: monitor_status
* @type {PrometheusClient.Gauge<string> | null}
*/
static monitorStatus = null;

/**
* All registered metric labels.
* @type {string[] | null}
*/
static monitorLabelNames = null;

/**
* Monitor labels/values combination.
* @type {{}}
*/
monitorLabelValues;

/**
* Initialize metrics and get all label names the first time called.
* @returns {void}
*/
constructor(monitor) {
static async initMetrics() {
if (!this.monitorLabelNames) {
let labelNames = await R.getCol("SELECT name FROM tag");
this.monitorLabelNames = [ ...commonLabels, ...labelNames ];
}
if (!this.monitorCertDaysRemaining) {
this.monitorCertDaysRemaining = new PrometheusClient.Gauge({
name: "monitor_cert_days_remaining",
help: "The number of days remaining until the certificate expires",
labelNames: this.monitorLabelNames
});
}
if (!this.monitorCertIsValid) {
this.monitorCertIsValid = new PrometheusClient.Gauge({
name: "monitor_cert_is_valid",
help: "Is the certificate still valid? (1 = Yes, 0 = No)",
labelNames: this.monitorLabelNames
});
}
if (!this.monitorResponseTime) {
this.monitorResponseTime = new PrometheusClient.Gauge({
name: "monitor_response_time",
help: "Monitor Response Time (ms)",
labelNames: this.monitorLabelNames
});
}
if (!this.monitorStatus) {
this.monitorStatus = new PrometheusClient.Gauge({
name: "monitor_status",
help: "Monitor Status (1 = UP, 0 = DOWN, 2 = PENDING, 3 = MAINTENANCE)",
labelNames: this.monitorLabelNames
});
}
}

/**
* Wrapper to create a `Prometheus` instance and ensure metrics are initialized.
* @param {Monitor} monitor Monitor object to monitor
* @returns {Promise<Prometheus>} `Prometheus` instance
*/
static async createAndInitMetrics(monitor) {
await Prometheus.initMetrics();
let tags = await monitor.getTags();
return new Prometheus(monitor, tags);
}

/**
* Creates a prometheus metric instance.
*
* Note: Make sure to call `Prometheus.initMetrics()` once prior creating Prometheus instances.
* @param {Monitor} monitor Monitor object to monitor
* @param {Promise<LooseObject<any>[]>} tags Tags of the monitor
*/
constructor(monitor, tags) {
this.monitorLabelValues = {
monitor_name: monitor.name,
monitor_type: monitor.type,
monitor_url: monitor.url,
monitor_hostname: monitor.hostname,
monitor_port: monitor.port
};
Object.values(tags)
// only label names that were known at first metric creation.
.filter(tag => Prometheus.monitorLabelNames.includes(tag.name))
.forEach(tag => {
this.monitorLabelValues[tag.name] = tag.value;
});
}

/**
Expand All @@ -54,8 +127,7 @@ class Prometheus {
* @param {object} tlsInfo TLS details
* @returns {void}
*/
update(heartbeat, tlsInfo) {

async update(heartbeat, tlsInfo) {
if (typeof tlsInfo !== "undefined") {
try {
let isValid;
Expand All @@ -64,15 +136,15 @@ class Prometheus {
} else {
isValid = 0;
}
monitorCertIsValid.set(this.monitorLabelValues, isValid);
Prometheus.monitorCertIsValid.set(this.monitorLabelValues, isValid);
} catch (e) {
log.error("prometheus", "Caught error");
log.error("prometheus", e);
}

try {
if (tlsInfo.certInfo != null) {
monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining);
Prometheus.monitorCertDaysRemaining.set(this.monitorLabelValues, tlsInfo.certInfo.daysRemaining);
}
} catch (e) {
log.error("prometheus", "Caught error");
Expand All @@ -82,18 +154,18 @@ class Prometheus {

if (heartbeat) {
try {
monitorStatus.set(this.monitorLabelValues, heartbeat.status);
Prometheus.monitorStatus.set(this.monitorLabelValues, heartbeat.status);
} catch (e) {
log.error("prometheus", "Caught error");
log.error("prometheus", e);
}

try {
if (typeof heartbeat.ping === "number") {
monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping);
Prometheus.monitorResponseTime.set(this.monitorLabelValues, heartbeat.ping);
} else {
// Is it good?
monitorResponseTime.set(this.monitorLabelValues, -1);
Prometheus.monitorResponseTime.set(this.monitorLabelValues, -1);
}
} catch (e) {
log.error("prometheus", "Caught error");
Expand All @@ -108,10 +180,10 @@ class Prometheus {
*/
remove() {
try {
monitorCertDaysRemaining.remove(this.monitorLabelValues);
monitorCertIsValid.remove(this.monitorLabelValues);
monitorResponseTime.remove(this.monitorLabelValues);
monitorStatus.remove(this.monitorLabelValues);
Prometheus.monitorCertDaysRemaining?.remove(this.monitorLabelValues);
Prometheus.monitorCertIsValid?.remove(this.monitorLabelValues);
Prometheus.monitorResponseTime?.remove(this.monitorLabelValues);
Prometheus.monitorStatus?.remove(this.monitorLabelValues);
} catch (e) {
console.error(e);
}
Expand Down
12 changes: 12 additions & 0 deletions server/server.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1043,6 +1043,8 @@ let needSetup = false;
try {
checkLogin(socket);

log.debug("manage", `Add Tag: ${tag} User ID: ${socket.userID}`);

let bean = R.dispense("tag");
bean.name = tag.name;
bean.color = tag.color;
Expand All @@ -1065,6 +1067,8 @@ let needSetup = false;
try {
checkLogin(socket);

log.debug("manage", `Edit Tag: ${tag} User ID: ${socket.userID}`);

let bean = await R.findOne("tag", " id = ? ", [ tag.id ]);
if (bean == null) {
callback({
Expand Down Expand Up @@ -1097,6 +1101,8 @@ let needSetup = false;
try {
checkLogin(socket);

log.debug("manage", `Delete Tag: ${tagID} User ID: ${socket.userID}`);

await R.exec("DELETE FROM tag WHERE id = ? ", [ tagID ]);

callback({
Expand All @@ -1117,6 +1123,8 @@ let needSetup = false;
try {
checkLogin(socket);

log.debug("manage", `Add Monitor(${monitorID}) Tag(${tagID}): ${value} User ID: ${socket.userID}`);

await R.exec("INSERT INTO monitor_tag (tag_id, monitor_id, value) VALUES (?, ?, ?)", [
tagID,
monitorID,
Expand All @@ -1141,6 +1149,8 @@ let needSetup = false;
try {
checkLogin(socket);

log.debug("manage", `Edit Monitor(${monitorID}) Tag(${tagID}): ${value} User ID: ${socket.userID}`);

await R.exec("UPDATE monitor_tag SET value = ? WHERE tag_id = ? AND monitor_id = ?", [
value,
tagID,
Expand All @@ -1165,6 +1175,8 @@ let needSetup = false;
try {
checkLogin(socket);

log.debug("manage", `Delete Monitor(${monitorID}) Tag(${tagID}): ${value} User ID: ${socket.userID}`);

await R.exec("DELETE FROM monitor_tag WHERE tag_id = ? AND monitor_id = ? AND value = ?", [
tagID,
monitorID,
Expand Down

0 comments on commit cea0138

Please sign in to comment.