@oneuptime/common 7.0.2928 → 7.0.2936

package/Models/AnalyticsModels/MonitorMetricsByMinute.ts

@@ -0,0 +1,177 @@
+import AnalyticsBaseModel from "./AnalyticsBaseModel/AnalyticsBaseModel";
+import Route from "../../Types/API/Route";
+import AnalyticsTableEngine from "../../Types/AnalyticsDatabase/AnalyticsTableEngine";
+import AnalyticsTableColumn from "../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../Types/AnalyticsDatabase/TableColumnType";
+import BrowserType from "../../Types/BrowserType";
+import { JSONObject } from "../../Types/JSON";
+import { CheckOn } from "../../Types/Monitor/CriteriaFilter";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import ScreenSizeType from "../../Types/ScreenSizeType";
+
+export interface MonitorMetricsMiscData {
+  diskPath?: string;
+  probeId?: string;
+  browserType?: BrowserType;
+  screenSizeType?: ScreenSizeType;
+}
+
+export default class MonitorMetricsByMinute extends AnalyticsBaseModel {
+  public constructor() {
+    super({
+      tableName: "MonitorMetrics",
+      tableEngine: AnalyticsTableEngine.MergeTree,
+      singularName: "Monitor Metric",
+      pluralName: "Monitor Metrics",
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.ReadProjectMonitor,
+        ],
+        create: [],
+        update: [],
+        delete: [],
+      },
+      crudApiPath: new Route("/monitor-metrics"),
+      tableColumns: [
+        new AnalyticsTableColumn({
+          key: "projectId",
+          title: "Project ID",
+          description: "ID of project",
+          required: true,
+          type: TableColumnType.ObjectID,
+          isTenantId: true,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadProjectMonitor,
+            ],
+            create: [],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "monitorId",
+          title: "Monitor ID",
+          description: "ID of the Monitor which this metric belongs to",
+          required: true,
+          type: TableColumnType.ObjectID,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadProjectMonitor,
+            ],
+            create: [],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "metricType",
+          title: "Metric Type",
+          description: "Type of metric",
+          required: true,
+          type: TableColumnType.Text,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadProjectMonitor,
+            ],
+            create: [],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "metricValue",
+          title: "Metric Value",
+          description: "Value of the metric",
+          required: true,
+          type: TableColumnType.Number,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadProjectMonitor,
+            ],
+            create: [],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "miscData",
+          title: "Misc Data",
+          description: "Misc data for the metric (if any)",
+          required: false,
+          type: TableColumnType.JSON,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadProjectMonitor,
+            ],
+            create: [],
+            update: [],
+          },
+        }),
+      ],
+      sortKeys: ["projectId", "monitorId", "createdAt"],
+      primaryKeys: ["projectId", "monitorId"],
+    });
+  }
+
+  public get projectId(): ObjectID | undefined {
+    return this.getColumnValue("projectId") as ObjectID | undefined;
+  }
+
+  public set projectId(v: ObjectID | undefined) {
+    this.setColumnValue("projectId", v);
+  }
+
+  public get monitorId(): ObjectID | undefined {
+    return this.getColumnValue("monitorId") as ObjectID | undefined;
+  }
+
+  public set monitorId(v: ObjectID | undefined) {
+    this.setColumnValue("monitorId", v);
+  }
+
+  public get metricType(): CheckOn | undefined {
+    return this.getColumnValue("metricType") as CheckOn | undefined;
+  }
+
+  public set metricType(v: CheckOn | undefined) {
+    this.setColumnValue("metricType", v);
+  }
+
+  public get metricValue(): number | undefined {
+    return this.getColumnValue("metricValue") as number | undefined;
+  }
+
+  public set metricValue(v: number | undefined) {
+    this.setColumnValue("metricValue", v);
+  }
+
+  public get miscData(): MonitorMetricsMiscData | undefined {
+    return this.getColumnValue("miscData") as
+      | MonitorMetricsMiscData
+      | undefined;
+  }
+
+  public set miscData(v: MonitorMetricsMiscData | undefined) {
+    this.setColumnValue("miscData", v as JSONObject);
+  }
+}

package/Models/AnalyticsModels/NestedModels/KeyValueNestedModel.ts

@@ -0,0 +1,59 @@
+import AnalyticsTableColumn from "../../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../../Types/AnalyticsDatabase/TableColumnType";
+import NestedModel from "../AnalyticsBaseModel/NestedModel";
+
+export default class KeyValueNestedModel extends NestedModel {
+  public constructor() {
+    super({
+      tableColumns: [
+        new AnalyticsTableColumn({
+          key: "key",
+          title: "Key",
+          description: "Key of the attribute",
+          required: true,
+          type: TableColumnType.Text,
+        }),
+
+        new AnalyticsTableColumn({
+          key: "stringValue",
+          title: "String Value",
+          description: "Key of the attribute",
+          required: false,
+          type: TableColumnType.Text,
+        }),
+
+        new AnalyticsTableColumn({
+          key: "numberValue",
+          title: "Number Value",
+          description: "Value of the attribute",
+          required: false,
+          type: TableColumnType.Number,
+        }),
+      ],
+    });
+  }
+
+  public get key(): string | undefined {
+    return this.getColumnValue("key");
+  }
+
+  public set key(v: string | undefined) {
+    this.setColumnValue("key", v);
+  }
+
+  public get stringValue(): string | undefined {
+    return this.getColumnValue("stringValue");
+  }
+
+  public set stringValue(v: string | undefined) {
+    this.setColumnValue("stringValue", v);
+  }
+
+  public get numberValue(): number | undefined {
+    return this.getColumnValue("numberValue");
+  }
+
+  public set numberValue(v: number | undefined) {
+    this.setColumnValue("numberValue", v);
+  }
+}