@oneuptime/common 9.4.11 → 9.4.13

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

@@ -0,0 +1,182 @@
+import DataToProcess from "../DataToProcess";
+import CompareCriteria from "./CompareCriteria";
+import {
+  CheckOn,
+  CriteriaFilter,
+  FilterType,
+} from "../../../../Types/Monitor/CriteriaFilter";
+import SnmpMonitorResponse, {
+  SnmpOidResponse,
+} from "../../../../Types/Monitor/SnmpMonitor/SnmpMonitorResponse";
+import ProbeMonitorResponse from "../../../../Types/Probe/ProbeMonitorResponse";
+import EvaluateOverTime from "./EvaluateOverTime";
+import CaptureSpan from "../../Telemetry/CaptureSpan";
+import logger from "../../Logger";
+
+export default class SnmpMonitorCriteria {
+  @CaptureSpan()
+  public static async isMonitorInstanceCriteriaFilterMet(input: {
+    dataToProcess: DataToProcess;
+    criteriaFilter: CriteriaFilter;
+  }): Promise<string | null> {
+    let threshold: number | string | undefined | null =
+      input.criteriaFilter.value;
+
+    const dataToProcess: ProbeMonitorResponse =
+      input.dataToProcess as ProbeMonitorResponse;
+
+    const snmpResponse: SnmpMonitorResponse | undefined =
+      dataToProcess.snmpResponse;
+
+    let overTimeValue: Array<number | boolean> | number | boolean | undefined =
+      undefined;
+
+    if (
+      input.criteriaFilter.evaluateOverTime &&
+      input.criteriaFilter.evaluateOverTimeOptions
+    ) {
+      try {
+        overTimeValue = await EvaluateOverTime.getValueOverTime({
+          projectId: (input.dataToProcess as ProbeMonitorResponse).projectId,
+          monitorId: input.dataToProcess.monitorId!,
+          evaluateOverTimeOptions: input.criteriaFilter.evaluateOverTimeOptions,
+          metricType: input.criteriaFilter.checkOn,
+        });
+
+        if (Array.isArray(overTimeValue) && overTimeValue.length === 0) {
+          overTimeValue = undefined;
+        }
+      } catch (err) {
+        logger.error(
+          `Error in getting over time value for ${input.criteriaFilter.checkOn}`,
+        );
+        logger.error(err);
+        overTimeValue = undefined;
+      }
+    }
+
+    // Check if SNMP device is online
+    if (input.criteriaFilter.checkOn === CheckOn.SnmpIsOnline) {
+      const currentIsOnline: boolean | Array<boolean> =
+        (overTimeValue as Array<boolean>) ||
+        (input.dataToProcess as ProbeMonitorResponse).isOnline;
+
+      return CompareCriteria.compareCriteriaBoolean({
+        value: currentIsOnline,
+        criteriaFilter: input.criteriaFilter,
+      });
+    }
+
+    // Check SNMP response time
+    if (input.criteriaFilter.checkOn === CheckOn.SnmpResponseTime) {
+      threshold = CompareCriteria.convertToNumber(threshold);
+
+      if (threshold === null || threshold === undefined) {
+        return null;
+      }
+
+      const currentResponseTime: number | Array<number> =
+        (overTimeValue as Array<number>) ||
+        snmpResponse?.responseTimeInMs ||
+        (input.dataToProcess as ProbeMonitorResponse).responseTimeInMs;
+
+      if (currentResponseTime === null || currentResponseTime === undefined) {
+        return null;
+      }
+
+      return CompareCriteria.compareCriteriaNumbers({
+        value: currentResponseTime,
+        threshold: threshold as number,
+        criteriaFilter: input.criteriaFilter,
+      });
+    }
+
+    // Check if a specific OID exists (returns a value)
+    if (input.criteriaFilter.checkOn === CheckOn.SnmpOidExists) {
+      const oid: string | undefined =
+        input.criteriaFilter.snmpMonitorOptions?.oid;
+
+      if (!oid) {
+        return null;
+      }
+
+      const oidResponse: SnmpOidResponse | undefined =
+        snmpResponse?.oidResponses?.find((response: SnmpOidResponse) => {
+          return response.oid === oid;
+        });
+
+      const exists: boolean = Boolean(
+        oidResponse && oidResponse.value !== null,
+      );
+
+      const isTrue: boolean =
+        input.criteriaFilter.filterType === FilterType.True;
+      const isFalse: boolean =
+        input.criteriaFilter.filterType === FilterType.False;
+
+      if (exists && isTrue) {
+        return `SNMP OID ${oid} exists and returned a value.`;
+      }
+
+      if (!exists && isFalse) {
+        return `SNMP OID ${oid} does not exist or returned no value.`;
+      }
+
+      return null;
+    }
+
+    // Check the value of a specific OID
+    if (input.criteriaFilter.checkOn === CheckOn.SnmpOidValue) {
+      const oid: string | undefined =
+        input.criteriaFilter.snmpMonitorOptions?.oid;
+
+      if (!oid) {
+        return null;
+      }
+
+      const oidResponse: SnmpOidResponse | undefined =
+        snmpResponse?.oidResponses?.find((response: SnmpOidResponse) => {
+          return response.oid === oid;
+        });
+
+      if (!oidResponse || oidResponse.value === null) {
+        return null;
+      }
+
+      const oidValue: string | number = oidResponse.value;
+
+      // Numeric comparison
+      if (typeof oidValue === "number" || !isNaN(Number(oidValue))) {
+        const numericValue: number =
+          typeof oidValue === "number" ? oidValue : Number(oidValue);
+        const numericThreshold: number | null =
+          CompareCriteria.convertToNumber(threshold);
+
+        if (numericThreshold !== null) {
+          const result: string | null = CompareCriteria.compareCriteriaNumbers({
+            value: numericValue,
+            threshold: numericThreshold,
+            criteriaFilter: input.criteriaFilter,
+          });
+
+          if (result) {
+            return `SNMP OID ${oid} (${oidResponse.name || oid}): ${result}`;
+          }
+        }
+      }
+
+      // String comparison
+      const result: string | null = CompareCriteria.compareCriteriaStrings({
+        value: String(oidValue),
+        threshold: String(threshold),
+        criteriaFilter: input.criteriaFilter,
+      });
+
+      if (result) {
+        return `SNMP OID ${oid} (${oidResponse.name || oid}): ${result}`;
+      }
+    }
+
+    return null;
+  }
+}

