@oneuptime/common 7.0.3987 → 7.0.3993

package/Models/AnalyticsModels/Metric.ts

@@ -158,52 +158,6 @@ export default class Metric extends AnalyticsBaseModel {
           },
         }),
 
-        new AnalyticsTableColumn({
-          key: "description",
-          title: "Description",
-          description: "Description of the Metric",
-          required: false,
-          type: TableColumnType.Text,
-          accessControl: {
-            read: [
-              Permission.ProjectOwner,
-              Permission.ProjectAdmin,
-              Permission.ProjectMember,
-              Permission.ReadTelemetryServiceLog,
-            ],
-            create: [
-              Permission.ProjectOwner,
-              Permission.ProjectAdmin,
-              Permission.ProjectMember,
-              Permission.CreateTelemetryServiceLog,
-            ],
-            update: [],
-          },
-        }),
-
-        new AnalyticsTableColumn({
-          key: "unit",
-          title: "Unit",
-          description: "Unit of the Metric",
-          required: false,
-          type: TableColumnType.Text,
-          accessControl: {
-            read: [
-              Permission.ProjectOwner,
-              Permission.ProjectAdmin,
-              Permission.ProjectMember,
-              Permission.ReadTelemetryServiceLog,
-            ],
-            create: [
-              Permission.ProjectOwner,
-              Permission.ProjectAdmin,
-              Permission.ProjectMember,
-              Permission.CreateTelemetryServiceLog,
-            ],
-            update: [],
-          },
-        }),
-
         new AnalyticsTableColumn({
           key: "aggregationTemporality",
           title: "Aggregation Temporality",
@@ -603,22 +557,6 @@ export default class Metric extends AnalyticsBaseModel {
     this.setColumnValue("metricPointType", v);
   }
 
-  public get description(): string | undefined {
-    return this.getColumnValue("description") as string | undefined;
-  }
-
-  public set description(v: string | undefined) {
-    this.setColumnValue("description", v);
-  }
-
-  public get unit(): string | undefined {
-    return this.getColumnValue("unit") as string | undefined;
-  }
-
-  public set unit(v: string | undefined) {
-    this.setColumnValue("unit", v);
-  }
-
   public get isMonotonic(): boolean | undefined {
     return this.getColumnValue("isMonotonic") as boolean | undefined;
   }

package/Models/DatabaseModels/MetricType.ts

@@ -219,6 +219,69 @@ export default class MetricType extends BaseModel {
   @Index()
   public name?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateTelemetryServiceMetrics,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadTelemetryServiceMetrics,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditTelemetryServiceMetrics,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.VeryLongText,
+    canReadOnRelationQuery: true,
+    title: "Description",
+    description: "Metric description",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.VeryLongText,
+  })
+  public description?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateTelemetryServiceMetrics,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.ReadTelemetryServiceMetrics,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditTelemetryServiceMetrics,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.VeryLongText,
+    canReadOnRelationQuery: true,
+    title: "Description",
+    description: "Metric description",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public unit?: string = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Server/Infrastructure/Postgres/SchemaMigrations/1743538648415-MigrationName.ts

@@ -0,0 +1,19 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class MigrationName1743538648415 implements MigrationInterface {
+  public name = "MigrationName1743538648415";
+
+  public async up(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "MetricType" ADD "description" text`);
+    await queryRunner.query(
+      `ALTER TABLE "MetricType" ADD "unit" character varying(100)`,
+    );
+  }
+
+  public async down(queryRunner: QueryRunner): Promise<void> {
+    await queryRunner.query(`ALTER TABLE "MetricType" DROP COLUMN "unit"`);
+    await queryRunner.query(
+      `ALTER TABLE "MetricType" DROP COLUMN "description"`,
+    );
+  }
+}

package/Server/Infrastructure/Postgres/SchemaMigrations/Index.ts

@@ -126,6 +126,7 @@ import { MigrationName1743186793413 } from "./1743186793413-MigrationName";
 import { MigrationName1743518485566 } from "./1743518485566-MigrationName";
 import { MigrationName1743521461137 } from "./1743521461137-MigrationName";
 import { MigrationName1743530326936 } from "./1743530326936-MigrationName";
+import { MigrationName1743538648415 } from "./1743538648415-MigrationName";
 
 export default [
   InitialMigration,
@@ -256,4 +257,5 @@ export default [
   MigrationName1743518485566,
   MigrationName1743521461137,
   MigrationName1743530326936,
+  MigrationName1743538648415,
 ];

package/Server/Services/AlertService.ts

@@ -52,6 +52,8 @@ import Monitor from "../../Models/DatabaseModels/Monitor";
 import MonitorService from "./MonitorService";
 import { MessageBlocksByWorkspaceType } from "./WorkspaceNotificationRuleService";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import MetricType from "../../Models/DatabaseModels/MetricType";
+import Dictionary from "../../Types/Dictionary";
 
 export class Service extends DatabaseService<Model> {
   public constructor() {
@@ -946,8 +948,8 @@ ${alertSeverity.name}
           name: true,
         },
         alertSeverity: {
-          name: true,
           _id: true,
+          name: true,
         },
       },
       props: {
@@ -960,11 +962,10 @@ ${alertSeverity.name}
     }
 
     if (!alert.projectId) {
-      throw new BadDataException("Incient Project ID not found");
+      throw new BadDataException("Alert Project ID not found");
     }
 
     // get alert state timeline
-
     const alertStateTimelines: Array<AlertStateTimeline> =
       await AlertStateTimelineService.findBy({
         query: {
@@ -993,8 +994,7 @@ ${alertSeverity.name}
     const firstAlertStateTimeline: AlertStateTimeline | undefined =
       alertStateTimelines[0];
 
-    // delete all the alert metrics with this alert id because its a refresh.
-
+    // delete all the alert metrics with this alert id because it's a refresh
     await MetricService.deleteBy({
       query: {
         serviceId: data.alertId,
@@ -1005,9 +1005,9 @@ ${alertSeverity.name}
     });
 
     const itemsToSave: Array<Metric> = [];
+    const metricTypesMap: Dictionary<MetricType> = {};
 
     // now we need to create new metrics for this alert - TimeToAcknowledge, TimeToResolve, AlertCount, AlertDuration
-
     const alertStartsAt: Date =
       firstAlertStateTimeline?.startsAt ||
       alert.createdAt ||
@@ -1019,16 +1019,14 @@ ${alertSeverity.name}
     alertCountMetric.serviceId = alert.id!;
     alertCountMetric.serviceType = ServiceType.Alert;
     alertCountMetric.name = AlertMetricType.AlertCount;
-    alertCountMetric.description = "Number of alerts created";
     alertCountMetric.value = 1;
-    alertCountMetric.unit = "";
     alertCountMetric.attributes = {
       alertId: data.alertId.toString(),
       projectId: alert.projectId.toString(),
-      monitorId: alert.monitor?.id!.toString() || "",
-      monitorName: alert.monitor?.name!.toString() || "",
-      alertSeverityId: alert.alertSeverity?.id!.toString() || "",
-      alertSeverityName: alert.alertSeverity?.name!.toString() || "",
+      monitorId: alert.monitor?._id?.toString(),
+      monitorName: alert.monitor?.name?.toString(),
+      alertSeverityId: alert.alertSeverity?._id?.toString(),
+      alertSeverityName: alert.alertSeverity?.name?.toString(),
     };
 
     alertCountMetric.time = alertStartsAt;
@@ -1039,6 +1037,13 @@ ${alertSeverity.name}
 
     itemsToSave.push(alertCountMetric);
 
+    const metricType: MetricType = new MetricType();
+    metricType.name = alertCountMetric.name;
+    metricType.description = "Number of alerts created";
+    metricType.unit = "";
+    metricType.telemetryServices = [];
+    metricTypesMap[alertCountMetric.name] = metricType;
+
     // is the alert acknowledged?
     const isAlertAcknowledged: boolean = alertStateTimelines.some(
       (timeline: AlertStateTimeline) => {
@@ -1059,20 +1064,17 @@ ${alertSeverity.name}
         timeToAcknowledgeMetric.serviceId = alert.id!;
         timeToAcknowledgeMetric.serviceType = ServiceType.Alert;
         timeToAcknowledgeMetric.name = AlertMetricType.TimeToAcknowledge;
-        timeToAcknowledgeMetric.description =
-          "Time taken to acknowledge the alert";
         timeToAcknowledgeMetric.value = OneUptimeDate.getDifferenceInSeconds(
           ackAlertStateTimeline?.startsAt || OneUptimeDate.getCurrentDate(),
           alertStartsAt,
         );
-        timeToAcknowledgeMetric.unit = "seconds";
         timeToAcknowledgeMetric.attributes = {
           alertId: data.alertId.toString(),
           projectId: alert.projectId.toString(),
-          monitorId: alert.monitor?.id!.toString() || "",
-          monitorName: alert.monitor?.name!.toString() || "",
-          alertSeverityId: alert.alertSeverity?.id!.toString() || "",
-          alertSeverityName: alert.alertSeverity?.name!.toString() || "",
+          monitorId: alert.monitor?._id?.toString(),
+          monitorName: alert.monitor?.name?.toString(),
+          alertSeverityId: alert.alertSeverity?._id?.toString(),
+          alertSeverityName: alert.alertSeverity?.name?.toString(),
         };
 
         timeToAcknowledgeMetric.time =
@@ -1085,6 +1087,12 @@ ${alertSeverity.name}
         timeToAcknowledgeMetric.metricPointType = MetricPointType.Sum;
 
         itemsToSave.push(timeToAcknowledgeMetric);
+
+        const metricType: MetricType = new MetricType();
+        metricType.name = timeToAcknowledgeMetric.name;
+        metricType.description = "Time taken to acknowledge the alert";
+        metricType.unit = "seconds";
+        metricTypesMap[timeToAcknowledgeMetric.name] = metricType;
       }
     }
 
@@ -1108,20 +1116,18 @@ ${alertSeverity.name}
         timeToResolveMetric.serviceId = alert.id!;
         timeToResolveMetric.serviceType = ServiceType.Alert;
         timeToResolveMetric.name = AlertMetricType.TimeToResolve;
-        timeToResolveMetric.description = "Time taken to resolve the alert";
         timeToResolveMetric.value = OneUptimeDate.getDifferenceInSeconds(
           resolvedAlertStateTimeline?.startsAt ||
             OneUptimeDate.getCurrentDate(),
           alertStartsAt,
         );
-        timeToResolveMetric.unit = "seconds";
         timeToResolveMetric.attributes = {
           alertId: data.alertId.toString(),
           projectId: alert.projectId.toString(),
-          monitorId: alert.monitor?.id!.toString() || "",
-          monitorName: alert.monitor?.name!.toString() || "",
-          alertSeverityId: alert.alertSeverity?.id!.toString() || "",
-          alertSeverityName: alert.alertSeverity?.name!.toString() || "",
+          monitorId: alert.monitor?._id?.toString(),
+          monitorName: alert.monitor?.name?.toString(),
+          alertSeverityId: alert.alertSeverity?._id?.toString(),
+          alertSeverityName: alert.alertSeverity?.name?.toString(),
         };
 
         timeToResolveMetric.time =
@@ -1134,11 +1140,16 @@ ${alertSeverity.name}
         timeToResolveMetric.metricPointType = MetricPointType.Sum;
 
         itemsToSave.push(timeToResolveMetric);
+
+        const metricType: MetricType = new MetricType();
+        metricType.name = timeToResolveMetric.name;
+        metricType.description = "Time taken to resolve the alert";
+        metricType.unit = "seconds";
+        metricTypesMap[timeToResolveMetric.name] = metricType;
       }
     }
 
     // alert duration
-
     const alertDurationMetric: Metric = new Metric();
 
     const lastAlertStateTimeline: AlertStateTimeline | undefined =
@@ -1148,25 +1159,21 @@ ${alertSeverity.name}
       const alertEndsAt: Date =
         lastAlertStateTimeline.startsAt || OneUptimeDate.getCurrentDate();
 
-      // save metric.
-
       alertDurationMetric.projectId = alert.projectId;
       alertDurationMetric.serviceId = alert.id!;
       alertDurationMetric.serviceType = ServiceType.Alert;
       alertDurationMetric.name = AlertMetricType.AlertDuration;
-      alertDurationMetric.description = "Duration of the alert";
       alertDurationMetric.value = OneUptimeDate.getDifferenceInSeconds(
         alertEndsAt,
         alertStartsAt,
       );
-      alertDurationMetric.unit = "seconds";
       alertDurationMetric.attributes = {
         alertId: data.alertId.toString(),
         projectId: alert.projectId.toString(),
-        monitorId: alert.monitor?.id!.toString() || "",
-        monitorName: alert.monitor?.name!.toString() || "",
-        alertSeverityId: alert.alertSeverity?.id!.toString() || "",
-        alertSeverityName: alert.alertSeverity?.name!.toString() || "",
+        monitorId: alert.monitor?._id?.toString(),
+        monitorName: alert.monitor?.name?.toString(),
+        alertSeverityId: alert.alertSeverity?._id?.toString(),
+        alertSeverityName: alert.alertSeverity?.name?.toString(),
       };
 
       alertDurationMetric.time =
@@ -1177,6 +1184,14 @@ ${alertSeverity.name}
         alertDurationMetric.time,
       );
       alertDurationMetric.metricPointType = MetricPointType.Sum;
+
+      itemsToSave.push(alertDurationMetric);
+
+      const metricType: MetricType = new MetricType();
+      metricType.name = alertDurationMetric.name;
+      metricType.description = "Duration of the alert";
+      metricType.unit = "seconds";
+      metricTypesMap[alertDurationMetric.name] = metricType;
     }
 
     await MetricService.createMany({
@@ -1186,14 +1201,21 @@ ${alertSeverity.name}
       },
     });
 
-    // index attributes.
+    // index attributes
     TelemetryUtil.indexAttributes({
-      attributes: ["monitorId", "projectId", "alertId", "monitorNames"],
+      attributes: ["monitorId", "projectId", "alertId", "monitorName"],
       projectId: alert.projectId,
       telemetryType: TelemetryType.Metric,
     }).catch((err: Error) => {
       logger.error(err);
     });
+
+    TelemetryUtil.indexMetricNameServiceNameMap({
+      metricNameServiceNameMap: metricTypesMap,
+      projectId: alert.projectId,
+    }).catch((err: Error) => {
+      logger.error(err);
+    });
   }
 
   @CaptureSpan()

package/Server/Services/IncidentService.ts

@@ -59,6 +59,8 @@ import WorkspaceType from "../../Types/Workspace/WorkspaceType";
 import { MessageBlocksByWorkspaceType } from "./WorkspaceNotificationRuleService";
 import NotificationRuleWorkspaceChannel from "../../Types/Workspace/NotificationRules/NotificationRuleWorkspaceChannel";
 import CaptureSpan from "../Utils/Telemetry/CaptureSpan";
+import { Dictionary } from "lodash";
+import MetricType from "../../Models/DatabaseModels/MetricType";
 
 export class Service extends DatabaseService<Model> {
   public constructor() {
@@ -1327,15 +1329,15 @@ ${incidentSeverity.name}
       incident.createdAt ||
       OneUptimeDate.getCurrentDate();
 
+    const metricTypesMap: Dictionary<MetricType> = {};
+
     const incidentCountMetric: Metric = new Metric();
 
     incidentCountMetric.projectId = incident.projectId;
     incidentCountMetric.serviceId = incident.id!;
     incidentCountMetric.serviceType = ServiceType.Incident;
     incidentCountMetric.name = IncidentMetricType.IncidentCount;
-    incidentCountMetric.description = "Number of incidents created";
     incidentCountMetric.value = 1;
-    incidentCountMetric.unit = "";
     incidentCountMetric.attributes = {
       incidentId: data.incidentId.toString(),
       projectId: incident.projectId.toString(),
@@ -1359,6 +1361,16 @@ ${incidentSeverity.name}
 
     itemsToSave.push(incidentCountMetric);
 
+    // add metric type for this to map.
+    const metricType: MetricType = new MetricType();
+    metricType.name = incidentCountMetric.name;
+    metricType.description = "Number of incidents created";
+    metricType.unit = "";
+    metricType.telemetryServices = [];
+
+    // add to map.
+    metricTypesMap[incidentCountMetric.name] = metricType;
+
     // is the incident acknowledged?
     const isIncidentAcknowledged: boolean = incidentStateTimelines.some(
       (timeline: IncidentStateTimeline) => {
@@ -1379,13 +1391,10 @@ ${incidentSeverity.name}
         timeToAcknowledgeMetric.serviceId = incident.id!;
         timeToAcknowledgeMetric.serviceType = ServiceType.Incident;
         timeToAcknowledgeMetric.name = IncidentMetricType.TimeToAcknowledge;
-        timeToAcknowledgeMetric.description =
-          "Time taken to acknowledge the incident";
         timeToAcknowledgeMetric.value = OneUptimeDate.getDifferenceInSeconds(
           ackIncidentStateTimeline?.startsAt || OneUptimeDate.getCurrentDate(),
           incidentStartsAt,
         );
-        timeToAcknowledgeMetric.unit = "seconds";
         timeToAcknowledgeMetric.attributes = {
           incidentId: data.incidentId.toString(),
           projectId: incident.projectId.toString(),
@@ -1411,6 +1420,15 @@ ${incidentSeverity.name}
         timeToAcknowledgeMetric.metricPointType = MetricPointType.Sum;
 
         itemsToSave.push(timeToAcknowledgeMetric);
+
+        // add metric type for this to map.
+        const metricType: MetricType = new MetricType();
+        metricType.name = timeToAcknowledgeMetric.name;
+        metricType.description = "Time taken to acknowledge the incident";
+        metricType.unit = "seconds";
+
+        // add to map.
+        metricTypesMap[timeToAcknowledgeMetric.name] = metricType;
       }
     }
 
@@ -1434,13 +1452,11 @@ ${incidentSeverity.name}
         timeToResolveMetric.serviceId = incident.id!;
         timeToResolveMetric.serviceType = ServiceType.Incident;
         timeToResolveMetric.name = IncidentMetricType.TimeToResolve;
-        timeToResolveMetric.description = "Time taken to resolve the incident";
         timeToResolveMetric.value = OneUptimeDate.getDifferenceInSeconds(
           resolvedIncidentStateTimeline?.startsAt ||
             OneUptimeDate.getCurrentDate(),
           incidentStartsAt,
         );
-        timeToResolveMetric.unit = "seconds";
         timeToResolveMetric.attributes = {
           incidentId: data.incidentId.toString(),
           projectId: incident.projectId.toString(),
@@ -1466,6 +1482,14 @@ ${incidentSeverity.name}
         timeToResolveMetric.metricPointType = MetricPointType.Sum;
 
         itemsToSave.push(timeToResolveMetric);
+
+        // add metric type for this to map.
+        const metricType: MetricType = new MetricType();
+        metricType.name = timeToResolveMetric.name;
+        metricType.description = "Time taken to resolve the incident";
+        metricType.unit = "seconds";
+        // add to map.
+        metricTypesMap[timeToResolveMetric.name] = metricType;
       }
     }
 
@@ -1486,12 +1510,10 @@ ${incidentSeverity.name}
       incidentDurationMetric.serviceId = incident.id!;
       incidentDurationMetric.serviceType = ServiceType.Incident;
       incidentDurationMetric.name = IncidentMetricType.IncidentDuration;
-      incidentDurationMetric.description = "Duration of the incident";
       incidentDurationMetric.value = OneUptimeDate.getDifferenceInSeconds(
         incidentEndsAt,
         incidentStartsAt,
       );
-      incidentDurationMetric.unit = "seconds";
       incidentDurationMetric.attributes = {
         incidentId: data.incidentId.toString(),
         projectId: incident.projectId.toString(),
@@ -1515,6 +1537,17 @@ ${incidentSeverity.name}
         incidentDurationMetric.time,
       );
       incidentDurationMetric.metricPointType = MetricPointType.Sum;
+
+      itemsToSave.push(incidentDurationMetric);
+
+      // add metric type for this to map.
+      const metricType: MetricType = new MetricType();
+      metricType.name = incidentDurationMetric.name;
+      metricType.description = "Duration of the incident";
+      metricType.unit = "seconds";
+
+      // add to map.
+      metricTypesMap[incidentDurationMetric.name] = metricType;
     }
 
     await MetricService.createMany({
@@ -1532,6 +1565,13 @@ ${incidentSeverity.name}
     }).catch((err: Error) => {
       logger.error(err);
     });
+
+    TelemetryUtil.indexMetricNameServiceNameMap({
+      metricNameServiceNameMap: metricTypesMap,
+      projectId: incident.projectId,
+    }).catch((err: Error) => {
+      logger.error(err);
+    });
   }
 
   @CaptureSpan()