add severity, topic, and ruleId to notification log table

Author: apexearth

db/migrations/1773090000000-AddNotificationSeverity.js

@@ -0,0 +1,21 @@
+module.exports = class AddNotificationSeverity1773090000000 {
+    name = 'AddNotificationSeverity1773090000000'
+
+    async up(db) {
+        await db.query(`ALTER TABLE "notification_log" ADD "severity" text`)
+        await db.query(`ALTER TABLE "notification_log" ADD "topic" text`)
+        await db.query(`ALTER TABLE "notification_log" ADD "rule_id" text`)
+        await db.query(`CREATE INDEX "IDX_notification_log_severity" ON "notification_log" ("severity") `)
+        await db.query(`CREATE INDEX "IDX_notification_log_topic" ON "notification_log" ("topic") `)
+        await db.query(`CREATE INDEX "IDX_notification_log_rule_id" ON "notification_log" ("rule_id") `)
+    }
+
+    async down(db) {
+        await db.query(`DROP INDEX "public"."IDX_notification_log_rule_id"`)
+        await db.query(`DROP INDEX "public"."IDX_notification_log_topic"`)
+        await db.query(`DROP INDEX "public"."IDX_notification_log_severity"`)
+        await db.query(`ALTER TABLE "notification_log" DROP COLUMN "rule_id"`)
+        await db.query(`ALTER TABLE "notification_log" DROP COLUMN "topic"`)
+        await db.query(`ALTER TABLE "notification_log" DROP COLUMN "severity"`)
+    }
+}

schema.graphql

@@ -30,6 +30,9 @@ type NotificationLog @entity {
   recordId: String! @index         # EventRecord.id or TraceRecord.id
   recordType: String! @index       # "event" | "trace"
   processor: String @index         # Processor name that triggered it
+  severity: String @index          # rule severity at notify time: low|medium|high|critical|broken|highlight
+  topic: String @index             # notification topic/product (OETH, ARM, Governance, …)
+  ruleId: String @index            # alert_rule.id that fired (null for code-driven processors)
   notifiedAt: DateTime! @index
   chainId: Int! @index
   blockNumber: Int! @index

src/model/generated/notificationLog.model.ts

@@ -21,6 +21,18 @@ export class NotificationLog {
     @StringColumn_({nullable: true})
     processor!: string | undefined | null
 
+    @Index_()
+    @StringColumn_({nullable: true})
+    severity!: string | undefined | null
+
+    @Index_()
+    @StringColumn_({nullable: true})
+    topic!: string | undefined | null
+
+    @Index_()
+    @StringColumn_({nullable: true})
+    ruleId!: string | undefined | null
+
     @Index_()
     @DateTimeColumn_({nullable: false})
     notifiedAt!: Date

src/notify/event/event.ts

@@ -78,6 +78,7 @@ export const notifyForEvent = async (params: {
   ctx: Context
   topic: Topic
   severity?: Severity
+  ruleId?: string
   name?: string
   eventName: string
   event: EventDecoder
@@ -94,6 +95,9 @@ export const notifyForEvent = async (params: {
       recordId,
       recordType: 'event',
       processor: params.name,
+      severity: params.severity,
+      topic: params.topic,
+      ruleId: params.ruleId,
       chainId: params.ctx.chain.id,
       blockNumber: params.log.block.height,
     })

src/notify/notification-log.ts

@@ -12,6 +12,9 @@ export const checkAndLogNotification = async (params: {
   recordId: string
   recordType: 'event' | 'trace'
   processor?: string
+  severity?: string
+  topic?: string
+  ruleId?: string
   chainId: number
   blockNumber: number
 }): Promise<boolean> => {
@@ -29,6 +32,9 @@ export const checkAndLogNotification = async (params: {
       recordId: params.recordId,
       recordType: params.recordType,
       processor: params.processor ?? null,
+      severity: params.severity ?? null,
+      topic: params.topic ?? null,
+      ruleId: params.ruleId ?? null,
       notifiedAt: new Date(),
       chainId: params.chainId,
       blockNumber: params.blockNumber,

src/notify/trace.ts

@@ -14,6 +14,7 @@ export interface NotifyForTraceInput {
   ctx: Context
   topic: Topic
   severity?: Severity
+  ruleId?: string
   name?: string
   functionName?: string
   functionData?: unknown
@@ -48,6 +49,9 @@ export const notifyForTrace = async (input: NotifyForTraceInput) => {
       recordId,
       recordType: 'trace',
       processor: name,
+      severity,
+      topic,
+      ruleId: input.ruleId,
       chainId: ctx.chain.id,
       blockNumber: trace.block.height,
     })

src/processors/config-alert.ts

@@ -120,6 +120,7 @@ export const createConfigAlertProcessor = async (chainId: number) => {
               block,
               log,
               event: abiEvent ?? { topic: topic0, decode: () => undefined },
+              ruleId: rule.id,
               topic: rule.topic,
               severity: rule.severity === 'low' ? undefined : rule.severity,
               notifyTarget: rule.notifyTargets ?? undefined,
@@ -174,6 +175,7 @@ export const createConfigAlertProcessor = async (chainId: number) => {
               ctx,
               name: rule.displayName ?? rule.topic,
               trace,
+              ruleId: rule.id,
               topic: rule.topic,
               severity,
               notifyTarget: rule.notifyTargets ?? undefined,