@oneuptime/common 10.4.13 → 10.4.15

package/Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel.ts

@@ -52,6 +52,16 @@ export default class AnalyticsBaseModel extends CommonModel {
     materializedViews?: Array<MaterializedView> | undefined;
     enableMCP?: boolean | undefined;
     ttlExpression?: string | undefined; // e.g. "retentionDate DELETE"
+    /*
+     * Column that `findBy` falls back to when the caller doesn't
+     * specify a `sort`. Defaults to `createdAt` (matching the legacy
+     * behavior), but heavy analytics tables should override this to
+     * a column that participates in their ClickHouse sort key so the
+     * default list query streams from the index instead of doing a
+     * full sort. Examples: Log/MonitorLog/ExceptionInstance => "time",
+     * Span/Profile => "startTime", AuditLog => "createdAt".
+     */
+    defaultSortColumn?: string | undefined;
   }) {
     super({
       tableColumns: data.tableColumns,
@@ -156,6 +166,29 @@ export default class AnalyticsBaseModel extends CommonModel {
     this.materializedViews = data.materializedViews || [];
     this.enableMCP = data.enableMCP || false;
     this.ttlExpression = data.ttlExpression || "";
+
+    /*
+     * Validate the override matches the schema. We deliberately do
+     * NOT require the column to be in `sortKeys` — it must just
+     * exist on the table; the caller picks a column they know is
+     * indexed (typically the timestamp column at position 2 of the
+     * sort key, after `projectId`).
+     */
+    if (data.defaultSortColumn) {
+      const column: AnalyticsTableColumn | undefined = columns.find(
+        (column: AnalyticsTableColumn) => {
+          return column.key === data.defaultSortColumn;
+        },
+      );
+      if (!column) {
+        throw new BadDataException(
+          "defaultSortColumn " +
+            data.defaultSortColumn +
+            " is not part of tableColumns",
+        );
+      }
+      this.defaultSortColumn = data.defaultSortColumn;
+    }
   }
 
   private _enableWorkflowOn: EnableWorkflowOn | undefined;
@@ -214,6 +247,22 @@ export default class AnalyticsBaseModel extends CommonModel {
     this._sortKeys = v;
   }
 
+  /*
+   * Column that `AnalyticsDatabaseService._findBy` falls back to
+   * when the caller didn't pass a `sort`. `createdAt` (the historical
+   * default) is not part of the ClickHouse sort key on heavy
+   * analytics tables (Log/Span/Metric/...), so a default list query
+   * over those tables triggers a full sort. Per-model overrides
+   * point at a column that participates in the sort key.
+   */
+  private _defaultSortColumn: string = "createdAt";
+  public get defaultSortColumn(): string {
+    return this._defaultSortColumn;
+  }
+  public set defaultSortColumn(v: string) {
+    this._defaultSortColumn = v;
+  }
+
   private _singularName: string = "";
   public get singularName(): string {
     return this._singularName;

package/Models/AnalyticsModels/AuditLog.ts

@@ -287,6 +287,14 @@ export default class AuditLog extends AnalyticsBaseModel {
       primaryKeys: ["projectId", "createdAt"],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      /*
+       * `createdAt` already participates in the AuditLog sort key
+       * (position 2 after `projectId`), so the legacy `createdAt
+       * DESC` default was already efficient here. Set it explicitly
+       * so the choice is intentional rather than inherited from the
+       * base class.
+       */
+      defaultSortColumn: "createdAt",
     });
   }
 

package/Models/AnalyticsModels/ExceptionInstance.ts

@@ -667,6 +667,7 @@ export default class ExceptionInstance extends AnalyticsBaseModel {
       primaryKeys: ["projectId", "time", "serviceId", "fingerprint"],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      defaultSortColumn: "time",
     });
   }
 

package/Models/AnalyticsModels/Log.ts

@@ -569,6 +569,7 @@ export default class Log extends AnalyticsBaseModel {
       primaryKeys: ["projectId", "time", "serviceId"],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      defaultSortColumn: "time",
     });
   }
 

package/Models/AnalyticsModels/Metric.ts

