@oneuptime/common 12.0.32 → 12.0.33

package/Types/Monitor/CriteriaFilter.ts

@@ -1,5 +1,6 @@
 import Zod, { ZodSchema } from "../../Utils/Schema/Zod";
 import MetricCriteriaContext from "./MetricMonitor/MetricCriteriaContext";
+import MonitorMetricType from "./MonitorMetricType";
 
 export enum CheckOn {
   ResponseTime = "Response Time (in ms)",
@@ -75,7 +76,19 @@ export enum CheckOn {
   SnmpOidValue = "SNMP OID Value",
   SnmpOidExists = "SNMP OID Exists",
   SnmpResponseTime = "SNMP Response Time (in ms)",
+  /*
+   * Device reachability: true when the device answered ping OR its SNMP
+   * walk succeeded. The label predates ping-first polling; the value is
+   * load-bearing (stored in monitor criteria) so it stays as it is.
+   */
   SnmpIsOnline = "SNMP Device Is Online",
+  /*
+   * The SNMP walk itself. Not evaluated at all on a poll that ran no walk
+   * (a device without credentials), so "is False" means "the walk was
+   * attempted and failed" - credentials, agent, or an ACL - never "there
+   * was nothing to walk".
+   */
+  SnmpWalkIsSucceeding = "SNMP Walk Is Succeeding",
   SnmpInterfaceIsDown = "SNMP Interface Is Down",
   SnmpTrapReceived = "SNMP Trap Received (Trap OID)",
   SnmpInterfaceUtilizationPercent = "SNMP Interface Utilization (in %)",
@@ -110,6 +123,21 @@ export enum CheckOn {
   SqlQueryExecutionTime = "SQL Query Execution Time (in ms)",
   SqlQueryError = "SQL Query Error",
 
+  /*
+   * Database Health monitors.
+   *
+   * Deliberately three CheckOns rather than one per metric. The catalog
+   * carries ~40 series and grows with every engine we add; putting each in
+   * this enum would flood a dropdown shared with every other monitor type
+   * and force a new case in five switch statements per metric. Instead
+   * DatabaseMetric names the series in databaseMonitorOptions.metricType,
+   * the same way Server monitors name a disk in serverMonitorOptions and
+   * SNMP monitors name an OID in snmpMonitorOptions.
+   */
+  DatabaseIsOnline = "Database Is Online",
+  DatabaseMetric = "Database Metric",
+  DatabaseCollectionError = "Database Collection Error",
+
   // External Status Page monitors.
   ExternalStatusPageIsOnline = "External Status Page Is Online",
   ExternalStatusPageOverallStatus = "External Status Page Overall Status",
@@ -134,6 +162,16 @@ export interface SnmpMonitorOptions {
   interfaceName?: string | undefined;
 }
 
+export interface DatabaseMonitorOptions {
+  /*
+   * Which collected series this filter compares against, e.g.
+   * MonitorMetricType.DatabaseConnectionsUsedPercent. Required whenever
+   * checkOn is CheckOn.DatabaseMetric; a filter without it can never be
+   * met and is reported as misconfigured rather than silently ignored.
+   */
+  metricType?: MonitorMetricType | undefined;
+}
+
 export enum EvaluateOverTimeType {
   Average = "Average",
   Sum = "Sum",
@@ -242,6 +280,7 @@ export interface CriteriaFilter {
   serverMonitorOptions?: ServerMonitorOptions | undefined;
   metricMonitorOptions?: MetricMonitorOptions | undefined;
   snmpMonitorOptions?: SnmpMonitorOptions | undefined;
+  databaseMonitorOptions?: DatabaseMonitorOptions | undefined;
   filterType: FilterType | undefined;
   value: string | number | undefined;
   evaluateOverTime?: boolean | undefined;
@@ -319,6 +358,7 @@ export class CriteriaFilterUtil {
     if (
       checkOn === CheckOn.IsOnline ||
       checkOn === CheckOn.SnmpIsOnline ||
+      checkOn === CheckOn.SnmpWalkIsSucceeding ||
       checkOn === CheckOn.SnmpInterfaceIsDown ||
       checkOn === CheckOn.DnsIsOnline ||
       checkOn === CheckOn.DomainIsExpired ||
@@ -328,6 +368,7 @@ export class CriteriaFilterUtil {
       checkOn === CheckOn.DnssecResolverConsensus ||
       checkOn === CheckOn.DnssecNameserverConsistent ||
       checkOn === CheckOn.SqlIsOnline ||
+      checkOn === CheckOn.DatabaseIsOnline ||
       checkOn === CheckOn.ExternalStatusPageIsOnline
     ) {
       return false;
@@ -373,7 +414,14 @@ export class CriteriaFilterUtil {
       return [];
     }
 
-    if (criteriaFilter.checkOn === CheckOn.IsOnline) {
+    /*
+     * Boolean series. Averaging or summing an up/down series is meaningless,
+     * so these offer only the two set-shaped choices.
+     */
+    if (
+      criteriaFilter.checkOn === CheckOn.IsOnline ||
+      criteriaFilter.checkOn === CheckOn.DatabaseIsOnline
+    ) {
       return [EvaluateOverTimeType.AllValues, EvaluateOverTimeType.AnyValue];
     }
 
@@ -428,7 +476,14 @@ export class CriteriaFilterUtil {
       checkOn === CheckOn.DnsResponseTime ||
       checkOn === CheckOn.DnsIsOnline ||
       checkOn === CheckOn.ExternalStatusPageResponseTime ||
-      checkOn === CheckOn.ExternalStatusPageIsOnline
+      checkOn === CheckOn.ExternalStatusPageIsOnline ||
+      /*
+       * Over time is the most useful shape for database thresholds: a single
+       * sample of "connections above 90%" is a spike, five minutes of it is
+       * an incident.
+       */
+      checkOn === CheckOn.DatabaseIsOnline ||
+      checkOn === CheckOn.DatabaseMetric
     );
   }
 }
@@ -454,6 +509,9 @@ export const CriteriaFilterSchema: ZodSchema = Zod.object({
     oid: Zod.string().optional(),
     interfaceName: Zod.string().optional(),
   }).optional(),
+  databaseMonitorOptions: Zod.object({
+    metricType: Zod.string().optional(),
+  }).optional(),
   filterType: Zod.string().optional(),
   value: Zod.union([Zod.string(), Zod.number()]).optional(),
   evaluateOverTime: Zod.boolean().optional(),