@oneuptime/common 10.5.31 → 10.5.33

package/Models/AnalyticsModels/AnalyticsBaseModel/AnalyticsBaseModel.ts

@@ -40,6 +40,16 @@ export default class AnalyticsBaseModel extends CommonModel {
      * tool generators.
      */
     crudApiPath?: Route | undefined;
+    /*
+     * When true, this model is published in the public REST API Reference
+     * (/reference). Mirrors @EnableDocumentation() on Postgres models —
+     * having a crudApiPath alone is not enough; documentation is an
+     * explicit opt-in so internal-only tables stay private.
+     */
+    enableDocumentation?: boolean | undefined;
+    // Human-readable summary shown on the model's API Reference page.
+    tableDescription?: string | undefined;
+    isMasterAdminApiDocs?: boolean | undefined;
     allowAccessIfSubscriptionIsUnpaid?: boolean | undefined;
     tableBillingAccessControl?: TableBillingAccessControl | undefined;
     accessControl?: TableAccessControl | undefined;
@@ -160,6 +170,9 @@ export default class AnalyticsBaseModel extends CommonModel {
     this.accessControl = data.accessControl;
     this.enableWorkflowOn = data.enableWorkflowOn;
     this.crudApiPath = data.crudApiPath;
+    this.enableDocumentation = data.enableDocumentation || false;
+    this.tableDescription = data.tableDescription || "";
+    this.isMasterAdminApiDocs = data.isMasterAdminApiDocs || false;
     this.enableRealtimeEventsOn = data.enableRealtimeEventsOn;
     this.partitionKey = data.partitionKey;
     this.projections = data.projections || [];
@@ -315,6 +328,30 @@ export default class AnalyticsBaseModel extends CommonModel {
     this._crudApiPath = v;
   }
 
+  private _enableDocumentation: boolean = false;
+  public get enableDocumentation(): boolean {
+    return this._enableDocumentation;
+  }
+  public set enableDocumentation(v: boolean) {
+    this._enableDocumentation = v;
+  }
+
+  private _tableDescription: string = "";
+  public get tableDescription(): string {
+    return this._tableDescription;
+  }
+  public set tableDescription(v: string) {
+    this._tableDescription = v;
+  }
+
+  private _isMasterAdminApiDocs: boolean = false;
+  public get isMasterAdminApiDocs(): boolean {
+    return this._isMasterAdminApiDocs;
+  }
+  public set isMasterAdminApiDocs(v: boolean) {
+    this._isMasterAdminApiDocs = v;
+  }
+
   private _projections: Array<Projection> = [];
   public get projections(): Array<Projection> {
     return this._projections;
@@ -440,6 +477,14 @@ export default class AnalyticsBaseModel extends CommonModel {
   }
 
   public getAPIDocumentationPath(): string {
+    /*
+     * Prefer the public CRUD API slug (e.g. "/logs" -> "logs") so the
+     * docs URL and the in-app "API Docs" link mirror the real endpoint,
+     * rather than the internal ClickHouse table name (e.g. "LogItemV2").
+     */
+    if (this.crudApiPath) {
+      return this.crudApiPath.toString().replace(/^\/+/, "");
+    }
     return Text.pascalCaseToDashes(this.tableName);
   }
 

package/Models/AnalyticsModels/AuditLog.ts

@@ -267,6 +267,9 @@ export default class AuditLog extends AnalyticsBaseModel {
         delete: PlanType.Enterprise,
       },
       crudApiPath: new Route("/audit-log"),
+      enableDocumentation: true,
+      tableDescription:
+        "Immutable audit-trail records of actions taken within your project.",
       tableColumns: [
         projectIdColumn,
         resourceTypeColumn,

package/Models/AnalyticsModels/ExceptionInstance.ts

@@ -659,6 +659,9 @@ export default class ExceptionInstance extends AnalyticsBaseModel {
         ],
       },
       crudApiPath: new Route("/exceptions"),
+      enableDocumentation: true,
+      tableDescription:
+        "Individual exception occurrences captured from your telemetry. Query application errors and their attributes over time.",
       tableColumns: [
         projectIdColumn,
         serviceIdColumn,

package/Models/AnalyticsModels/Index.ts

@@ -9,6 +9,7 @@ import ExceptionInstance from "./ExceptionInstance";
 import MonitorLog from "./MonitorLog";
 import Profile from "./Profile";
 import ProfileSample from "./ProfileSample";
+import AuditLog from "./AuditLog";
 
 const AnalyticsModels: Array<{ new (): AnalyticsBaseModel }> = [
   Log,
@@ -25,6 +26,7 @@ const AnalyticsModels: Array<{ new (): AnalyticsBaseModel }> = [
   MonitorLog,
   Profile,
   ProfileSample,
+  AuditLog,
 ];
 
 const modelTypeMap: { [key: string]: { new (): AnalyticsBaseModel } } = {};

package/Models/AnalyticsModels/Log.ts

@@ -556,6 +556,9 @@ export default class Log extends AnalyticsBaseModel {
       },
       pluralName: "Logs",
       crudApiPath: new Route("/logs"),
+      enableDocumentation: true,
+      tableDescription:
+        "OpenTelemetry log records ingested from your services. Query, filter, and aggregate structured logs across your project.",
       tableColumns: [
         projectIdColumn,
         serviceIdColumn,

package/Models/AnalyticsModels/Metric.ts

@@ -1003,6 +1003,9 @@ export default class Metric extends AnalyticsBaseModel {
       singularName: "Metric",
       pluralName: "Metrics",
       crudApiPath: new Route("/metrics"),
+      enableDocumentation: true,
+      tableDescription:
+        "OpenTelemetry metric data points. Query and aggregate time-series telemetry for dashboards, alerts, and analysis.",
       accessControl: {
         read: [
           Permission.ProjectOwner,

package/Models/AnalyticsModels/Span.ts

@@ -787,6 +787,9 @@ export default class Span extends AnalyticsBaseModel {
       singularName: "Span",
       pluralName: "Spans",
       crudApiPath: new Route("/span"),
+      enableDocumentation: true,
+      tableDescription:
+        "OpenTelemetry distributed-tracing spans. Each span is one operation within a trace; query and aggregate them to analyze latency and errors.",
       accessControl: {
         read: [
           Permission.ProjectOwner,

package/Models/DatabaseModels/Index.ts

@@ -49,6 +49,8 @@ import IncidentTemplateOwnerUser from "./IncidentTemplateOwnerUser";
 //Labels.
 import Label from "./Label";
 import LogSavedView from "./LogSavedView";
+import MetricSavedView from "./MetricSavedView";
+import TraceSavedView from "./TraceSavedView";
 import LogPipeline from "./LogPipeline";
 import LogPipelineProcessor from "./LogPipelineProcessor";
 import LogDropFilter from "./LogDropFilter";
@@ -349,6 +351,8 @@ const AllModelTypes: Array<{
   ApiKey,
   Label,
   LogSavedView,
+  MetricSavedView,
+  TraceSavedView,
   LogPipeline,
   LogPipelineProcessor,
   LogDropFilter,

package/Models/DatabaseModels/KubernetesResource.ts

@@ -553,6 +553,43 @@ export default class KubernetesResource extends BaseModel {
   })
   public latestMemoryBytes?: number = undefined;
 
+  @ColumnAccessControl({
+    create: [],
+    read: READ_PERMISSIONS,
+    update: [],
+  })
+  @TableColumn({
+    required: false,
+    type: TableColumnType.Number,
+    canReadOnRelationQuery: true,
+    title: "Latest Memory Percent",
+    description:
+      "Most recent memory usage as a percent of the resource's node allocatable memory (Pod or Node). Stored as decimal — mirrors latestCpuPercent — so the workload/namespace list views can SUM a per-pod percentage. Null until the first metric arrives or while the node's allocatable memory is still unknown.",
+  })
+  @Column({
+    nullable: true,
+    type: ColumnType.Decimal,
+    transformer: {
+      to: (value: number | null | undefined): number | null => {
+        if (value === null || value === undefined) {
+          return null;
+        }
+        return value;
+      },
+      from: (value: string | number | null | undefined): number | null => {
+        if (value === null || value === undefined) {
+          return null;
+        }
+        if (typeof value === "number") {
+          return value;
+        }
+        const parsed: number = parseFloat(value);
+        return isNaN(parsed) ? null : parsed;
+      },
+    },
+  })
+  public latestMemoryPercent?: number = undefined;
+
   @ColumnAccessControl({
     create: [],
     read: READ_PERMISSIONS,

package/Models/DatabaseModels/MetricSavedView.ts

@@ -0,0 +1,334 @@
+import Project from "./Project";
+import User from "./User";
+import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
+import Route from "../../Types/API/Route";
+import TelemetrySavedViewState from "../../Types/Telemetry/TelemetrySavedViewState";
+import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
+import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
+import TableBillingAccessControl from "../../Types/Database/AccessControl/TableBillingAccessControl";
+import ColumnLength from "../../Types/Database/ColumnLength";
+import ColumnType from "../../Types/Database/ColumnType";
+import CrudApiEndpoint from "../../Types/Database/CrudApiEndpoint";
+import EnableDocumentation from "../../Types/Database/EnableDocumentation";
+import TableColumn from "../../Types/Database/TableColumn";
+import TableColumnType from "../../Types/Database/TableColumnType";
+import TableMetadata from "../../Types/Database/TableMetadata";
+import TenantColumn from "../../Types/Database/TenantColumn";
+import IconProp from "../../Types/Icon/IconProp";
+import ObjectID from "../../Types/ObjectID";
+import Permission from "../../Types/Permission";
+import { PlanType } from "../../Types/Billing/SubscriptionPlan";
+import { Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm";
+
+@EnableDocumentation()
+@TableBillingAccessControl({
+  create: PlanType.Free,
+  read: PlanType.Free,
+  update: PlanType.Free,
+  delete: PlanType.Free,
+})
+@TenantColumn("projectId")
+@CrudApiEndpoint(new Route("/metric-saved-view"))
+@Entity({
+  name: "MetricSavedView",
+})
+@TableMetadata({
+  tableName: "MetricSavedView",
+  singularName: "Metric Saved View",
+  pluralName: "Metric Saved Views",
+  icon: IconProp.Window,
+  tableDescription:
+    "Save and reuse metrics explorer views, including the current search, filters, time range, and page size.",
+})
+@TableAccessControl({
+  create: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+  ],
+  read: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+    Permission.Viewer,
+  ],
+  delete: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+  ],
+  update: [
+    Permission.ProjectOwner,
+    Permission.ProjectAdmin,
+    Permission.ProjectMember,
+  ],
+})
+export default class MetricSavedView extends BaseModel {
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "projectId",
+    type: TableColumnType.Entity,
+    modelType: Project,
+    title: "Project",
+    description: "Relation to the project this saved metric view belongs to.",
+  })
+  @ManyToOne(
+    () => {
+      return Project;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "CASCADE",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "projectId" })
+  public project?: Project = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [],
+  })
+  @Index()
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    required: true,
+    canReadOnRelationQuery: true,
+    title: "Project ID",
+    description: "ID of the project this saved metric view belongs to.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: false,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public projectId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+  })
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Name,
+    canReadOnRelationQuery: true,
+    title: "Name",
+    description: "Friendly name for this saved metric view.",
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.Name,
+    length: ColumnLength.Name,
+  })
+  public name?: string = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "createdByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Created By User",
+    description: "Relation to the user who created this saved metric view.",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "createdByUserId" })
+  public createdByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Created By User ID",
+    description: "ID of the user who created this saved metric view.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public createdByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    manyToOneRelationColumn: "deletedByUserId",
+    type: TableColumnType.Entity,
+    modelType: User,
+    title: "Deleted By User",
+    description: "Relation to the user who deleted this saved metric view.",
+  })
+  @ManyToOne(
+    () => {
+      return User;
+    },
+    {
+      eager: false,
+      nullable: true,
+      onDelete: "SET NULL",
+      orphanedRowAction: "nullify",
+    },
+  )
+  @JoinColumn({ name: "deletedByUserId" })
+  public deletedByUser?: User = undefined;
+
+  @ColumnAccessControl({
+    create: [],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [],
+  })
+  @TableColumn({
+    type: TableColumnType.ObjectID,
+    title: "Deleted By User ID",
+    description: "ID of the user who deleted this saved metric view.",
+  })
+  @Column({
+    type: ColumnType.ObjectID,
+    nullable: true,
+    transformer: ObjectID.getDatabaseTransformer(),
+  })
+  public deletedByUserId?: ObjectID = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+  })
+  @TableColumn({
+    title: "Query",
+    required: true,
+    type: TableColumnType.JSON,
+    canReadOnRelationQuery: true,
+    description:
+      "Serialized metrics explorer view state (search, filters, time range, page size) for this saved view.",
+  })
+  @Column({
+    type: ColumnType.JSON,
+    nullable: false,
+  })
+  public query?: TelemetrySavedViewState = undefined;
+
+  @ColumnAccessControl({
+    create: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+    read: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+      Permission.Viewer,
+    ],
+    update: [
+      Permission.ProjectOwner,
+      Permission.ProjectAdmin,
+      Permission.ProjectMember,
+    ],
+  })
+  @Index()
+  @TableColumn({
+    required: true,
+    type: TableColumnType.Boolean,
+    canReadOnRelationQuery: true,
+    title: "Is Default",
+    description: "Whether this saved metric view should be applied by default.",
+    defaultValue: false,
+  })
+  @Column({
+    nullable: false,
+    type: ColumnType.Boolean,
+    default: false,
+  })
+  public isDefault?: boolean = undefined;
+}