package/Server/Utils/Monitor/MonitorCriteriaEvaluator.ts

@@ -11,6 +11,7 @@ import LogMonitorCriteria from "./Criteria/LogMonitorCriteria";
 import MetricMonitorCriteria from "./Criteria/MetricMonitorCriteria";
 import TraceMonitorCriteria from "./Criteria/TraceMonitorCriteria";
 import ExceptionMonitorCriteria from "./Criteria/ExceptionMonitorCriteria";
+import SnmpMonitorCriteria from "./Criteria/SnmpMonitorCriteria";
 import MonitorCriteriaMessageBuilder from "./MonitorCriteriaMessageBuilder";
 import MonitorCriteriaDataExtractor from "./MonitorCriteriaDataExtractor";
 import MonitorCriteriaMessageFormatter from "./MonitorCriteriaMessageFormatter";
@@ -480,6 +481,18 @@ ${contextBlock}
       }
     }
 
+    if (input.monitor.monitorType === MonitorType.SNMP) {
+      const snmpMonitorResult: string | null =
+        await SnmpMonitorCriteria.isMonitorInstanceCriteriaFilterMet({
+          dataToProcess: input.dataToProcess,
+          criteriaFilter: input.criteriaFilter,
+        });
+
+      if (snmpMonitorResult) {
+        return snmpMonitorResult;
+      }
+    }
+
     return null;
   }
 

package/Server/Utils/Monitor/MonitorCriteriaExpectationBuilder.ts