@@ -1046,6 +1046,16 @@ export default class Metric extends AnalyticsBaseModel {
       primaryKeys: ["projectId", "name", "serviceId", "time"],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      /*
+       * `time` is the 4th column of the Metric sort key (after
+       * projectId + name + serviceId). A list query that filters
+       * by name (the typical "metric detail" drilldown) can still
+       * stream from the index when sorting by `time DESC`. With
+       * no name filter the sort is less efficient but still far
+       * better than the legacy `createdAt DESC` fallback, which
+       * isn't in the sort key at all.
+       */
+      defaultSortColumn: "time",
     });
   }
 

package/Models/AnalyticsModels/MonitorLog.ts

@@ -188,6 +188,7 @@ export default class MonitorLog extends AnalyticsBaseModel {
       primaryKeys: ["projectId", "time", "monitorId"],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      defaultSortColumn: "time",
     });
   }
 

package/Models/AnalyticsModels/Profile.ts

@@ -673,6 +673,7 @@ export default class Profile extends AnalyticsBaseModel {
       primaryKeys: ["projectId", "startTime", "serviceId", "profileType"],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      defaultSortColumn: "startTime",
     });
   }
 

package/Models/AnalyticsModels/ProfileSample.ts

@@ -542,6 +542,7 @@ export default class ProfileSample extends AnalyticsBaseModel {
       ],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      defaultSortColumn: "time",
     });
   }
 

package/Models/AnalyticsModels/Span.ts

@@ -846,6 +846,7 @@ export default class Span extends AnalyticsBaseModel {
       primaryKeys: ["projectId", "startTime", "serviceId", "traceId"],
       partitionKey: "sipHash64(projectId) % 16",
       ttlExpression: "retentionDate DELETE",
+      defaultSortColumn: "startTime",
     });
   }
 

package/Models/DatabaseModels/Alert.ts

@@ -114,6 +114,7 @@ import NotificationRuleWorkspaceChannel from "../../Types/Workspace/Notification
     delete: true,
   },
 })
+@Index(["projectId", "currentAlertStateId"]) // Active-alert counters on dashboard
 export default class Alert extends BaseModel {
   @ColumnAccessControl({
     create: [
@@ -484,6 +485,7 @@ export default class Alert extends BaseModel {
       Permission.EditAlert,
     ],
   })
+  @Index()
   @TableColumn({
     type: TableColumnType.ObjectID,
     title: "Monitor ID",

package/Models/DatabaseModels/AlertCustomField.ts

@@ -249,6 +249,43 @@ export default class AlertCustomField extends BaseModel {
   })
   public customFieldType?: CustomFieldType = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateAlertCustomField,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.AlertAdmin,
+      Permission.AlertMember,
+      Permission.AlertViewer,
+      Permission.ReadAlertCustomField,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditAlertCustomField,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "Dropdown Options",
+    description:
+      "Options for the dropdown field, one per line. Only used when Custom Field Type is Dropdown.",
+    example: "Option 1\nOption 2\nOption 3",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+    length: ColumnLength.LongText,
+  })
+  public dropdownOptions?: string = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/AlertFeed.ts

@@ -91,6 +91,7 @@ export enum AlertFeedEventType {
   tableDescription:
     "Log of the entire alert state change. This is a log of all the alert state changes, public notes, more etc.",
 })
+@Index(["alertId", "postedAt"]) // Alert detail page: feed sorted by postedAt
 export default class AlertFeed extends BaseModel {
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/CallLog.ts

@@ -61,6 +61,8 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
   tableDescription:
     "Logs of all the Call sent out to all users and subscribers for this project.",
 })
+@Index(["projectId", "createdAt"]) // Notification logs table: time-range filter per project
+@Index(["projectId", "status"]) // Notification logs table: status filter per project
 export default class CallLog extends BaseModel {
   @ColumnAccessControl({
     create: [],

package/Models/DatabaseModels/DockerHost.ts

@@ -358,6 +358,40 @@ export default class DockerHost extends BaseModel {
   })
   public otelCollectorStatus?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadDockerHost,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditDockerHost,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ShortText,
+    canReadOnRelationQuery: true,
+    title: "Agent Version",
+    description:
+      "Version of the OneUptime Docker agent reporting telemetry, as self-reported via the oneuptime.agent.version resource attribute",
+    example: "1.0.0",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public agentVersion?: string = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Models/DatabaseModels/EmailLog.ts

@@ -62,6 +62,8 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
   tableDescription:
     "Logs of all the Email sent out to all users and subscribers for this project.",
 })
