@oneuptime/common 7.0.2923 → 7.0.2936

package/{AnalyticsModels/BaseModel.ts → Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel.ts}

@@ -1,23 +1,25 @@
-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 Route from "../../../Types/API/Route";
+import AnalyticsTableEngine from "../../../Types/AnalyticsDatabase/AnalyticsTableEngine";
+import AnalyticsTableColumn from "../../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../../Types/AnalyticsDatabase/TableColumnType";
 import {
   ColumnAccessControl,
   TableAccessControl,
-} from "../Types/BaseDatabase/AccessControl";
-import ColumnBillingAccessControl from "../Types/BaseDatabase/ColumnBillingAccessControl";
-import EnableWorkflowOn from "../Types/BaseDatabase/EnableWorkflowOn";
-import ModelPermission from "../Types/BaseDatabase/ModelPermission";
-import TableBillingAccessControl from "../Types/BaseDatabase/TableBillingAccessControl";
-import { PlanType } from "../Types/Billing/SubscriptionPlan";
-import Dictionary from "../Types/Dictionary";
-import BadDataException from "../Types/Exception/BadDataException";
-import { JSONValue } from "../Types/JSON";
-import ObjectID from "../Types/ObjectID";
-import Permission, { UserTenantAccessPermission } from "../Types/Permission";
-import Text from "../Types/Text";
-import { EnableRealtimeEventsOn } from "../Utils/Realtime";
+} from "../../../Types/BaseDatabase/AccessControl";
+import ColumnBillingAccessControl from "../../../Types/BaseDatabase/ColumnBillingAccessControl";
+import EnableWorkflowOn from "../../../Types/BaseDatabase/EnableWorkflowOn";
+import ModelPermission from "../../../Types/BaseDatabase/ModelPermission";
+import TableBillingAccessControl from "../../../Types/BaseDatabase/TableBillingAccessControl";
+import { PlanType } from "../../../Types/Billing/SubscriptionPlan";
+import Dictionary from "../../../Types/Dictionary";
+import BadDataException from "../../../Types/Exception/BadDataException";
+import { JSONValue } from "../../../Types/JSON";
+import ObjectID from "../../../Types/ObjectID";
+import Permission, {
+  UserTenantAccessPermission,
+} from "../../../Types/Permission";
+import Text from "../../../Types/Text";
+import { EnableRealtimeEventsOn } from "../../../Utils/Realtime";
 import CommonModel from "./CommonModel";
 
 export type AnalyticsBaseModelType = { new (): AnalyticsBaseModel };

package/{AnalyticsModels → Models/AnalyticsModels/AnalyticsBaseModel}/CommonModel.ts

@@ -1,19 +1,19 @@
 // This model will be extended by BaseModel and Nested Mdoel
-import AnalyticsTableColumn from "../Types/AnalyticsDatabase/TableColumn";
-import TableColumnType from "../Types/AnalyticsDatabase/TableColumnType";
-import GreaterThan from "../Types/BaseDatabase/GreaterThan";
-import GreaterThanOrEqual from "../Types/BaseDatabase/GreaterThanOrEqual";
-import InBetween from "../Types/BaseDatabase/InBetween";
-import Includes from "../Types/BaseDatabase/Includes";
-import LessThan from "../Types/BaseDatabase/LessThan";
-import LessThanOrEqual from "../Types/BaseDatabase/LessThanOrEqual";
-import NotEqual from "../Types/BaseDatabase/NotEqual";
-import Search from "../Types/BaseDatabase/Search";
-import OneUptimeDate from "../Types/Date";
-import BadDataException from "../Types/Exception/BadDataException";
-import { JSONArray, JSONObject, JSONValue } from "../Types/JSON";
-import JSONFunctions from "../Types/JSONFunctions";
-import ObjectID from "../Types/ObjectID";
+import AnalyticsTableColumn from "../../../Types/AnalyticsDatabase/TableColumn";
+import TableColumnType from "../../../Types/AnalyticsDatabase/TableColumnType";
+import GreaterThan from "../../../Types/BaseDatabase/GreaterThan";
+import GreaterThanOrEqual from "../../../Types/BaseDatabase/GreaterThanOrEqual";
+import InBetween from "../../../Types/BaseDatabase/InBetween";
+import Includes from "../../../Types/BaseDatabase/Includes";
+import LessThan from "../../../Types/BaseDatabase/LessThan";
+import LessThanOrEqual from "../../../Types/BaseDatabase/LessThanOrEqual";
+import NotEqual from "../../../Types/BaseDatabase/NotEqual";
+import Search from "../../../Types/BaseDatabase/Search";
+import OneUptimeDate from "../../../Types/Date";
+import BadDataException from "../../../Types/Exception/BadDataException";
+import { JSONArray, JSONObject, JSONValue } from "../../../Types/JSON";
+import JSONFunctions from "../../../Types/JSONFunctions";
+import ObjectID from "../../../Types/ObjectID";
 
 export type RecordValue =
   | ObjectID

package/{AnalyticsModels → Models/AnalyticsModels/AnalyticsBaseModel}/NestedModel.ts

