@oneuptime/common 11.7.3 → 12.0.0

package/Models/AnalyticsModels/ExceptionInstance.ts

@@ -410,6 +410,64 @@ export default class ExceptionInstance extends AnalyticsBaseModel {
       },
     });
 
+    /*
+     * Session replay correlation key, and the reason the whole feature
+     * exists: "watch exactly what the user saw when this error fired".
+     * Holds the RumSession `sessionId` this exception fired in, or ''
+     * when there was no browser session in context.
+     *
+     * Non-Nullable String with a '' type default, exactly like the scalar
+     * entity-key columns below: rows written before this column existed
+     * read '' and there is deliberately no backfill. Nullable is not an
+     * option because StatementGenerator has to assumeNotNull-wrap Nullable
+     * columns for skip indexes, and a column added by reconciliation can
+     * never join the sort key anyway, so the bloom filter is the only
+     * pruning this predicate will ever get.
+     *
+     * This is NOT part of the fingerprint. The fingerprint is the
+     * (projectId, primaryEntityId, fingerprint) unique-index conflict
+     * target on TelemetryException, so mixing a per-session value into it
+     * would re-fingerprint every existing exception group and orphan its
+     * resolved / archived / occuranceCount triage state.
+     */
+    const sessionIdColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "sessionId",
+      codec: { codec: "ZSTD", level: 1 },
+      title: "Session ID",
+      description:
+        "Session replay session ID this exception fired in; '' when there was no browser session in context.",
+      required: true,
+      defaultValue: "",
+      type: TableColumnType.Text,
+      skipIndex: {
+        name: "idx_session_id",
+        type: SkipIndexType.BloomFilter,
+        params: [0.01],
+        granularity: 1,
+      },
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.Viewer,
+          Permission.TelemetryAdmin,
+          Permission.TelemetryMember,
+          Permission.TelemetryViewer,
+          Permission.ReadTelemetryException,
+        ],
+        create: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.TelemetryAdmin,
+          Permission.TelemetryMember,
+          Permission.CreateTelemetryException,
+        ],
+        update: [],
+      },
+    });
+
     const fingerprintColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
       key: "fingerprint",
       title: "Fingerprint",
@@ -801,6 +859,7 @@ export default class ExceptionInstance extends AnalyticsBaseModel {
         escapedColumn,
         traceIdColumn,
         spanIdColumn,
+        sessionIdColumn,
         fingerprintColumn,
         spanNameColumn,
         releaseColumn,
@@ -890,6 +949,14 @@ export default class ExceptionInstance extends AnalyticsBaseModel {
     this.setColumnValue("spanId", v);
   }
 
+  public get sessionId(): string | undefined {
+    return this.getColumnValue("sessionId") as string | undefined;
+  }
+
+  public set sessionId(v: string | undefined) {
+    this.setColumnValue("sessionId", v);
+  }
+
   public get exceptionType(): string | undefined {
     return this.getColumnValue("exceptionType") as string | undefined;
   }

package/Models/AnalyticsModels/Index.ts

@@ -15,6 +15,8 @@ import NetworkFlow from "./NetworkFlow";
 import KubernetesCostAllocation from "./KubernetesCostAllocation";
 import Profile from "./Profile";
 import ProfileSample from "./ProfileSample";
+import RumSession from "./RumSession";
+import RumSessionChunk from "./RumSessionChunk";
 import AuditLog from "./AuditLog";
 
 const AnalyticsModels: Array<{ new (): AnalyticsBaseModel }> = [
@@ -48,6 +50,14 @@ const AnalyticsModels: Array<{ new (): AnalyticsBaseModel }> = [
   KubernetesCostAllocation,
   Profile,
   ProfileSample,
+  /*
+   * Session replay. Registered here for Realtime lookup and table-name
+   * resolution; boot-time table creation is driven by the separate
+   * AnalyticsServices array in Common/Server/Services/Index.ts, so both
+   * registrations are required.
+   */
+  RumSession,
+  RumSessionChunk,
   AuditLog,
 ];
 

package/Models/AnalyticsModels/Log.ts

@@ -482,6 +482,57 @@ export default class Log extends AnalyticsBaseModel {
       },
     });
 
+    /*
+     * Session replay correlation key. Holds the RumSession `sessionId`
+     * that produced this log, or '' when the log came from a backend with
+     * no browser session in context.
+     *
+     * Non-Nullable String with a '' type default, exactly like the scalar
+     * entity-key columns above: rows written before this column existed
+     * read '' and there is deliberately no backfill. Nullable is not an
+     * option because StatementGenerator has to assumeNotNull-wrap Nullable
+     * columns for skip indexes, and a column added by reconciliation can
+     * never join the sort key anyway, so the bloom filter is the only
+     * pruning this predicate will ever get.
+     */
+    const sessionIdColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
+      key: "sessionId",
+      codec: { codec: "ZSTD", level: 1 },
+      title: "Session ID",
+      description:
+        "Session replay session ID that produced this log; '' when the log has no browser session in context.",
+      required: true,
+      defaultValue: "",
+      type: TableColumnType.Text,
+      skipIndex: {
+        name: "idx_session_id",
+        type: SkipIndexType.BloomFilter,
+        params: [0.01],
+        granularity: 1,
+      },
+      accessControl: {
+        read: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.Viewer,
+          Permission.TelemetryAdmin,
+          Permission.TelemetryMember,
+          Permission.TelemetryViewer,
+          Permission.ReadTelemetryServiceLog,
+        ],
+        create: [
+          Permission.ProjectOwner,
+          Permission.ProjectAdmin,
+          Permission.ProjectMember,
+          Permission.TelemetryAdmin,
+          Permission.TelemetryMember,
+          Permission.CreateTelemetryServiceLog,
+        ],
+        update: [],
+      },
+    });
+
     const bodyColumn: AnalyticsTableColumn = new AnalyticsTableColumn({
       key: "body",
       title: "Log Body",
@@ -683,6 +734,7 @@ export default class Log extends AnalyticsBaseModel {
         ...scalarEntityKeyColumns,
         traceIdColumn,
         spanIdColumn,
+        sessionIdColumn,
         bodyColumn,
         observedTimeUnixNanoColumn,
         droppedAttributesCountColumn,
@@ -820,6 +872,14 @@ export default class Log extends AnalyticsBaseModel {
     this.setColumnValue("spanId", v);
   }
 
+  public get sessionId(): string | undefined {
+    return this.getColumnValue("sessionId") as string | undefined;
+  }
+
+  public set sessionId(v: string | undefined) {
+    this.setColumnValue("sessionId", v);
+  }
+
   public get observedTimeUnixNano(): number | undefined {
     return this.getColumnValue("observedTimeUnixNano") as number | undefined;
   }