+@Index(["projectId", "createdAt"]) // Notification logs table: time-range filter per project
+@Index(["projectId", "status"]) // Notification logs table: status filter per project
 export default class EmailLog extends BaseModel {
   @ColumnAccessControl({
     create: [],

package/Models/DatabaseModels/Host.ts

@@ -360,6 +360,40 @@ export default class Host extends BaseModel {
   })
   public otelCollectorStatus?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadHost,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditHost,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ShortText,
+    canReadOnRelationQuery: true,
+    title: "Agent Version",
+    description:
+      "Version of the OneUptime agent reporting telemetry on this host, as self-reported via the oneuptime.agent.version resource attribute",
+    example: "1.0.0",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public agentVersion?: string = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Models/DatabaseModels/Incident.ts

@@ -118,6 +118,7 @@ import NotificationRuleWorkspaceChannel from "../../Types/Workspace/Notification
     delete: true,
   },
 })
+@Index(["projectId", "currentIncidentStateId"]) // Active-incident counters on dashboard
 export default class Incident extends BaseModel {
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/IncidentCustomField.ts

@@ -249,6 +249,43 @@ export default class IncidentCustomField extends BaseModel {
   })
   public customFieldType?: CustomFieldType = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateIncidentCustomField,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.IncidentAdmin,
+      Permission.IncidentMember,
+      Permission.IncidentViewer,
+      Permission.ReadIncidentCustomField,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditIncidentCustomField,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "Dropdown Options",
+    description:
+      "Options for the dropdown field, one per line. Only used when Custom Field Type is Dropdown.",
+    example: "Option 1\nOption 2\nOption 3",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+    length: ColumnLength.LongText,
+  })
+  public dropdownOptions?: string = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/IncidentFeed.ts

@@ -91,6 +91,7 @@ export enum IncidentFeedEventType {
   tableDescription:
     "Log of the entire incident state change. This is a log of all the incident state changes, public notes, more etc.",
 })
+@Index(["incidentId", "postedAt"]) // Incident detail page: feed sorted by postedAt
 export default class IncidentFeed extends BaseModel {
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/IncidentMember.ts

@@ -605,6 +605,15 @@ export default class IncidentMember extends BaseModel {
     read: [],
     update: [],
   })
+  /*
+   * Indexed because `IncidentMembers/SendMemberAddedNotification`
+   * cron polls `WHERE isMemberNotified = false` every minute. Without
+   * the index the cron does a full table scan that grows with every
+   * incident-member assignment ever made. Matches the indexing
+   * pattern used by the sibling `isOwnerNotified` flag on state
+   * timeline tables.
+   */
+  @Index()
   @TableColumn({
     isDefaultValueColumn: true,
     type: TableColumnType.Boolean,

package/Models/DatabaseModels/KubernetesCluster.ts

@@ -410,6 +410,40 @@ export default class KubernetesCluster extends BaseModel {
   })
   public otelCollectorStatus?: string = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.SettingsAdmin,
+      Permission.SettingsMember,
+      Permission.SettingsViewer,
+      Permission.ReadKubernetesCluster,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditKubernetesCluster,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.ShortText,
+    canReadOnRelationQuery: true,
+    title: "Agent Version",
+    description:
+      "Version of the OneUptime Kubernetes agent reporting telemetry, as self-reported via the oneuptime.agent.version resource attribute",
+    example: "1.0.0",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.ShortText,
+    length: ColumnLength.ShortText,
+  })
+  public agentVersion?: string = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: [

package/Models/DatabaseModels/MonitorCustomField.ts

@@ -249,6 +249,43 @@ export default class MonitorCustomField extends BaseModel {
   })
   public customFieldType?: CustomFieldType = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateMonitorCustomField,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.MonitorAdmin,
