@oneuptime/common 7.0.3840 → 7.0.3864

package/Server/Utils/Telemetry/CaptureSpan.ts

@@ -0,0 +1,116 @@
+import Telemetry from "../Telemetry";
+import { Span, SpanStatusCode } from "@opentelemetry/api";
+import { JSONObject } from "../../../Types/JSON";
+import JSONFunctions from "../../../Types/JSONFunctions";
+import { DisableTelemetry } from "../../EnvironmentConfig";
+
+function CaptureSpan(data?: {
+  name?: string;
+  attributes?: JSONObject;
+  captureArguments?: boolean;
+}): (
+  target: any,
+  propertyKey: string,
+  descriptor: TypedPropertyDescriptor<any>,
+) => TypedPropertyDescriptor<any> {
+  return function (
+    target: any,
+    propertyKey: string,
+    descriptor: TypedPropertyDescriptor<any>,
+  ) {
+    const originalMethod: any = descriptor.value;
+
+    let className: string | undefined = target?.constructor?.name;
+
+    if (className === "" || className === "Function") {
+      const staticClassName: string | undefined = target?.name;
+
+      if (staticClassName) {
+        className = staticClassName;
+      }
+    }
+
+    if (!className) {
+      className = "UnknownClass";
+    }
+
+    const name: string | undefined =
+      data?.name || `${className}.${propertyKey}`;
+
+    descriptor.value = function (...args: any[]) {
+      if (DisableTelemetry) {
+        return originalMethod.apply(this, args);
+      }
+
+      let functionArguments: JSONObject = {};
+
+      if (data?.captureArguments) {
+        functionArguments = args.reduce(
+          (acc: { [key: string]: any }, arg: any, index: number) => {
+            acc[`arg${index}`] = arg;
+            return acc;
+          },
+          {},
+        );
+      }
+
+      const spanAttributes: { [key: string]: any } =
+        JSONFunctions.flattenObject({
+          ...functionArguments,
+          ...data?.attributes,
+        }) as { [key: string]: any };
+
+      return Telemetry.startActiveSpan({
+        name: name,
+        options: {
+          attributes: spanAttributes,
+        },
+        fn: (span: Span) => {
+          let result: any = null;
+          try {
+            result = originalMethod.apply(this, args);
+            if (result instanceof Promise) {
+              return result
+                .then((res: any) => {
+                  span.setStatus({
+                    code: SpanStatusCode.OK,
+                  });
+                  return res;
+                })
+                .catch((err: Error) => {
+                  Telemetry.recordExceptionMarkSpanAsErrorAndEndSpan({
+                    span,
+                    exception: err,
+                  });
+
+                  throw err;
+                })
+                .finally(() => {
+                  span.end();
+                });
+            }
+            span.setStatus({
+              code: SpanStatusCode.OK,
+            });
+            return result;
+          } catch (err) {
+            Telemetry.recordExceptionMarkSpanAsErrorAndEndSpan({
+              span,
+              exception: err,
+            });
+
+            throw err;
+          } finally {
+            if (!(result instanceof Promise)) {
+              span.end();
+            }
+          }
+        },
+      });
+    };
+
+    return descriptor;
+  };
+}
+
+export default CaptureSpan;

package/Server/Utils/Telemetry/Telemetry.ts

@@ -5,8 +5,10 @@ import TelemetryType from "../../../Types/Telemetry/TelemetryType";
 import ArrayUtil from "../../../Utils/Array";
 import GlobalCache from "../../Infrastructure/GlobalCache";
 import TelemetryAttributeService from "../../Services/TelemetryAttributeService";
