Repository: louislam/uptime-kuma
File: server/prometheus.js (JavaScript)

Code before:

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
     * @param {Array<{name:string,value:?string}>} tags Tags to add to the monitor
     */
    constructor(monitor, tags) {
        this.monitorLabelValues = {
            monitor_id: monitor.id,
            monitor_name: monitor.name,
            monitor_type: monitor.type,
            monitor_url: monitor.url,
            monitor_hostname: monitor.hostname,
            monitor_port: monitor.port,
        };
        let sanitizedTags = this.sanitizeTags(tags);
        if (sanitizedTags.length) {
            this.monitorLabelValues.monitor_tags = sanitizedTags
        }
    }

    /**
     * Sanitize tags to ensure they can be processed by Prometheus.
     * See https://github.com/louislam/uptime-kuma/pull/4704#issuecomment-2366524692
     * @param {Array<{name: string, value:?string}>} tags The tags to sanitize
     * @returns {string[]} The sanitized tags
     */
    sanitizeTags(tags) {
        return tags.reduce((sanitizedTags, tag) => {
            let tagText = tag.value ? `${tag.name}_${tag.value}` : tag.name;
            tagText = tagText.replace(/[^a-zA-Z0-9_]/g, "");
            tagText = tagText.replace(/^[^a-zA-Z_]+/, "");

            if (tagText !== "") {
                sanitizedTags.push(tagText);
            }

            return sanitizedTags;
        }, []);
    }

    /**
     * Update the metrics page

Review comment (security):
```suggestion
            this.monitorLabelValues.monitor_tags = sanitizedTags;
```

Code after:
     * Initialize Prometheus metrics, and add all available tags as possible labels.
     * This should be called once at the start of the application.
     * New tags will NOT be added dynamically, a restart is sadly required to add new tags to the metrics.
     * Existing tags added to monitors will be updated automatically.
     * @returns {Promise<void>}
     */
    static async init() {
        // Add all available tags as possible labels,
        // and use Set to remove possible duplicates (for when multiple tags contain non-ascii characters, and thus are sanitized to the same label)
        const tags = new Set((await R.findAll("tag")).map((tag) => {
            return Prometheus.sanitizeForPrometheus(tag.name);
        }).filter((tagName) => {
            return tagName !== "";
        }).sort(this.sortTags));

        const commonLabels = [
            ...tags,
            "monitor_id",
            "monitor_name",
            "monitor_type",
            "monitor_url",
            "monitor_hostname",
            "monitor_port",
        ];

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

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

        monitorResponseTime = new PrometheusClient.Gauge({
            name: "monitor_response_time",
            help: "Monitor Response Time (ms)",
            labelNames: commonLabels
        });

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

    /**