+      Permission.MonitorMember,
+      Permission.MonitorViewer,
+      Permission.ReadMonitorCustomField,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditMonitorCustomField,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "Dropdown Options",
+    description:
+      "Options for the dropdown field, one per line. Only used when Custom Field Type is Dropdown.",
+    example: "Option 1\nOption 2\nOption 3",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+    length: ColumnLength.LongText,
+  })
+  public dropdownOptions?: string = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/MonitorFeed.ts

@@ -80,6 +80,7 @@ export enum MonitorFeedEventType {
   tableDescription:
     "Log of the entire monitor state change. This is a log of all the monitor state changes, public notes, more etc.",
 })
+@Index(["monitorId", "postedAt"]) // Monitor detail page: feed sorted by postedAt
 export default class MonitorFeed extends BaseModel {
   @ColumnAccessControl({
     create: [

package/Models/DatabaseModels/MonitorProbe.ts

@@ -27,6 +27,7 @@ export type MonitorStepProbeResponse = Dictionary<ProbeMonitorResponse>;
 @TenantColumn("projectId")
 @Index(["monitorId", "probeId"]) // Composite index for efficient monitor-probe relationship queries
 @Index(["monitorId", "projectId"]) // Alternative index for monitor queries within project
+@Index(["probeId", "isEnabled", "nextPingAt"]) // Scheduler hot path: pick due probes per probeId
 @TableAccessControl({
   create: [
     Permission.ProjectOwner,

package/Models/DatabaseModels/OnCallDutyPolicyCustomField.ts

@@ -244,6 +244,43 @@ export default class OnCallDutyPolicyCustomField extends BaseModel {
   })
   public customFieldType?: CustomFieldType = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateOnCallDutyPolicyCustomField,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.OnCallAdmin,
+      Permission.OnCallMember,
+      Permission.OnCallViewer,
+      Permission.ReadOnCallDutyPolicyCustomField,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditOnCallDutyPolicyCustomField,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "Dropdown Options",
+    description:
+      "Options for the dropdown field, one per line. Only used when Custom Field Type is Dropdown.",
+    example: "Option 1\nOption 2\nOption 3",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+    length: ColumnLength.LongText,
+  })
+  public dropdownOptions?: string = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/OnCallDutyPolicyTimeLog.ts

@@ -483,6 +483,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
     ],
     update: [],
   })
+  @Index()
   @TableColumn({
     type: TableColumnType.ObjectID,
     required: true,
@@ -497,6 +498,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
   })
   public userId?: ObjectID = undefined;
 
+  @Index()
   @TableColumn({
     title: "Start At",
     type: TableColumnType.Date,
@@ -530,6 +532,7 @@ export default class OnCallDutyPolicyTimeLog extends BaseModel {
   })
   public startsAt?: Date = undefined;
 
+  @Index()
   @TableColumn({
     title: "Ends At",
     type: TableColumnType.Date,

package/Models/DatabaseModels/ScheduledMaintenanceCustomField.ts

@@ -249,6 +249,43 @@ export default class ScheduledMaintenanceCustomField extends BaseModel {
   })
   public customFieldType?: CustomFieldType = undefined;
 
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.CreateScheduledMaintenanceCustomField,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+      Permission.ScheduledMaintenanceAdmin,
+      Permission.ScheduledMaintenanceMember,
+      Permission.ScheduledMaintenanceViewer,
+      Permission.ReadScheduledMaintenanceCustomField,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.EditScheduledMaintenanceCustomField,
+    ],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.LongText,
+    title: "Dropdown Options",
+    description:
+      "Options for the dropdown field, one per line. Only used when Custom Field Type is Dropdown.",
+    example: "Option 1\nOption 2\nOption 3",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.LongText,
+    length: ColumnLength.LongText,
+  })
+  public dropdownOptions?: string = undefined;
+
   @ColumnAccessControl({
     create: [
       Permission.ProjectOwner,

package/Models/DatabaseModels/SmsLog.ts

@@ -61,6 +61,8 @@ import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
   tableDescription:
     "Logs of all the SMS sent out to all users and subscribers for this project.",
 })
+@Index(["projectId", "createdAt"]) // Notification logs table: time-range filter per project
+@Index(["projectId", "status"]) // Notification logs table: status filter per project
 export default class SmsLog extends BaseModel {
   @ColumnAccessControl({
     create: [],