feat: add cloudwatch alarms for sqs (#50)

Author: pevisscher

src/definition/handler/events/http.schema.ts

@@ -1,5 +1,5 @@
 import { $enum, $object, $string } from '@skyleague/therefore'
-import { apigatewayMonitoringMetric } from '../../monitoring/apigateway.schema.js'
+import { apigatewayMonitoringMetric } from '../../monitoring/metrics.schema.js'
 
 export const httpTrigger = $object({
     http: $object({

src/definition/handler/events/http.type.ts

@@ -4,7 +4,7 @@
  */
 /* eslint-disable */
 
-import type { ApigatewayMonitoringMetric } from '../../monitoring/apigateway.type.js'
+import type { ApigatewayMonitoringMetric } from '../../monitoring/metrics.type.js'
 
 export interface HttpTrigger {
     /**

src/definition/handler/events/sqs.schema.ts

@@ -11,6 +11,7 @@ import {
     $union,
     $unknown,
 } from '@skyleague/therefore'
+import { sqsMonitoring } from '../../monitoring/metrics.schema.js'
 
 export const fifoSettings = $object({
     enabled: $boolean().optional().describe('Whether to enable FIFO queue support. Default is false.'),
@@ -72,6 +73,7 @@ export const sqsTrigger = $object({
         policy: $string().optional().describe('The policy of the queue.'),
         kmsDataKeyReusePeriodSeconds: $number().optional().describe('The data key reuse period of the queue.'),
         tags: $record($string).optional().describe('The tags to apply to the queue.'),
-        eventbridge: $ref(eventbridgeSettings).optional(),
+        eventbridge: eventbridgeSettings.optional(),
+        monitoring: sqsMonitoring.optional(),
     }).describe('Subscribes to an SQS queue.'),
 })

src/definition/handler/events/sqs.type.ts

@@ -4,6 +4,8 @@
  */
 /* eslint-disable */
 
+import type { SqsMonitoring } from '../../monitoring/metrics.type.js'
+
 /**
  * The dead-letter queue settings to use when messages are not processed.
  */
@@ -154,5 +156,6 @@ export interface SqsTrigger {
               }
             | undefined
         eventbridge?: EventbridgeSettings | undefined
+        monitoring?: SqsMonitoring | undefined
     }
 }

src/definition/monitoring/apigateway.schema.ts

@@ -1,4 +1,4 @@
-import { $boolean, $number, $object } from '@skyleague/therefore'
+import { $boolean, $number, $object, type Node } from '@skyleague/therefore'
 
 export const anomalyMetric = $object({
     enabled: $boolean(),
@@ -14,3 +14,68 @@ export const staticMetric = $object({
     period: $number(),
     evaluationPeriods: $number(),
 }).partial()
+
+const toMetric = <T extends Node>(metric: T) =>
+    $object({
+        average: metric,
+        sum: metric,
+        minimum: metric,
+        maximum: metric,
+        sampleCount: metric,
+        iqm: metric,
+
+        p80: metric,
+        tm80: metric,
+        tc80: metric,
+        wm80: metric,
+
+        p90: metric,
+        tm90: metric,
+        tc90: metric,
+        wm90: metric,
+
+        p95: metric,
+        tm95: metric,
+        tc95: metric,
+        wm95: metric,
+
+        p99: metric,
+        tm99: metric,
+        tc99: metric,
+        wm99: metric,
+    }).partial()
+
+export const defaultMetric = $object({
+    static: toMetric(staticMetric),
+    anomaly: toMetric(anomalyMetric),
+}).partial()
+
+export const apigatewayMonitoringMetric = $object({
+    latency: defaultMetric,
+    integrationLatency: defaultMetric,
+    '5xx': defaultMetric,
+    '4xx': defaultMetric,
+    dataProcessed: defaultMetric,
+    count: defaultMetric,
+}).partial()
+
+export const apigatewayMonitoring = $object({
+    route: apigatewayMonitoringMetric,
+    api: apigatewayMonitoringMetric,
+}).partial()
+
+export const sqsMonitoringMetric = $object({
+    numberOfMessagesSent: defaultMetric,
+    approximateNumberOfMessagesVisible: defaultMetric,
+    approximateNumberOfMessagesDelayed: defaultMetric,
+    approximateAgeOfOldestMessage: defaultMetric,
+    approximateNumberOfMessagesNotVisible: defaultMetric,
+    numberOfMessagesDeleted: defaultMetric,
+    numberOfMessagesReceived: defaultMetric,
+    numberOfEmptyReceives: defaultMetric,
+}).partial()
+
+export const sqsMonitoring = $object({
+    queue: sqsMonitoringMetric,
+    dlq: sqsMonitoringMetric,
+}).partial()

src/definition/monitoring/apigateway.type.ts

@@ -12,6 +12,91 @@ export interface AnomalyMetric {
     metricPeriod?: number | undefined
 }
 
+export interface ApigatewayMonitoring {
+    route?: ApigatewayMonitoringMetric | undefined
+    api?: ApigatewayMonitoringMetric | undefined
+}
+
+export interface ApigatewayMonitoringMetric {
+    latency?: DefaultMetric | undefined
+    integrationLatency?: DefaultMetric | undefined
+    '5xx'?: DefaultMetric | undefined
+    '4xx'?: DefaultMetric | undefined
+    dataProcessed?: DefaultMetric | undefined
+    count?: DefaultMetric | undefined
+}
+
+export interface DefaultMetric {
+    static?:
+        | {
+              average?: StaticMetric | undefined
+              sum?: StaticMetric | undefined
+              minimum?: StaticMetric | undefined
+              maximum?: StaticMetric | undefined
+              sampleCount?: StaticMetric | undefined
+              iqm?: StaticMetric | undefined
+              p80?: StaticMetric | undefined
+              tm80?: StaticMetric | undefined
+              tc80?: StaticMetric | undefined
+              wm80?: StaticMetric | undefined
+              p90?: StaticMetric | undefined
+              tm90?: StaticMetric | undefined
+              tc90?: StaticMetric | undefined
+              wm90?: StaticMetric | undefined
+              p95?: StaticMetric | undefined
+              tm95?: StaticMetric | undefined
+              tc95?: StaticMetric | undefined
+              wm95?: StaticMetric | undefined
+              p99?: StaticMetric | undefined
+              tm99?: StaticMetric | undefined
+              tc99?: StaticMetric | undefined
+              wm99?: StaticMetric | undefined
+          }
+        | undefined
+    anomaly?:
+        | {
+              average?: AnomalyMetric | undefined
+              sum?: AnomalyMetric | undefined
+              minimum?: AnomalyMetric | undefined
+              maximum?: AnomalyMetric | undefined
+              sampleCount?: AnomalyMetric | undefined
+              iqm?: AnomalyMetric | undefined
+              p80?: AnomalyMetric | undefined
+              tm80?: AnomalyMetric | undefined
+              tc80?: AnomalyMetric | undefined
+              wm80?: AnomalyMetric | undefined
+              p90?: AnomalyMetric | undefined
+              tm90?: AnomalyMetric | undefined
+              tc90?: AnomalyMetric | undefined
+              wm90?: AnomalyMetric | undefined
+              p95?: AnomalyMetric | undefined
+              tm95?: AnomalyMetric | undefined
+              tc95?: AnomalyMetric | undefined
+              wm95?: AnomalyMetric | undefined
+              p99?: AnomalyMetric | undefined
+              tm99?: AnomalyMetric | undefined
+              tc99?: AnomalyMetric | undefined
+              wm99?: AnomalyMetric | undefined
+          }
+        | undefined
+}
+
+export interface SqsMonitoring {
+    queue?: SqsMonitoringMetric | undefined
+    dlq?: SqsMonitoringMetric | undefined
+}
+
+export interface SqsMonitoringMetric {
+    numberOfMessagesSent?: DefaultMetric | undefined
+    approximateNumberOfMessagesVisible?: DefaultMetric | undefined
+    approximateNumberOfMessagesDelayed?: DefaultMetric | undefined
+    approximateAgeOfOldestMessage?: DefaultMetric | undefined
+    approximateNumberOfMessagesNotVisible?: DefaultMetric | undefined
+    numberOfMessagesDeleted?: DefaultMetric | undefined
+    numberOfMessagesReceived?: DefaultMetric | undefined
+    numberOfEmptyReceives?: DefaultMetric | undefined
+}
+
 export interface StaticMetric {
     enabled?: boolean | undefined
     threshold?: number | undefined

src/definition/monitoring/metrics.schema.ts

@@ -0,0 +1,8 @@
+import { $object, type ObjectType } from '@skyleague/therefore'
+import { apigatewayMonitoring, sqsMonitoring } from './metrics.schema.js'
+
+export const monitoring: ObjectType = $object({
+    httpApi: apigatewayMonitoring,
+    restApi: apigatewayMonitoring,
+    sqs: sqsMonitoring,
+}).partial()

src/definition/monitoring/metrics.type.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by @skyleague/therefore@v1.0.0-local
+ * Do not manually touch this
+ */
+/* eslint-disable */
+
+import type { ApigatewayMonitoring, SqsMonitoring } from './metrics.type.js'
+
+export interface Monitoring {
+    httpApi?: ApigatewayMonitoring | undefined
+    restApi?: ApigatewayMonitoring | undefined
+    sqs?: SqsMonitoring | undefined
+}