+import CaptureSpan from "./CaptureSpan";
 
 export default class TelemetryUtil {
+  @CaptureSpan()
   public static async indexAttributes(data: {
     attributes: string[];
     projectId: ObjectID;
@@ -60,6 +62,7 @@ export default class TelemetryUtil {
     }
   }
 
+  @CaptureSpan()
   public static getAttributes(data: {
     items: JSONArray;
     telemetryServiceId?: ObjectID;

package/Server/Utils/Telemetry.ts

@@ -52,11 +52,17 @@ export enum SpanStatusCode {
 
 export default class Telemetry {
   public static sdk: opentelemetry.NodeSDK | null = null;
+
   public static logger: Logger | null = null;
+
   public static meter: Meter | null = null;
+
   public static meterProvider: MeterProvider | null = null;
+
   public static loggerProvider: LoggerProvider | null = null;
+
   public static metricReader: PeriodicExportingMetricReader | undefined;
+
   public static serviceName: string | null = null;
 
   public static getHeaders(): Dictionary<string> {

package/Server/Utils/TwoFactorAuth.ts

@@ -1,5 +1,6 @@
 import Email from "Common/Types/Email";
 import * as OTPAuth from "otpauth";
+import CaptureSpan from "./Telemetry/CaptureSpan";
 
 /**
  * Utility class for handling two-factor authentication.
@@ -9,14 +10,17 @@ export default class TwoFactorAuth {
    * Generates a random secret key for two-factor authentication.
    * @returns The generated secret key.
    */
+  @CaptureSpan()
   public static generateSecret(): string {
     return new OTPAuth.Secret().base32;
   }
 
+  @CaptureSpan()
   public static getLabel(data: { email: Email }): string {
     return data.email.toString();
   }
 
+  @CaptureSpan()
   public static getTotp(data: { secret: string; email: Email }): OTPAuth.TOTP {
     const totp: OTPAuth.TOTP = new OTPAuth.TOTP({
       // Provider or service the account is associated with.
@@ -43,6 +47,7 @@ export default class TwoFactorAuth {
    * @param data - The data object containing the secret key and token.
    * @returns A boolean indicating whether the token is valid or not.
    */
+  @CaptureSpan()
   public static verifyToken(data: {
     secret: string;
     token: string;
@@ -62,6 +67,7 @@ export default class TwoFactorAuth {
    * @param data - The data object containing the secret key and user email.
    * @returns The generated URI for setting up two-factor authentication.
    */
+  @CaptureSpan()
   public static generateUri(data: {
     secret: string;
     userEmail: Email;

package/Server/Utils/UserPermission/UserPermission.ts

@@ -7,8 +7,10 @@ import Permission, {
 } from "../../../Types/Permission";
 import GlobalCache from "../../Infrastructure/GlobalCache";
 import PermissionNamespace from "../../Types/Permission/PermissionNamespace";
+import CaptureSpan from "../Telemetry/CaptureSpan";
 
 export default class UserPermissionUtil {
+  @CaptureSpan()
   public static async getUserTenantAccessPermissionFromCache(
     userId: ObjectID,
     projectId: ObjectID,
@@ -30,6 +32,7 @@ export default class UserPermissionUtil {
     return json;
   }
 
+  @CaptureSpan()
   public static async getUserGlobalAccessPermissionFromCache(
     userId: ObjectID,
   ): Promise<UserGlobalAccessPermission | null> {
@@ -50,6 +53,7 @@ export default class UserPermissionUtil {
     return accessPermission;
   }
 
+  @CaptureSpan()
   public static getDefaultUserTenantAccessPermission(
     projectId: ObjectID,
   ): UserTenantAccessPermission {

package/Server/Utils/VM/VMAPI.ts

@@ -8,8 +8,10 @@ import URL from "Common/Types/API/URL";
 import ReturnResult from "Common/Types/IsolatedVM/ReturnResult";
 import { JSONObject, JSONValue } from "Common/Types/JSON";
 import API from "Common/Utils/API";
+import CaptureSpan from "../Telemetry/CaptureSpan";
 
 export default class VMUtil {
+  @CaptureSpan()
   public static async runCodeInSandbox(data: {
     code: string;
     options: {
@@ -42,6 +44,7 @@ export default class VMUtil {
     return returnResult;
   }
 
+  @CaptureSpan()
   public static replaceValueInPlace(
     storageMap: JSONObject,
     valueToReplaceInPlace: string,
@@ -108,6 +111,7 @@ export default class VMUtil {
     return valueToReplaceInPlace;
   }
 
+  @CaptureSpan()
   public static serializeValueForJSON(value: string): string {
     if (!value) {
       return value;
@@ -134,6 +138,7 @@ export default class VMUtil {
     return value;
   }
 
+  @CaptureSpan()
   public static deepFind(obj: JSONObject, path: string): JSONValue {
     const paths: Array<string> = path.split(".");
     let current: any = JSON.parse(JSON.stringify(obj));

package/Server/Utils/VM/VMRunner.ts

@@ -6,8 +6,10 @@ import axios from "axios";
 import http from "http";
 import https from "https";
 import vm, { Context } from "node:vm";
+import CaptureSpan from "../Telemetry/CaptureSpan";
 
 export default class VMRunner {
+  @CaptureSpan()
   public static async runCodeInSandbox(data: {
     code: string;
     options: {

package/Server/Utils/Workspace/MicrosoftTeams/Messages/Alert.ts

@@ -8,8 +8,10 @@ import {
 } from "../../../../../Types/Workspace/WorkspaceMessagePayload";
 import AlertService from "../../../../Services/AlertService";
 import MicrosoftTeamsActionType from "../../../../Utils/Workspace/MicrosoftTeams/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class MicrosoftTeamsAlertMessages {
+  @CaptureSpan()
   public static async getAlertCreateMessageBlocks(data: {
     alertId: ObjectID;
     projectId: ObjectID;

package/Server/Utils/Workspace/MicrosoftTeams/Messages/Incident.ts

@@ -8,8 +8,10 @@ import {
 } from "../../../../../Types/Workspace/WorkspaceMessagePayload";
 import IncidentService from "../../../../Services/IncidentService";
 import MicrosoftTeamsActionType from "../../../../Utils/Workspace/MicrosoftTeams/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class MicrosoftTeamsIncidentMessages {
+  @CaptureSpan()
   public static async getIncidentCreateMessageBlocks(data: {
     incidentId: ObjectID;
     projectId: ObjectID;

package/Server/Utils/Workspace/MicrosoftTeams/Messages/ScheduledMaintenance.ts

@@ -8,8 +8,10 @@ import {
 } from "../../../../../Types/Workspace/WorkspaceMessagePayload";
 import ScheduledMaintenanceService from "../../../../Services/ScheduledMaintenanceService";
 import MicrosoftTeamsActionType from "../../../../Utils/Workspace/MicrosoftTeams/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class MicrosoftTeamsScheduledMaintenanceMessages {
+  @CaptureSpan()
   public static async getScheduledMaintenanceCreateMessageBlocks(data: {
     scheduledMaintenanceId: ObjectID;
     projectId: ObjectID;

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

@@ -33,6 +33,9 @@ enum SlackActionType {
   ViewScheduledMaintenance = "ViewScheduledMaintenance",
   NewScheduledMaintenance = "/maintenance", // new scheduled maintenance slash command
   SubmitNewScheduledMaintenance = "SubmitNewScheduledMaintenance",
+
+  // Monitor Actions
+  ViewMonitor = "ViewMonitor",
 }
 
 export default SlackActionType;

package/Server/Utils/Workspace/Slack/Actions/Alert.ts

@@ -22,8 +22,10 @@ import AlertState from "../../../../../Models/DatabaseModels/AlertState";
 import AlertStateService from "../../../../Services/AlertStateService";
 import logger from "../../../Logger";
 import AccessTokenService from "../../../../Services/AccessTokenService";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class SlackAlertActions {
+  @CaptureSpan()
   public static isAlertAction(data: { actionType: SlackActionType }): boolean {
     const { actionType } = data;
 
@@ -43,6 +45,7 @@ export default class SlackAlertActions {
     }
   }
 
+  @CaptureSpan()
   public static async acknowledgeAlert(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -133,6 +136,7 @@ export default class SlackAlertActions {
     );
   }
 
+  @CaptureSpan()
   public static async resolveAlert(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -220,6 +224,7 @@ export default class SlackAlertActions {
     );
   }
 
+  @CaptureSpan()
   public static async viewExecuteOnCallPolicy(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -297,6 +302,7 @@ export default class SlackAlertActions {
     });
   }
 
+  @CaptureSpan()
   public static async viewChangeAlertState(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -373,6 +379,7 @@ export default class SlackAlertActions {
     });
   }
 
+  @CaptureSpan()
   public static async submitChangeAlertState(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -431,6 +438,7 @@ export default class SlackAlertActions {
     });
   }
 
+  @CaptureSpan()
   public static async executeOnCallPolicy(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -531,6 +539,7 @@ export default class SlackAlertActions {
     }
   }
 
+  @CaptureSpan()
   public static async submitAlertNote(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -587,6 +596,7 @@ export default class SlackAlertActions {
     });
   }
 
+  @CaptureSpan()
   public static async viewAddAlertNote(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -638,6 +648,7 @@ export default class SlackAlertActions {
     });
   }
 
+  @CaptureSpan()
   public static async handleAlertAction(data: {
     slackRequest: SlackRequest;
     action: SlackAction;

package/Server/Utils/Workspace/Slack/Actions/Auth.ts

@@ -12,6 +12,7 @@ import WorkspaceProjectAuthTokenService from "../../../../Services/WorkspaceProj
 import logger from "../../../Logger";
 import { JSONArray, JSONObject } from "../../../../../Types/JSON";
 import { Dictionary } from "lodash";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export interface SlackAction {
   actionValue?: string | undefined;
@@ -40,6 +41,7 @@ export interface SlackRequest {
 }
 
 export default class SlackAuthAction {
+  @CaptureSpan()
   public static async isAuthorized(data: {
     req: ExpressRequest;
   }): Promise<SlackRequest> {

package/Server/Utils/Workspace/Slack/Actions/Incident.ts

@@ -35,8 +35,10 @@ import Label from "../../../../../Models/DatabaseModels/Label";
 import LabelService from "../../../../Services/LabelService";
 import Incident from "../../../../../Models/DatabaseModels/Incident";
 import AccessTokenService from "../../../../Services/AccessTokenService";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class SlackIncidentActions {
+  @CaptureSpan()
   public static isIncidentAction(data: {
     actionType: SlackActionType;
   }): boolean {
@@ -60,6 +62,7 @@ export default class SlackIncidentActions {
     }
   }
 
+  @CaptureSpan()
   public static async submitNewIncident(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -198,6 +201,7 @@ export default class SlackIncidentActions {
     }
   }
 
+  @CaptureSpan()
   public static async viewNewIncidentModal(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -407,6 +411,7 @@ export default class SlackIncidentActions {
     });
   }
 
+  @CaptureSpan()
   public static async acknowledgeIncident(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -498,6 +503,7 @@ export default class SlackIncidentActions {
     );
   }
 
+  @CaptureSpan()
   public static async resolveIncident(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -587,6 +593,7 @@ export default class SlackIncidentActions {
     );
   }
 
+  @CaptureSpan()
   public static async viewExecuteOnCallPolicy(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -664,6 +671,7 @@ export default class SlackIncidentActions {
     });
   }
 
+  @CaptureSpan()
   public static async viewChangeIncidentState(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -740,6 +748,7 @@ export default class SlackIncidentActions {
     });
   }
 
+  @CaptureSpan()
   public static async submitChangeIncidentState(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -798,6 +807,7 @@ export default class SlackIncidentActions {
     });
   }
 
+  @CaptureSpan()
   public static async executeOnCallPolicy(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -901,6 +911,7 @@ export default class SlackIncidentActions {
     }
   }
 
+  @CaptureSpan()
   public static async submitIncidentNote(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -988,6 +999,7 @@ export default class SlackIncidentActions {
     }
   }
 
+  @CaptureSpan()
   public static async viewAddIncidentNote(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -1056,6 +1068,7 @@ export default class SlackIncidentActions {
     });
   }
 
+  @CaptureSpan()
   public static async handleIncidentAction(data: {
     slackRequest: SlackRequest;
     action: SlackAction;

package/Server/Utils/Workspace/Slack/Actions/Monitor.ts

@@ -0,0 +1,48 @@
+import BadDataException from "../../../../../Types/Exception/BadDataException";
+import { ExpressRequest, ExpressResponse } from "../../../Express";
+import SlackActionType from "./ActionTypes";
+import { SlackAction, SlackRequest } from "./Auth";
+import Response from "../../../Response";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
+
+export default class SlackMonitorActions {
+  @CaptureSpan()
+  public static isMonitorAction(data: {
+    actionType: SlackActionType;
+  }): boolean {
+    const { actionType } = data;
+
+    switch (actionType) {
+      case SlackActionType.ViewMonitor:
+        return true;
+      default:
+        return false;
+    }
+  }
+
+  @CaptureSpan()
+  public static async handleMonitorAction(data: {
+    slackRequest: SlackRequest;
+    action: SlackAction;
+    req: ExpressRequest;
+    res: ExpressResponse;
+  }): Promise<void> {
+    // now we should be all set, project is authorized and user is authorized. Lets perform some actions based on the action type.
+    const actionType: SlackActionType | undefined = data.action.actionType;
+
+    if (actionType === SlackActionType.ViewMonitor) {
+      // do nothing. This is just a view Monitor action.
+      // clear response.
+      return Response.sendJsonObjectResponse(data.req, data.res, {
+        response_action: "clear",
+      });
+    }
+
+    // invalid action type.
+    return Response.sendErrorResponse(
+      data.req,
+      data.res,
+      new BadDataException("Invalid Action Type"),
+    );
+  }
+}

package/Server/Utils/Workspace/Slack/Actions/ScheduledMaintenance.ts

@@ -32,8 +32,10 @@ import LabelService from "../../../../Services/LabelService";
 import ScheduledMaintenance from "../../../../../Models/DatabaseModels/ScheduledMaintenance";
 import OneUptimeDate from "../../../../../Types/Date";
 import AccessTokenService from "../../../../Services/AccessTokenService";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class SlackScheduledMaintenanceActions {
+  @CaptureSpan()
   public static isScheduledMaintenanceAction(data: {
     actionType: SlackActionType;
   }): boolean {
@@ -55,6 +57,7 @@ export default class SlackScheduledMaintenanceActions {
     }
   }
 
+  @CaptureSpan()
   public static async submitNewScheduledMaintenance(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -220,6 +223,7 @@ export default class SlackScheduledMaintenanceActions {
     }
   }
 
+  @CaptureSpan()
   public static async viewNewScheduledMaintenanceModal(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -416,6 +420,7 @@ export default class SlackScheduledMaintenanceActions {
     });
   }
 
+  @CaptureSpan()
   public static async markScheduledMaintenanceAsOngoing(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -513,6 +518,7 @@ export default class SlackScheduledMaintenanceActions {
     );
   }
 
+  @CaptureSpan()
   public static async resolveScheduledMaintenance(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -608,6 +614,7 @@ export default class SlackScheduledMaintenanceActions {
     );
   }
 
+  @CaptureSpan()
   public static async viewChangeScheduledMaintenanceState(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -684,6 +691,7 @@ export default class SlackScheduledMaintenanceActions {
     });
   }
 
+  @CaptureSpan()
   public static async submitChangeScheduledMaintenanceState(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -742,6 +750,7 @@ export default class SlackScheduledMaintenanceActions {
     });
   }
 
+  @CaptureSpan()
   public static async submitScheduledMaintenanceNote(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -829,6 +838,7 @@ export default class SlackScheduledMaintenanceActions {
     }
   }
 
+  @CaptureSpan()
   public static async viewAddScheduledMaintenanceNote(data: {
     slackRequest: SlackRequest;
     action: SlackAction;
@@ -897,6 +907,7 @@ export default class SlackScheduledMaintenanceActions {
     });
   }
 
+  @CaptureSpan()
   public static async handleScheduledMaintenanceAction(data: {
     slackRequest: SlackRequest;
     action: SlackAction;

package/Server/Utils/Workspace/Slack/Messages/Alert.ts

@@ -8,8 +8,10 @@ import {
 } from "../../../../../Types/Workspace/WorkspaceMessagePayload";
 import AlertService from "../../../../Services/AlertService";
 import SlackActionType from "../../../../Utils/Workspace/Slack/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class SlackAlertMessages {
+  @CaptureSpan()
   public static async getAlertCreateMessageBlocks(data: {
     alertId: ObjectID;
     projectId: ObjectID;

package/Server/Utils/Workspace/Slack/Messages/Incident.ts

@@ -8,8 +8,10 @@ import {
 } from "../../../../../Types/Workspace/WorkspaceMessagePayload";
 import IncidentService from "../../../../Services/IncidentService";
 import SlackActionType from "../../../../Utils/Workspace/Slack/Actions/ActionTypes";
+import CaptureSpan from "../../../Telemetry/CaptureSpan";
 
 export default class SlackIncidentMessages {
+  @CaptureSpan()
   public static async getIncidentCreateMessageBlocks(data: {
     incidentId: ObjectID;
     projectId: ObjectID;