@oneuptime/common 7.0.2994 → 7.0.3018

package/Models/AnalyticsModels/ExceptionInstance.ts

@@ -0,0 +1,488 @@
+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 ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { SpanStatus } from "./Span";
+
+export default class ExceptionInstance extends AnalyticsBaseModel {
+  public constructor() {
+    super({
+      tableName: "ExceptionInstanceTelemetry",
+      tableEngine: AnalyticsTableEngine.MergeTree,
+      singularName: "Exception",
+      pluralName: "Exceptions",
+      enableRealtimeEventsOn: {
+        create: true,
+      },
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.ReadTelemetryException,
+        ],
+        create: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.CreateTelemetryException,
+        ],
+        update: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.EditTelemetryException,
+        ],
+        delete: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.DeleteTelemetryException,
+        ],
+      },
+      crudApiPath: new Route("/exceptions"),
+      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.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            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.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            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.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            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.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "exceptionType",
+          title: "Exception Type",
+          description: "Exception Type", // Examples: java.net.ConnectException; OSError; etc.
+          required: false,
+          type: TableColumnType.Text,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "stackTrace",
+          title: "Stack Trace",
+          description: "Exception Stack Trace", // Examples: Division by zero; Can't convert 'int' object to str implicitly
+          required: false,
+          type: TableColumnType.Text,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "message",
+          title: "Exception Message",
+          description: "Exception Message", // Examples: Division by zero; Can't convert 'int' object to str implicitly
+          required: false,
+          type: TableColumnType.Text,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "spanStatusCode",
+          title: "Span Status Code",
+          description: "Span Status Code",
+          required: false,
+          type: TableColumnType.Number,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "escaped",
+          title: "Exception Escaped",
+          description: "Exception Escaped", // SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span.
+          required: false,
+          type: TableColumnType.Boolean,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            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.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            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.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "fingerprint",
+          title: "Fingerprint",
+          description: "Fingerprint of the exception",
+          required: true,
+          type: TableColumnType.Text,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "spanName",
+          title: "Span Name",
+          description: "Name of the span",
+          required: false,
+          type: TableColumnType.Text,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryServiceTraces,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryServiceTraces,
+            ],
+            update: [],
+          },
+        }),
+
+        new AnalyticsTableColumn({
+          key: "attributes",
+          title: "Attributes",
+          description: "Attributes",
+          required: true,
+          defaultValue: {},
+          type: TableColumnType.JSON,
+          accessControl: {
+            read: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.ReadTelemetryException,
+            ],
+            create: [
+              Permission.ProjectOwner,
+              Permission.ProjectAdmin,
+              Permission.ProjectMember,
+              Permission.CreateTelemetryException,
+            ],
+            update: [],
+          },
+        }),
+      ],
+      sortKeys: ["projectId", "serviceId", "fingerprint", "time"],
+      primaryKeys: ["projectId", "serviceId", "fingerprint"],
+    });
+  }
+
+  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 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 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);
+  }
+
+  public get exceptionType(): string | undefined {
+    return this.getColumnValue("exceptionType") as string | undefined;
+  }
+
+  public set exceptionType(v: string | undefined) {
+    this.setColumnValue("exceptionType", v);
+  }
+
+  public get stackTrace(): string | undefined {
+    return this.getColumnValue("stackTrace") as string | undefined;
+  }
+
+  public set stackTrace(v: string | undefined) {
+    this.setColumnValue("stackTrace", v);
+  }
+
+  public get message(): string | undefined {
+    return this.getColumnValue("message") as string | undefined;
+  }
+
+  public set message(v: string | undefined) {
+    this.setColumnValue("message", v);
+  }
+
+  public get escaped(): boolean | undefined {
+    return this.getColumnValue("escaped") as boolean | undefined;
+  }
+
+  public set escaped(v: boolean | undefined) {
+    this.setColumnValue("escaped", v);
+  }
+
+  public get fingerprint(): string | undefined {
+    return this.getColumnValue("fingerprint") as string | undefined;
+  }
+
+  public set fingerprint(v: string | undefined) {
+    this.setColumnValue("fingerprint", v);
+  }
+
+  public get attributes(): Record<string, any> {
+    return this.getColumnValue("attributes") as Record<string, any>;
+  }
+
+  public set attributes(v: Record<string, any>) {
+    this.setColumnValue("attributes", v);
+  }
+
+  public get spanStatusCode(): SpanStatus | undefined {
+    return this.getColumnValue("spanStatusCode") as SpanStatus | undefined;
+  }
+
+  public set spanStatusCode(v: SpanStatus | undefined) {
+    this.setColumnValue("spanStatusCode", v);
+  }
+
+  public get spanName(): string | undefined {
+    return this.getColumnValue("spanName") as string | undefined;
+  }
+
+  public set spanName(v: string | undefined) {
+    this.setColumnValue("spanName", v);
+  }
+}

package/Models/AnalyticsModels/Index.ts

@@ -4,6 +4,7 @@ import Metric from "./Metric";
 import MonitorMetricsByMinute from "./MonitorMetricsByMinute";
 import Span from "./Span";
 import TelemetryAttribute from "./TelemetryAttribute";
+import ExceptionInstance from "./ExceptionInstance";
 
 const AnalyticsModels: Array<typeof AnalyticsBaseModel> = [
   Log,
@@ -11,6 +12,7 @@ const AnalyticsModels: Array<typeof AnalyticsBaseModel> = [
   Metric,
   MonitorMetricsByMinute,
   TelemetryAttribute,
+  ExceptionInstance,
 ];
 
 export default AnalyticsModels;

package/Models/AnalyticsModels/Span.ts

@@ -16,8 +16,8 @@ export enum SpanKind {
 }
 
 export enum SpanEventType {
-  Exception = "Exception",
-  Event = "Event",
+  Exception = "exception",
+  Event = "event",
 }
 
 export enum SpanStatus {