@oneuptime/common 12.0.34 → 13.0.1

package/Server/Utils/EmailRollup/EmailRollupRenderer.ts

@@ -39,6 +39,11 @@ import RollupCategory, {
  *   rows[].link             raw          our own table, href="{{this.link}}"
  *   rows[].hasLink          raw          {{#ifCond this.hasLink "true"}}
  *   rows[].metaLabel        raw          our own table, {{this.metaLabel}}
+ *   rows[].severity         raw          our own table, {{this.severity}}
+ *   rows[].currentState     raw          our own table, {{this.currentState}}
+ *   rows[].hasSeverity      raw          {{#ifCond this.hasSeverity "true"}}
+ *   rows[].hasCurrentState  raw          {{#ifCond this.hasCurrentState "true"}}
+ *   rows[].hasDetails       raw          {{#ifCond this.hasDetails "true"}}
  *   rows[].isSectionStart   raw          {{#ifCond this.isSectionStart "true"}}
  *   rows[].sectionLabel     raw          our own section heading
  *   rows[].sectionCount     raw          our own section heading
@@ -74,6 +79,8 @@ export interface RollupRow {
   title: string;
   link: string;
   hasLink: string;
+  severity: string;
+  currentState: string;
   itemCount: number;
   category: RollupCategory;
   firstAtMs: number;
@@ -201,6 +208,8 @@ interface RollupGroup {
   firstAt: number;
   title: string;
   link: string;
+  severity: string;
+  currentState: string;
   category: RollupCategory;
   itemCount: number;
 }
@@ -210,6 +219,14 @@ interface CategoryCount {
   count: number;
 }
 
+type NormaliseDetailFunction = (value: string | undefined) => string;
+
+const normaliseDetail: NormaliseDetailFunction = (
+  value: string | undefined,
+): string => {
+  return typeof value === "string" && value.trim() !== "" ? value : "";
+};
+
 /*
  * Collapse the raw notification list into the rows a human reads.
  *
@@ -244,6 +261,8 @@ export const foldItems: FoldItemsFunction = (
         firstAt: createdAtMs,
         title: item.subject ?? "",
         link: link,
+        severity: normaliseDetail(item.severity),
+        currentState: normaliseDetail(item.currentState),
         category: normaliseCategory(item.rollupCategory),
         itemCount: 1,
       });
@@ -271,6 +290,12 @@ export const foldItems: FoldItemsFunction = (
       existing.latestAt = createdAtMs;
       existing.title = item.subject ?? "";
       existing.link = link;
+      /*
+       * All details describe the same notification as the title. Clearing a
+       * missing latest value avoids presenting an older snapshot as current.
+       */
+      existing.severity = normaliseDetail(item.severity);
+      existing.currentState = normaliseDetail(item.currentState);
       /*
        * The category follows the LATEST item too. A group is keyed on its deep
        * link, and two events about one resource can in principle be filed
@@ -295,6 +320,8 @@ export const foldItems: FoldItemsFunction = (
       title: group.title,
       link: group.link,
       hasLink: group.link === "" ? "false" : "true",
+      severity: group.severity,
+      currentState: group.currentState,
       itemCount: group.itemCount,
       category: group.category,
       firstAtMs: group.firstAt,
@@ -629,8 +656,8 @@ export const buildRollupEmail: BuildRollupEmailFunction = (
    */
   const preferencesText: string =
     "OneUptime groups owner notifications into a single email when several arrive at once for the same project. " +
-    "To go back to one email per notification, sent the moment it happens, turn off email rollup for this project in your notification settings. " +
-    "The same page is where you choose which notifications you receive, or turn email off entirely:";
+    "To go back to one email per notification, sent the moment it happens, turn off email rollup for this project in your email preferences. " +
+    "The same page can also switch off routine emails in bulk, and it links on to the per-event settings:";
 
   /*
    * ONE FLAT ARRAY, WITH THE SECTION HEADING CARRIED ON ITS FIRST ROW.
@@ -689,6 +716,12 @@ export const buildRollupEmail: BuildRollupEmailFunction = (
         link: row.link,
         hasLink: row.hasLink,
         metaLabel: metaLabel,
+        severity: row.severity,
+        currentState: row.currentState,
+        hasSeverity: row.severity === "" ? "false" : "true",
+        hasCurrentState: row.currentState === "" ? "false" : "true",
+        hasDetails:
+          row.severity !== "" || row.currentState !== "" ? "true" : "false",
         /*
          * The heading is emitted by the first row of the section rather than
          * by an entry of its own, so every element of this array is a real

package/Server/Utils/EmailRollup/EmailRollupWriter.ts

@@ -11,6 +11,7 @@ import {
 } from "./EmailRollupConstants";
 import UserNotificationEmailRollupItem from "../../../Models/DatabaseModels/UserNotificationEmailRollupItem";
 import OneUptimeDate from "../../../Types/Date";
+import ColumnLength from "../../../Types/Database/ColumnLength";
 import Dictionary from "../../../Types/Dictionary";
 import Email from "../../../Types/Email";
 import { EmailEnvelope } from "../../../Types/Email/EmailMessage";
@@ -113,6 +114,29 @@ const KNOWN_LINK_VARS: ReadonlyArray<string> = [
   "onCallPolicyViewLink",
 ];
 
+/*
+ * Episode notifications can also contain child-resource details; keep the
+ * severity tied to the same resource as the event and its current state.
+ */
+const SEVERITY_VAR_BY_CATEGORY: Partial<Record<RollupCategory, string>> = {
+  [RollupCategory.Alerts]: "alertSeverity",
+  [RollupCategory.Incidents]: "incidentSeverity",
+  [RollupCategory.AlertEpisodes]: "episodeSeverity",
+  [RollupCategory.IncidentEpisodes]: "episodeSeverity",
+};
+
+function extractLabel(
+  value: string | JSONObject | undefined,
+): string | undefined {
+  if (typeof value !== "string") {
+    return undefined;
+  }
+
+  const label: string = value.trim();
+
+  return label ? label.slice(0, ColumnLength.ShortText) : undefined;
+}
+
 type IsAbsoluteLinkFunction = (
   value: string | JSONObject | undefined,
 ) => value is string;
@@ -322,6 +346,26 @@ export default class EmailRollupWriter {
           ROLLUP_SUBJECT_MAX_LENGTH,
         ) ?? "";
 
+      const severityVar: string | undefined =
+        SEVERITY_VAR_BY_CATEGORY[category];
+
+      if (severityVar) {
+        const severity: string | undefined = extractLabel(
+          data.emailEnvelope.vars?.[severityVar],
+        );
+        const currentState: string | undefined = extractLabel(
+          data.emailEnvelope.vars?.["currentState"],
+        );
+
+        if (severity !== undefined) {
+          item.severity = severity;
+        }
+
+        if (currentState !== undefined) {
+          item.currentState = currentState;
+        }
+      }
+
       const link: string | undefined = EmailRollupWriter.extractViewLink(
         data.emailEnvelope.vars,
       );

package/Server/Utils/LogRedaction.ts

@@ -75,6 +75,7 @@ const SENSITIVE_KEY_FRAGMENTS: Array<string> = [
   "onetimecode",
   "logincode",
   "resetcode",
+  "codeverifier",
   /*
    * A DSN carries the password inline, so the key name is the only signal
    * we get before the value is already in the log line.
@@ -232,7 +233,7 @@ export const isSensitiveLogKey: IsSensitiveLogKeyFunction = (
  * are too short to match safely against free-form prose.
  */
 const TEXT_SECRET_WORDS: string =
-  "password|passwd|passphrase|secret|token|credential|credentials|authorization|cookie|api[_-]?key|private[_-]?key|access[_-]?key|assertion|attestation|signature|raw[_-]?id|client[_-]?data[_-]?json|authenticator[_-]?data|user[_-]?handle|two[_-]?factor[_-]?secret";
+  "password|passwd|passphrase|secret|token|credential|credentials|authorization|cookie|api[_-]?key|private[_-]?key|access[_-]?key|assertion|attestation|signature|raw[_-]?id|client[_-]?data[_-]?json|authenticator[_-]?data|user[_-]?handle|two[_-]?factor[_-]?secret|code[_-]?verifier";
 
 // Bounded, so a long non-matching run cannot blow up on backtracking.
 const KEY_PREFIX: string = "[A-Za-z0-9_.-]{0,40}";

package/Server/Utils/Monitor/Criteria/CompareCriteria.ts

@@ -7,6 +7,7 @@ import {
 } from "../../../../Types/Monitor/CriteriaFilter";
 import Typeof from "../../../../Types/Typeof";
 import CaptureSpan from "../../Telemetry/CaptureSpan";
+import MetricValueFormatter from "../../../../Utils/Monitor/MetricValueFormatter";
 
 export default class CompareCriteria {
   /*
@@ -474,6 +475,15 @@ export default class CompareCriteria {
     criteriaFilter: CriteriaFilter;
     metricDisplayName?: string | undefined;
     unit?: string | undefined;
+    /**
+     * The metric NAME, when there is a real one. Distinct from
+     * metricDisplayName, which is the formula expression for a formula
+     * criteria and is only ever used as a label: this one feeds
+     * ValueFormatter.isFractionMetric, which would read the trailing
+     * `_ratio` of a formula like `a / b_ratio` as a signal to multiply
+     * the value by 100. Callers pass it only for plain metric criteria.
+     */
+    metricName?: string | undefined;
   }): string | null {
     if (data.value === null || data.value === undefined) {
       return null;
@@ -499,6 +509,7 @@ export default class CompareCriteria {
           criteriaFilter: data.criteriaFilter,
           metricDisplayName: data.metricDisplayName,
           unit: data.unit,
+          metricName: data.metricName,
         });
       }
 
@@ -521,6 +532,7 @@ export default class CompareCriteria {
           criteriaFilter: data.criteriaFilter,
           metricDisplayName: data.metricDisplayName,
           unit: data.unit,
+          metricName: data.metricName,
         });
       }
 
@@ -543,6 +555,7 @@ export default class CompareCriteria {
           criteriaFilter: data.criteriaFilter,
           metricDisplayName: data.metricDisplayName,
           unit: data.unit,
+          metricName: data.metricName,
         });
       }
 
@@ -565,6 +578,7 @@ export default class CompareCriteria {
           criteriaFilter: data.criteriaFilter,
           metricDisplayName: data.metricDisplayName,
           unit: data.unit,
+          metricName: data.metricName,
         });
       }
 
@@ -587,6 +601,7 @@ export default class CompareCriteria {
           criteriaFilter: data.criteriaFilter,
           metricDisplayName: data.metricDisplayName,
           unit: data.unit,
+          metricName: data.metricName,
         });
       }
 
@@ -609,6 +624,7 @@ export default class CompareCriteria {
           criteriaFilter: data.criteriaFilter,
           metricDisplayName: data.metricDisplayName,
           unit: data.unit,
+          metricName: data.metricName,
         });
       }
 
@@ -625,6 +641,15 @@ export default class CompareCriteria {
     criteriaFilter: CriteriaFilter;
     metricDisplayName?: string | undefined;
     unit?: string | undefined;
+    /**
+     * The metric NAME, when there is a real one. Distinct from
+     * metricDisplayName, which is the formula expression for a formula
+     * criteria and is only ever used as a label: this one feeds
+     * ValueFormatter.isFractionMetric, which would read the trailing
+     * `_ratio` of a formula like `a / b_ratio` as a signal to multiply
+     * the value by 100. Callers pass it only for plain metric criteria.
+     */
+    metricName?: string | undefined;
   }): string {
     // CPU Percent over the last 5 minutes is 10 which is less than the threshold of 20
     let message: string = "";
@@ -695,30 +720,36 @@ export default class CompareCriteria {
     }
 
     /*
-     * Suppress the units that read as noise — or as a wrong number —
-     * next to a value. OTel's dimensionless "1" marks ratio metrics
-     * whose samples are fractions in [0, 1]; rendering "0.06 1" is both
-     * ugly and misleading (it is not 1% — it is 6%), and a CLS breach
-     * read "is 0.31 1 which is greater than or equal to 0.25 1". UCUM
-     * annotation-only units ("{cpu}", "{packets}", "{errors}") are
-     * descriptive braces, not a unit a reader should be shown. Every
-     * real unit passes through unchanged, so "%" stays "%" and "ms"
-     * stays "ms".
+     * A metric value is written the way the dashboard writes it —
+     * "1.07 GB", "1.5 sec", "25.34%" — rather than as raw digits with a
+     * raw UCUM code glued on. Only two of the ~35 callers pass a unit at
+     * all (MetricMonitorCriteria and DatabaseMonitorCriteria); everything
+     * else carries its unit inside the CheckOn label ("Response Time (in
+     * ms)") and must keep its exact digits, so an absent unit leaves this
+     * sentence byte-for-byte as it was.
      *
-     * The dashboard side already applies the "1" half of this rule in
-     * MonitorCriteriaObservationBuilder.normalizeDisplayUnit, and
-     * ValueFormatter applies both halves when it formats a value. The
-     * email path never picked either up, so the same evaluation rendered
-     * worse in the alert than on the dashboard.
+     * MetricValueFormatter also subsumes the unit-suppression rules this
+     * block used to spell out by hand: OTel's dimensionless "1" (which
+     * made a CLS breach read "is 0.31 1 which is greater than or equal to
+     * 0.25 1") and UCUM's annotation-only "{cpu}" / "{packets}" both
+     * disappear, and a fraction metric still carrying "1" is rendered as
+     * the percentage it means.
+     *
+     * The unit rides each NUMBER instead of the sentence, because
+     * auto-scaling can land two samples in the same sentence on different
+     * scales — "is 900 KB, 1.2 MB" — which one trailing suffix cannot
+     * express.
      */
-    const trimmedUnit: string = (data.unit || "").trim();
-    const annotationOnlyUnitPattern: RegExp = /^\{[^{}]*\}$/;
-    const unitSuffix: string =
-      trimmedUnit &&
-      trimmedUnit !== "1" &&
-      !annotationOnlyUnitPattern.test(trimmedUnit)
-        ? ` ${trimmedUnit}`
-        : "";
+    const withUnit: ((value: number) => string) | undefined =
+      MetricValueFormatter.hasDisplayableUnit(data.unit, data.metricName)
+        ? (value: number): string => {
+            return MetricValueFormatter.format({
+              value: value,
+              unit: data.unit,
+              metricName: data.metricName,
+            });
+          }
+        : undefined;
 
     if (
       data.criteriaFilter.filterType !== FilterType.True &&
@@ -750,10 +781,12 @@ export default class CompareCriteria {
         evaluationType: evaluationType,
       });
 
-      const formattedValues: string =
-        CompareCriteria.formatCriteriaValues(reportedValues);
+      const formattedValues: string = CompareCriteria.formatCriteriaValues(
+        reportedValues,
+        withUnit,
+      );
 
-      message += ` is ${formattedValues}${unitSuffix}`;
+      message += ` is ${formattedValues}`;
 
       message += " which is";
 
@@ -778,22 +811,22 @@ export default class CompareCriteria {
 
     switch (data.criteriaFilter.filterType) {
       case FilterType.GreaterThan:
-        message += ` greater than ${CompareCriteria.formatSingleValue(data.threshold)}${unitSuffix}. `;
+        message += ` greater than ${CompareCriteria.formatSingleValue(data.threshold, withUnit)}. `;
         break;
       case FilterType.GreaterThanOrEqualTo:
-        message += ` greater than or equal to ${CompareCriteria.formatSingleValue(data.threshold)}${unitSuffix}. `;
+        message += ` greater than or equal to ${CompareCriteria.formatSingleValue(data.threshold, withUnit)}. `;
         break;
       case FilterType.LessThan:
-        message += ` less than ${CompareCriteria.formatSingleValue(data.threshold)}${unitSuffix}. `;
+        message += ` less than ${CompareCriteria.formatSingleValue(data.threshold, withUnit)}. `;
         break;
       case FilterType.LessThanOrEqualTo:
-        message += ` less than or equal to ${CompareCriteria.formatSingleValue(data.threshold)}${unitSuffix}. `;
+        message += ` less than or equal to ${CompareCriteria.formatSingleValue(data.threshold, withUnit)}. `;
         break;
       case FilterType.NotEqualTo:
-        message += ` not equal to ${CompareCriteria.formatSingleValue(data.threshold)}${unitSuffix}. `;
+        message += ` not equal to ${CompareCriteria.formatSingleValue(data.threshold, withUnit)}. `;
         break;
       case FilterType.EqualTo:
-        message += ` equal to ${CompareCriteria.formatSingleValue(data.threshold)}${unitSuffix}. `;
+        message += ` equal to ${CompareCriteria.formatSingleValue(data.threshold, withUnit)}. `;
         break;
       case FilterType.Contains:
         message += ` contains ${CompareCriteria.formatSingleValue(data.threshold)}. `;
@@ -918,8 +951,16 @@ export default class CompareCriteria {
     }
   }
 
+  /*
+   * `withUnit`, when supplied, is how a NUMBER is rendered — unit
+   * included. It is threaded down rather than applied to the finished
+   * string because the string is not always one number: a large window
+   * collapses to "N samples between X and Y", and both X and Y need the
+   * unit of their own scale.
+   */
   private static formatCriteriaValues(
     values: Array<number | boolean> | number | boolean | string,
+    withUnit?: ((value: number) => string) | undefined,
   ): string {
     if (Array.isArray(values)) {
       /*
@@ -934,7 +975,7 @@ export default class CompareCriteria {
       if (values.length <= MAX_INLINE) {
         return values
           .map((value: number | boolean) => {
-            return CompareCriteria.formatSingleValue(value);
+            return CompareCriteria.formatSingleValue(value, withUnit);
           })
           .join(", ");
       }
@@ -950,24 +991,26 @@ export default class CompareCriteria {
         const max: number = Math.max(...numericValues);
         return `${numericValues.length} samples between ${CompareCriteria.formatSingleValue(
           min,
-        )} and ${CompareCriteria.formatSingleValue(max)}`;
+          withUnit,
+        )} and ${CompareCriteria.formatSingleValue(max, withUnit)}`;
       }
 
       // Fall back to a truncated list when not all values are numeric
       const head: string = values
         .slice(0, MAX_INLINE)
         .map((value: number | boolean) => {
-          return CompareCriteria.formatSingleValue(value);
+          return CompareCriteria.formatSingleValue(value, withUnit);
         })
         .join(", ");
       return `${head}, … (${values.length} values total)`;
     }
 
-    return CompareCriteria.formatSingleValue(values);
+    return CompareCriteria.formatSingleValue(values, withUnit);
   }
 
   private static formatSingleValue(
     value: number | boolean | string | null | undefined,
+    withUnit?: ((value: number) => string) | undefined,
   ): string {
     if (value === null || value === undefined) {
       return "unknown";
@@ -976,6 +1019,10 @@ export default class CompareCriteria {
     if (typeof value === Typeof.Number) {
       const numericValue: number = value as number;
 
+      if (withUnit) {
+        return withUnit(numericValue);
+      }
+
       if (Number.isInteger(numericValue)) {
         return numericValue.toString();
       }

package/Server/Utils/Monitor/Criteria/MetricMonitorCriteria.ts

@@ -26,6 +26,7 @@ import {
 } from "../../../../Types/Monitor/CriteriaFilter";
 import CaptureSpan from "../../Telemetry/CaptureSpan";
 import MetricUnitUtil from "../../../../Utils/MetricUnitUtil";
+import MetricValueFormatter from "../../../../Utils/Monitor/MetricValueFormatter";
 import MetricFormulaEvaluator from "../../../../Utils/Metrics/MetricFormulaEvaluator";
 import MetricBaselineService, {
   BaselineSummary,
@@ -369,6 +370,15 @@ export default class MetricMonitorCriteria {
         criteriaFilter: input.criteriaFilter,
         metricDisplayName: metricContext.metricName,
         unit: displayUnit,
+        /*
+         * Only a plain metric criteria has a real metric NAME —
+         * metricContext.metricName is the formula expression when the
+         * criteria targets a formula, and a formula ending in `_ratio`
+         * would trip the fraction heuristic into a 100× render.
+         */
+        metricName: metricContext.isFormula
+          ? undefined
+          : metricContext.metricName,
       });
 
     if (!comparisonMessage) {
@@ -989,13 +999,29 @@ export default class MetricMonitorCriteria {
             : "below";
 
     const sigmaAbs: number = Math.abs(firstBreach.sigma);
-    const unitSuffix: string = metricContext.unit
-      ? ` ${metricContext.unit}`
-      : "";
+
+    /*
+     * Same rendering as the breaching-samples table and the comparison
+     * sentence — an anomaly on a memory metric reads "1.07 GB", not
+     * "1073741824.000 By". σ is a count of standard deviations, not a
+     * quantity in the metric's unit, so it stays a bare number; the
+     * standard deviation itself is in the metric's unit and does not.
+     */
+    const inMetricUnit: (value: number) => string = (value: number): string => {
+      return MetricValueFormatter.format({
+        value: value,
+        unit: metricContext.unit,
+        // Formula expressions are not metric names — see the guard above.
+        metricName: metricContext.isFormula
+          ? undefined
+          : metricContext.metricName,
+      });
+    };
+
     const rootCause: string =
-      `${metricContext.metricName} value ${firstBreach.sample.value.toFixed(3)}${unitSuffix} ` +
+      `${metricContext.metricName} value ${inMetricUnit(firstBreach.sample.value)} ` +
       `is ${sigmaAbs.toFixed(2)}σ ${direction} the same-hour baseline ` +
-      `(mean ${baseline.mean.toFixed(3)}${unitSuffix}, σ ${baseline.stddev.toFixed(3)}${unitSuffix}, ` +
+      `(mean ${inMetricUnit(baseline.mean)}, σ ${inMetricUnit(baseline.stddev)}, ` +
       `${baseline.sampleCount} samples over ${baseline.windowDays} days, sensitivity ${sensitivity}).`;
 
     return {

package/Server/Utils/Monitor/MonitorAlert.ts

@@ -673,7 +673,7 @@ export default class MonitorAlert {
             /*
              * Attach every resource this series identifies — host, docker
              * host, podman host, k8s cluster, service, and the Proxmox /
-             * Ceph / Swarm / IoT clusters — resolved from the shared label
+             * VMware vCenter / Ceph / Swarm / IoT clusters — resolved from the shared label
              * key map. Same call the incident path makes, so the two can't
              * drift apart again.
              */