@@ -116,7 +116,7 @@ export default class MonitorCriteriaExpectationBuilder {
     const parts: Array<string> = [];
 
     if (
-      criteriaFilter.eveluateOverTime &&
+      criteriaFilter.evaluateOverTime &&
       criteriaFilter.evaluateOverTimeOptions?.timeValueInMinutes
     ) {
       parts.push(

package/Server/Utils/Monitor/MonitorTemplateUtil.ts

@@ -11,6 +11,9 @@ import BasicInfrastructureMetrics, {
 import SslMonitorResponse from "../../../Types/Monitor/SSLMonitor/SslMonitorResponse";
 import CustomCodeMonitorResponse from "../../../Types/Monitor/CustomCodeMonitor/CustomCodeMonitorResponse";
 import SyntheticMonitorResponse from "../../../Types/Monitor/SyntheticMonitors/SyntheticMonitorResponse";
+import SnmpMonitorResponse, {
+  SnmpOidResponse,
+} from "../../../Types/Monitor/SnmpMonitor/SnmpMonitorResponse";
 import Typeof from "../../../Types/Typeof";
 import VMUtil from "../VM/VMAPI";
 import DataToProcess from "./DataToProcess";
@@ -203,6 +206,40 @@ export default class MonitorTemplateUtil {
           }
         }
       }
+
+      if (data.monitorType === MonitorType.SNMP) {
+        const snmpResponse: SnmpMonitorResponse | undefined = (
+          data.dataToProcess as ProbeMonitorResponse
+        ).snmpResponse;
+
+        storageMap = {
+          isOnline: (data.dataToProcess as ProbeMonitorResponse).isOnline,
+          responseTimeInMs: snmpResponse?.responseTimeInMs,
+          failureCause: snmpResponse?.failureCause,
+          isTimeout: snmpResponse?.isTimeout,
+        } as JSONObject;
+
+        // Add OID responses as key-value pairs
+        if (snmpResponse?.oidResponses) {
+          storageMap["oidResponses"] = snmpResponse.oidResponses.map(
+            (oidResponse: SnmpOidResponse) => {
+              return {
+                oid: oidResponse.oid,
+                name: oidResponse.name,
+                value: oidResponse.value,
+                type: oidResponse.type,
+              };
+            },
+          );
+
+          // Also add OIDs by name for easier templating
+          for (const oidResponse of snmpResponse.oidResponses) {
+            if (oidResponse.name) {
+              storageMap[oidResponse.name] = oidResponse.value;
+            }
+          }
+        }
+      }
     } catch (err) {
       logger.error(err);
     }

package/Server/Utils/PushNotificationUtil.ts

@@ -174,6 +174,37 @@ export default class PushNotificationUtil {
     });
   }
 