@@ -1,4 +1,4 @@
-import AnalyticsTableColumn from "../Types/AnalyticsDatabase/TableColumn";
+import AnalyticsTableColumn from "../../../Types/AnalyticsDatabase/TableColumn";
 import CommonModel from "./CommonModel";
 
 export default class NestedModel extends CommonModel {

package/Models/AnalyticsModels/Index.ts

@@ -0,0 +1,16 @@
+import AnalyticsBaseModel from "./AnalyticsBaseModel/AnalyticsBaseModel";
+import Log from "./Log";
+import Metric from "./Metric";
+import MonitorMetricsByMinute from "./MonitorMetricsByMinute";
+import Span from "./Span";
+import TelemetryAttribute from "./TelemetryAttribute";
+
+const AnalyticsModels: Array<typeof AnalyticsBaseModel> = [
+  Log,
+  Span,
+  Metric,
+  MonitorMetricsByMinute,
+  TelemetryAttribute,
+];
+
+export default AnalyticsModels;

package/Models/AnalyticsModels/Log.ts

@@ -0,0 +1,365 @@
+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 { JSONObject } from "../../Types/JSON";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import LogSeverity from "../../Types/Log/LogSeverity";
+
+export default class Log extends AnalyticsBaseModel {
+  public constructor() {
+    super({
+      tableName: "LogTelemetry",
+      tableEngine: AnalyticsTableEngine.MergeTree,
+      singularName: "Log",
+      enableRealtimeEventsOn: {
+        create: true,
+      },
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.ReadTelemetryServiceLog,
+        ],
+        create: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.CreateTelemetryServiceLog,
+        ],
+        update: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.EditTelemetryServiceLog,
+        ],
+        delete: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.DeleteTelemetryServiceLog,
+        ],
+      },
+      pluralName: "Logs",
+      crudApiPath: new Route("/logs"),
+      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.ReadTelemetryServiceLog,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryServiceLog,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "serviceId",
+          title: "Service ID",
+          description: "ID of the Service which created the log",
+          required: true,
+          type: TableColumnType.ObjectID,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryServiceLog,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryServiceLog,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "time",
+          title: "Time",
+          description: "When was the log created?",
+          required: true,
+          type: TableColumnType.Date,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryServiceLog,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryServiceLog,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "timeUnixNano",
+          title: "Time (in Unix Nano)",
+          description: "When was the log created?",
+          required: true,
+          type: TableColumnType.LongNumber,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryServiceLog,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryServiceLog,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "severityText",
+          title: "Severity Text",
+          description: "Log Severity Text",
+          required: true,
+          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: "severityNumber",
+          title: "Severity Number",
+          description: "Log Severity Number",
+          required: true,
+          type: TableColumnType.Number,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryServiceLog,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryServiceLog,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "attributes",
+          title: "Attributes",
+          description: "Attributes",
+          required: true,
+          defaultValue: {},
+          type: TableColumnType.JSON,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryServiceLog,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryServiceLog,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "traceId",
+          title: "Trace ID",
+          description: "ID of the trace",
+          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: "spanId",
+          title: "Span ID",
+          description: "ID of the span",
+          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: "body",
+          title: "Log Body",
+          description: "Body of the Log",
+          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: [],
+          },
+        }),
+      ],
+      sortKeys: ["projectId", "serviceId", "time"],
+      primaryKeys: ["projectId", "serviceId"],
+    });
+  }
+
+  public get projectId(): ObjectID | undefined {
+    return this.getColumnValue("projectId") as ObjectID | undefined;
+  }
+
+  public set projectId(v: ObjectID | undefined) {
+    this.setColumnValue("projectId", v);
+  }
+
+  public get serviceId(): ObjectID | undefined {
+    return this.getColumnValue("serviceId") as ObjectID | undefined;
+  }
+
+  public set serviceId(v: ObjectID | undefined) {
+    this.setColumnValue("serviceId", v);
+  }
+
+  public set body(v: string | undefined) {
+    this.setColumnValue("body", v);
+  }
+
+  public get body(): string | undefined {
+    return this.getColumnValue("body");
+  }
+
+  public get time(): Date | undefined {
+    return this.getColumnValue("time") as Date | undefined;
+  }
+
+  public set time(v: Date | undefined) {
+    this.setColumnValue("time", v);
+  }
+
+  public get timeUnixNano(): number | undefined {
+    return this.getColumnValue("timeUnixNano") as number | undefined;
+  }
+
+  public set timeUnixNano(v: number | undefined) {
+    this.setColumnValue("timeUnixNano", v);
+  }
+
+  public get severityText(): LogSeverity | undefined {
+    return this.getColumnValue("severityText") as LogSeverity | undefined;
+  }
+
+  public set severityText(v: LogSeverity | undefined) {
+    this.setColumnValue("severityText", v);
+  }
+
+  public get severityNumber(): number | undefined {
+    return this.getColumnValue("severityNumber") as number | undefined;
+  }
+
+  public set severityNumber(v: number | undefined) {
+    this.setColumnValue("severityNumber", v);
+  }
+
+  public get attributes(): JSONObject | undefined {
+    return this.getColumnValue("attributes") as JSONObject | undefined;
+  }
+
+  public set attributes(v: JSONObject | undefined) {
+    this.setColumnValue("attributes", v);
+  }
+
+  public get traceId(): string | undefined {
+    return this.getColumnValue("traceId") as string | undefined;
+  }
+
+  public set traceId(v: string | undefined) {
+    this.setColumnValue("traceId", v);
+  }
+
+  public get spanId(): string | undefined {
+    return this.getColumnValue("spanId") as string | undefined;
+  }
+
+  public set spanId(v: string | undefined) {
+    this.setColumnValue("spanId", v);
+  }
+}