mirror of
https://github.com/OneUptime/oneuptime.git
synced 2026-04-06 00:32:12 +02:00
3545a221bc
- Implemented a new page for creating alerts with a form that includes fields for title, description, severity, state, monitor, on-call policy, labels, root cause, and remediation notes. - Updated the AlertsTable component to conditionally render a "Create Alert" button based on the disableCreate prop. - Modified the AlertsLayout to optionally hide the side menu when navigating to the create alert page. - Enhanced routing to include a new route for the alert creation page and adjusted the side menu visibility accordingly. - Updated PageMap and RouteMap to include the new alert creation route. - Added migration to update database schema related to incident and alert policies.
1209 lines
30 KiB
TypeScript
1209 lines
30 KiB
TypeScript
import AlertEpisode from "./AlertEpisode";
|
|
import AlertSeverity from "./AlertSeverity";
|
|
import AlertState from "./AlertState";
|
|
import Label from "./Label";
|
|
import Monitor from "./Monitor";
|
|
import MonitorStatus from "./MonitorStatus";
|
|
import OnCallDutyPolicy from "./OnCallDutyPolicy";
|
|
import Probe from "./Probe";
|
|
import Project from "./Project";
|
|
import User from "./User";
|
|
import BaseModel from "./DatabaseBaseModel/DatabaseBaseModel";
|
|
import Route from "../../Types/API/Route";
|
|
import ColumnAccessControl from "../../Types/Database/AccessControl/ColumnAccessControl";
|
|
import TableAccessControl from "../../Types/Database/AccessControl/TableAccessControl";
|
|
import AccessControlColumn from "../../Types/Database/AccessControlColumn";
|
|
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 EnableMCP from "../../Types/Database/EnableMCP";
|
|
import EnableWorkflow from "../../Types/Database/EnableWorkflow";
|
|
import MultiTenentQueryAllowed from "../../Types/Database/MultiTenentQueryAllowed";
|
|
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 { JSONObject } from "../../Types/JSON";
|
|
import ObjectID from "../../Types/ObjectID";
|
|
import Permission from "../../Types/Permission";
|
|
import {
|
|
Column,
|
|
Entity,
|
|
Index,
|
|
JoinColumn,
|
|
JoinTable,
|
|
ManyToMany,
|
|
ManyToOne,
|
|
} from "typeorm";
|
|
import { TelemetryQuery } from "../../Types/Telemetry/TelemetryQuery";
|
|
import NotificationRuleWorkspaceChannel from "../../Types/Workspace/NotificationRules/NotificationRuleWorkspaceChannel";
|
|
|
|
@EnableDocumentation()
|
|
@EnableMCP()
|
|
@AccessControlColumn("labels")
|
|
@MultiTenentQueryAllowed(true)
|
|
@TenantColumn("projectId")
|
|
@TableAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
delete: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.DeleteAlert,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@CrudApiEndpoint(new Route("/alert"))
|
|
@Entity({
|
|
name: "Alert",
|
|
})
|
|
@EnableWorkflow({
|
|
create: true,
|
|
delete: true,
|
|
update: true,
|
|
read: true,
|
|
})
|
|
@TableMetadata({
|
|
tableName: "Alert",
|
|
singularName: "Alert",
|
|
pluralName: "Alerts",
|
|
icon: IconProp.Alert,
|
|
tableDescription: "Manage alerts for your project",
|
|
enableRealtimeEventsOn: {
|
|
create: true,
|
|
update: true,
|
|
delete: true,
|
|
},
|
|
})
|
|
export default class Alert extends BaseModel {
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "projectId",
|
|
type: TableColumnType.Entity,
|
|
modelType: Project,
|
|
title: "Project",
|
|
description: "Relation to Project Resource in which this object belongs",
|
|
})
|
|
@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,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: true,
|
|
canReadOnRelationQuery: true,
|
|
title: "Project ID",
|
|
description: "ID of your OneUptime Project in which this object belongs",
|
|
example: "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: false,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public projectId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
required: true,
|
|
type: TableColumnType.LongText,
|
|
canReadOnRelationQuery: true,
|
|
title: "Title",
|
|
description: "Title of this alert",
|
|
example: "High CPU usage detected on production server",
|
|
})
|
|
@Column({
|
|
nullable: false,
|
|
type: ColumnType.LongText,
|
|
length: ColumnLength.LongText,
|
|
})
|
|
public title?: string = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
required: false,
|
|
type: TableColumnType.Markdown,
|
|
title: "Description",
|
|
description:
|
|
"Short description of this alert. This will be visible on the status page. This is in markdown.",
|
|
example:
|
|
"CPU usage has exceeded 90% threshold for the past 5 minutes. Immediate investigation required.",
|
|
})
|
|
@Column({
|
|
nullable: true,
|
|
type: ColumnType.Markdown,
|
|
})
|
|
public description?: string = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "createdByUserId",
|
|
type: TableColumnType.Entity,
|
|
modelType: User,
|
|
title: "Created by User",
|
|
description:
|
|
"Relation to User who created this object (if this object was created by a User)",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return User;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: "SET NULL",
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "createdByUserId" })
|
|
public createdByUser?: User = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
title: "Created by User ID",
|
|
description:
|
|
"User ID who created this object (if this object was created by a User)",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: true,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public createdByUserId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "deletedByUserId",
|
|
type: TableColumnType.Entity,
|
|
title: "Deleted by User",
|
|
modelType: User,
|
|
description:
|
|
"Relation to User who deleted this object (if this object was deleted by a User)",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return User;
|
|
},
|
|
{
|
|
cascade: false,
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: "SET NULL",
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "deletedByUserId" })
|
|
public deletedByUser?: User = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
title: "Deleted by User ID",
|
|
description:
|
|
"User ID who deleted this object (if this object was deleted by a User)",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: true,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public deletedByUserId?: ObjectID = undefined;
|
|
|
|
// monitor this alert was created for.
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "monitorId",
|
|
type: TableColumnType.Entity,
|
|
modelType: Monitor,
|
|
title: "Monitor",
|
|
description: "Relation to monitor this alert belongs to",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return Monitor;
|
|
},
|
|
{
|
|
cascade: false,
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: "SET NULL",
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "monitorId" })
|
|
public monitor?: Monitor = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
title: "Monitor ID",
|
|
description: "ID of the monitor this alert belongs to",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: true,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public monitorId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
required: false,
|
|
type: TableColumnType.EntityArray,
|
|
modelType: OnCallDutyPolicy,
|
|
title: "On-Call Duty Policies",
|
|
description: "List of on-call duty policies affected by this alert.",
|
|
})
|
|
@ManyToMany(
|
|
() => {
|
|
return OnCallDutyPolicy;
|
|
},
|
|
{ eager: false },
|
|
)
|
|
@JoinTable({
|
|
name: "AlertOnCallDutyPolicy",
|
|
inverseJoinColumn: {
|
|
name: "onCallDutyPolicyId",
|
|
referencedColumnName: "_id",
|
|
},
|
|
joinColumn: {
|
|
name: "alertId",
|
|
referencedColumnName: "_id",
|
|
},
|
|
})
|
|
public onCallDutyPolicies?: Array<OnCallDutyPolicy> = undefined; // on-call duty policies affected by this alert.
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
required: false,
|
|
type: TableColumnType.EntityArray,
|
|
modelType: Label,
|
|
title: "Labels",
|
|
description:
|
|
"Relation to Labels Array where this object is categorized in.",
|
|
})
|
|
@ManyToMany(
|
|
() => {
|
|
return Label;
|
|
},
|
|
{ eager: false },
|
|
)
|
|
@JoinTable({
|
|
name: "AlertLabel",
|
|
inverseJoinColumn: {
|
|
name: "labelId",
|
|
referencedColumnName: "_id",
|
|
},
|
|
joinColumn: {
|
|
name: "alertId",
|
|
referencedColumnName: "_id",
|
|
},
|
|
})
|
|
public labels?: Array<Label> = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "currentAlertStateId",
|
|
type: TableColumnType.Entity,
|
|
modelType: AlertState,
|
|
title: "Current Alert State",
|
|
description:
|
|
"Current state of this alert. Is the alert acknowledged? or resolved?. This is related to Alert State",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return AlertState;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "currentAlertStateId" })
|
|
public currentAlertState?: AlertState = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: true,
|
|
isDefaultValueColumn: true,
|
|
canReadOnRelationQuery: true,
|
|
title: "Current Alert State ID",
|
|
description: "Current Alert State ID",
|
|
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: false,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public currentAlertStateId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "alertSeverityId",
|
|
type: TableColumnType.Entity,
|
|
modelType: AlertSeverity,
|
|
title: "Alert Severity",
|
|
description:
|
|
"How severe is this alert. Is it critical? or a minor alert?. This is related to Alert Severity.",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return AlertSeverity;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "alertSeverityId" })
|
|
public alertSeverity?: AlertSeverity = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: true,
|
|
title: "Alert Severity ID",
|
|
description: "Alert Severity ID",
|
|
example: "b2c3d4e5-f6a7-8901-bcde-f23456789012",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: false,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public alertSeverityId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "monitorStatusWhenThisAlertWasCreatedId",
|
|
type: TableColumnType.Entity,
|
|
modelType: MonitorStatus,
|
|
title: "Monitor status when this alert was created",
|
|
description: "Monitor status when this alert was created",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return MonitorStatus;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "monitorStatusWhenThisAlertWasCreatedId" })
|
|
public monitorStatusWhenThisAlertWasCreated?: MonitorStatus = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: false,
|
|
title: "Monitor Status ID when this alert was created",
|
|
description: "Monitor Status ID when this alert was created",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: true,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public monitorStatusWhenThisAlertWasCreatedId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
isDefaultValueColumn: false,
|
|
required: false,
|
|
type: TableColumnType.JSON,
|
|
title: "Custom Fields",
|
|
description: "Custom Fields on this resource.",
|
|
})
|
|
@Column({
|
|
type: ColumnType.JSON,
|
|
nullable: true,
|
|
})
|
|
public customFields?: JSONObject = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.Boolean,
|
|
computed: true,
|
|
hideColumnInDocumentation: true,
|
|
required: true,
|
|
isDefaultValueColumn: true,
|
|
title: "Are Owners Notified Of Alert Creation?",
|
|
description: "Are owners notified of when this alert is created?",
|
|
defaultValue: false,
|
|
})
|
|
@Column({
|
|
type: ColumnType.Boolean,
|
|
nullable: false,
|
|
default: false,
|
|
})
|
|
public isOwnerNotifiedOfAlertCreation?: boolean = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
type: TableColumnType.Markdown,
|
|
required: false,
|
|
isDefaultValueColumn: false,
|
|
title: "Root Cause",
|
|
description: "What is the root cause of this alert?",
|
|
example:
|
|
"Memory leak in the application caused by improper resource cleanup in the connection pool.",
|
|
})
|
|
@Column({
|
|
type: ColumnType.Markdown,
|
|
nullable: true,
|
|
})
|
|
public rootCause?: string = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
isDefaultValueColumn: false,
|
|
required: false,
|
|
type: TableColumnType.JSON,
|
|
computed: true,
|
|
})
|
|
@Column({
|
|
type: ColumnType.JSON,
|
|
nullable: true,
|
|
unique: false,
|
|
})
|
|
public createdStateLog?: JSONObject = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.LongText,
|
|
required: false,
|
|
isDefaultValueColumn: false,
|
|
title: "Created Criteria ID",
|
|
description:
|
|
"If this alert was created by a Probe, this is the ID of the criteria that created it.",
|
|
})
|
|
@Column({
|
|
type: ColumnType.LongText,
|
|
nullable: true,
|
|
})
|
|
public createdCriteriaId?: string = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "createdByProbeId",
|
|
type: TableColumnType.Entity,
|
|
modelType: Probe,
|
|
title: "Created By Probe",
|
|
description:
|
|
"If this alert was created by a Probe, this is the probe that created it.",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return Probe;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: "SET NULL",
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "createdByProbeId" })
|
|
public createdByProbe?: Probe = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: false,
|
|
canReadOnRelationQuery: true,
|
|
title: "Created By Probe ID",
|
|
description:
|
|
"If this alert was created by a Probe, this is the ID of the probe that created it.",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: true,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public createdByProbeId?: ObjectID = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
isDefaultValueColumn: true,
|
|
type: TableColumnType.Boolean,
|
|
title: "Is created automatically?",
|
|
description:
|
|
"Is this alert created by OneUptime Probe or Workers automatically (and not created manually by a user)?",
|
|
defaultValue: false,
|
|
})
|
|
@Column({
|
|
type: ColumnType.Boolean,
|
|
default: false,
|
|
})
|
|
public isCreatedAutomatically?: boolean = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
required: false,
|
|
type: TableColumnType.Markdown,
|
|
title: "Remediation Notes",
|
|
description: "Notes on how to remediate this alert. This is in markdown.",
|
|
example:
|
|
"1. Restart the affected service\\n2. Clear the connection pool\\n3. Monitor memory usage for the next 30 minutes",
|
|
})
|
|
@Column({
|
|
nullable: true,
|
|
type: ColumnType.Markdown,
|
|
})
|
|
public remediationNotes?: string = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
isDefaultValueColumn: false,
|
|
required: false,
|
|
type: TableColumnType.JSON,
|
|
title: "Telemetry Query",
|
|
description: "Telemetry query for this alert",
|
|
})
|
|
@Column({
|
|
type: ColumnType.JSON,
|
|
nullable: true,
|
|
})
|
|
public telemetryQuery?: TelemetryQuery = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
isDefaultValueColumn: false,
|
|
required: false,
|
|
type: TableColumnType.Number,
|
|
computed: true,
|
|
canReadOnRelationQuery: true,
|
|
title: "Alert Number",
|
|
description: "Alert Number",
|
|
example: 42,
|
|
})
|
|
@Column({
|
|
type: ColumnType.Number,
|
|
nullable: true,
|
|
})
|
|
public alertNumber?: number = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
isDefaultValueColumn: false,
|
|
required: false,
|
|
type: TableColumnType.ShortText,
|
|
title: "Alert Number With Prefix",
|
|
description: "Alert number with prefix (e.g., 'ALT-42' or '#42')",
|
|
computed: true,
|
|
canReadOnRelationQuery: true,
|
|
})
|
|
@Column({
|
|
type: ColumnType.ShortText,
|
|
length: ColumnLength.ShortText,
|
|
nullable: true,
|
|
})
|
|
public alertNumberWithPrefix?: string = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [],
|
|
read: [],
|
|
update: [],
|
|
})
|
|
@TableColumn({
|
|
isDefaultValueColumn: false,
|
|
required: false,
|
|
type: TableColumnType.JSON,
|
|
title: "Post Updates To Workspace Channel Name",
|
|
description: "Post Updates To Workspace Channel Name",
|
|
})
|
|
@Column({
|
|
type: ColumnType.JSON,
|
|
nullable: true,
|
|
})
|
|
public postUpdatesToWorkspaceChannels?: Array<NotificationRuleWorkspaceChannel> =
|
|
undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@TableColumn({
|
|
manyToOneRelationColumn: "alertEpisodeId",
|
|
type: TableColumnType.Entity,
|
|
modelType: AlertEpisode,
|
|
title: "Alert Episode",
|
|
description: "The episode this alert belongs to (if grouped)",
|
|
})
|
|
@ManyToOne(
|
|
() => {
|
|
return AlertEpisode;
|
|
},
|
|
{
|
|
eager: false,
|
|
nullable: true,
|
|
onDelete: "SET NULL",
|
|
orphanedRowAction: "nullify",
|
|
},
|
|
)
|
|
@JoinColumn({ name: "alertEpisodeId" })
|
|
public alertEpisode?: AlertEpisode = undefined;
|
|
|
|
@ColumnAccessControl({
|
|
create: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.CreateAlert,
|
|
],
|
|
read: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.ReadAlert,
|
|
Permission.ReadAllProjectResources,
|
|
],
|
|
update: [
|
|
Permission.ProjectOwner,
|
|
Permission.ProjectAdmin,
|
|
Permission.ProjectMember,
|
|
Permission.EditAlert,
|
|
],
|
|
})
|
|
@Index()
|
|
@TableColumn({
|
|
type: TableColumnType.ObjectID,
|
|
required: false,
|
|
title: "Alert Episode ID",
|
|
description: "The ID of the episode this alert belongs to (if grouped)",
|
|
})
|
|
@Column({
|
|
type: ColumnType.ObjectID,
|
|
nullable: true,
|
|
transformer: ObjectID.getDatabaseTransformer(),
|
|
})
|
|
public alertEpisodeId?: ObjectID = undefined;
|
|
}
|