+  public static createIncidentEpisodeCreatedNotification(params: {
+    incidentEpisodeTitle: string;
+    projectName: string;
+    incidentEpisodeViewLink: string;
+    episodeNumber?: number;
+  }): PushNotificationMessage {
+    const {
+      incidentEpisodeTitle,
+      projectName,
+      incidentEpisodeViewLink,
+      episodeNumber,
+    } = params;
+    const episodeIdentifier: string = episodeNumber
+      ? `#${episodeNumber} (${incidentEpisodeTitle})`
+      : incidentEpisodeTitle;
+    return PushNotificationUtil.applyDefaults({
+      title: `New Incident Episode${episodeNumber ? ` #${episodeNumber}` : ""}: ${incidentEpisodeTitle}`,
+      body: `A new incident episode has been created: ${episodeIdentifier} in ${projectName}. Click to view details.`,
+      clickAction: incidentEpisodeViewLink,
+      url: incidentEpisodeViewLink,
+      tag: "incident-episode-created",
+      requireInteraction: true,
+      data: {
+        type: "incident-episode-created",
+        incidentEpisodeTitle: incidentEpisodeTitle,
+        projectName: projectName,
+        url: incidentEpisodeViewLink,
+      },
+    });
+  }
+
   public static createMonitorStatusChangedNotification(params: {
     monitorName: string;
     projectName: string;

package/Server/Utils/WhatsAppTemplateUtil.ts

@@ -23,6 +23,12 @@ const templateDashboardLinkVariableMap: Partial<
   [WhatsAppTemplateIds.AlertEpisodeStateChangedOwnerNotification]:
     "episode_link",
   [WhatsAppTemplateIds.AlertEpisodeOwnerAddedNotification]: "episode_link",
+  [WhatsAppTemplateIds.IncidentEpisodeCreatedOwnerNotification]: "episode_link",
+  [WhatsAppTemplateIds.IncidentEpisodeNotePostedOwnerNotification]:
+    "episode_link",
+  [WhatsAppTemplateIds.IncidentEpisodeStateChangedOwnerNotification]:
+    "episode_link",
+  [WhatsAppTemplateIds.IncidentEpisodeOwnerAddedNotification]: "episode_link",
   [WhatsAppTemplateIds.IncidentCreated]: "incident_link",
   [WhatsAppTemplateIds.IncidentCreatedOwnerNotification]: "incident_link",
   [WhatsAppTemplateIds.IncidentNotePostedOwnerNotification]: "incident_link",
@@ -85,6 +91,14 @@ const templateIdByEventType: Record<
     WhatsAppTemplateIds.AlertEpisodeStateChangedOwnerNotification,
   [NotificationSettingEventType.SEND_ALERT_EPISODE_OWNER_ADDED_NOTIFICATION]:
     WhatsAppTemplateIds.AlertEpisodeOwnerAddedNotification,
+  [NotificationSettingEventType.SEND_INCIDENT_EPISODE_CREATED_OWNER_NOTIFICATION]:
+    WhatsAppTemplateIds.IncidentEpisodeCreatedOwnerNotification,
+  [NotificationSettingEventType.SEND_INCIDENT_EPISODE_NOTE_POSTED_OWNER_NOTIFICATION]:
+    WhatsAppTemplateIds.IncidentEpisodeNotePostedOwnerNotification,
+  [NotificationSettingEventType.SEND_INCIDENT_EPISODE_STATE_CHANGED_OWNER_NOTIFICATION]:
+    WhatsAppTemplateIds.IncidentEpisodeStateChangedOwnerNotification,
+  [NotificationSettingEventType.SEND_INCIDENT_EPISODE_OWNER_ADDED_NOTIFICATION]:
+    WhatsAppTemplateIds.IncidentEpisodeOwnerAddedNotification,
   [NotificationSettingEventType.SEND_MONITOR_OWNER_ADDED_NOTIFICATION]:
     WhatsAppTemplateIds.MonitorOwnerAddedNotification,
   [NotificationSettingEventType.SEND_MONITOR_CREATED_OWNER_NOTIFICATION]:

package/Server/Utils/Workspace/MicrosoftTeams/Actions/ActionTypes.ts

@@ -54,6 +54,23 @@ export enum MicrosoftTeamsAlertEpisodeActionType {
   SubmitChangeAlertEpisodeState = "SubmitChangeAlertEpisodeState",
 }
 
+// Incident Episode Actions
+export enum MicrosoftTeamsIncidentEpisodeActionType {
+  AckIncidentEpisode = "AckIncidentEpisode",
+  ResolveIncidentEpisode = "ResolveIncidentEpisode",
+  ViewIncidentEpisode = "ViewIncidentEpisode",
+  IncidentEpisodeCreated = "IncidentEpisodeCreated",
+  IncidentEpisodeStateChanged = "IncidentEpisodeStateChanged",
+  AddIncidentEpisodeNote = "AddIncidentEpisodeNote",
+  ExecuteIncidentEpisodeOnCallPolicy = "ExecuteIncidentEpisodeOnCallPolicy",
+  ViewAddIncidentEpisodeNote = "ViewAddIncidentEpisodeNote",
+  SubmitIncidentEpisodeNote = "SubmitIncidentEpisodeNote",
+  ViewExecuteIncidentEpisodeOnCallPolicy = "ViewExecuteIncidentEpisodeOnCallPolicy",
+  SubmitExecuteIncidentEpisodeOnCallPolicy = "SubmitExecuteIncidentEpisodeOnCallPolicy",
+  ViewChangeIncidentEpisodeState = "ViewChangeIncidentEpisodeState",
+  SubmitChangeIncidentEpisodeState = "SubmitChangeIncidentEpisodeState",
+}
+
 // Monitor Actions
 export enum MicrosoftTeamsMonitorActionType {
   ViewMonitor = "ViewMonitor",
@@ -107,6 +124,7 @@ export type MicrosoftTeamsActionType =
   | MicrosoftTeamsIncidentActionType
   | MicrosoftTeamsAlertActionType
   | MicrosoftTeamsAlertEpisodeActionType
+  | MicrosoftTeamsIncidentEpisodeActionType
   | MicrosoftTeamsMonitorActionType
   | MicrosoftTeamsScheduledMaintenanceActionType
   | MicrosoftTeamsOnCallDutyActionType