feature: add cloudwatch dashboards and alarms (ran-isenberg#747)

Co-authored-by: Ran Isenberg <ran.isenberg@ranthebuilder.cloud>

Author: ran-isenberg

README.md

@@ -84,6 +84,7 @@ This project aims to reduce cognitive load and answer these questions for you by
 - AWS Lambda handler 3 layer architecture: handler layer, logic layer and data access layer
 - Features flags and configuration based on AWS AppConfig
 - Idempotent API
+- CloudWatch dashboards - High level and low level including CloudWatch alarms
 - Unit, infrastructure, security, integration and end to end tests.
 
 

cdk/service/api_construct.py

@@ -8,6 +8,7 @@
 
 import cdk.service.constants as constants
 from cdk.service.api_db_construct import ApiDbConstruct
+from cdk.service.monitoring import CrudMonitoring
 
 
 class ApiConstruct(Construct):
@@ -20,7 +21,9 @@ def __init__(self, scope: Construct, id_: str, appconfig_app_name: str) -> None:
  self.common_layer = self._build_common_layer()
  self.rest_api = self._build_api_gw()
  api_resource: aws_apigateway.Resource = self.rest_api.root.add_resource('api').add_resource(constants.GW_RESOURCE)
- self._add_post_lambda_integration(api_resource, self.lambda_role, self.api_db.db, appconfig_app_name, self.api_db.idempotency_db)
+ self.create_order_func = self._add_post_lambda_integration(api_resource, self.lambda_role, self.api_db.db, appconfig_app_name,
+ self.api_db.idempotency_db)
+ self.monitoring = CrudMonitoring(self, id_, self.rest_api, self.api_db.db, self.api_db.idempotency_db, [self.create_order_func])
 
  def _build_api_gw(self) -> aws_apigateway.RestApi:
  rest_api: aws_apigateway.RestApi = aws_apigateway.RestApi(
@@ -81,7 +84,7 @@ def _build_common_layer(self) -> PythonLayerVersion:
  )
 
  def _add_post_lambda_integration(self, api_name: aws_apigateway.Resource, role: iam.Role, db: dynamodb.Table, appconfig_app_name: str,
- idempotency_table: dynamodb.Table):
+ idempotency_table: dynamodb.Table) -> _lambda.Function:
  lambda_function = _lambda.Function(
  self,
  constants.CREATE_LAMBDA,
@@ -111,3 +114,4 @@ def _add_post_lambda_integration(self, api_name: aws_apigateway.Resource, role:
 
  # POST /api/orders/
  api_name.add_method(http_method='POST', integration=aws_apigateway.LambdaIntegration(handler=lambda_function))
+ return lambda_function

cdk/service/constants.py

@@ -13,7 +13,8 @@
 API_HANDLER_LAMBDA_TIMEOUT = 10 # seconds
 POWERTOOLS_SERVICE_NAME = 'POWERTOOLS_SERVICE_NAME'
 SERVICE_NAME = 'Orders'
-METRICS_NAMESPACE = 'my_product_kpi'
+METRICS_NAMESPACE = 'orders_kpi'
+METRICS_DIMENSION_KEY = 'service'
 POWERTOOLS_TRACE_DISABLED = 'POWERTOOLS_TRACE_DISABLED'
 POWER_TOOLS_LOG_LEVEL = 'LOG_LEVEL'
 BUILD_FOLDER = '.build/lambdas/'

cdk/service/monitoring.py

@@ -0,0 +1,62 @@
+from aws_cdk import Duration, aws_apigateway
+from aws_cdk import aws_dynamodb as dynamodb
+from aws_cdk import aws_lambda as _lambda
+from cdk_monitoring_constructs import CustomMetricGroup, ErrorRateThreshold, LatencyThreshold, MetricStatistic, MonitoringFacade
+from constructs import Construct
+
+from cdk.service import constants
+
+
+class CrudMonitoring(Construct):
+
+ def __init__(
+ self,
+ scope: Construct,
+ id_: str,
+ crud_api: aws_apigateway.RestApi,
+ db: dynamodb.Table,
+ idempotency_table: dynamodb.Table,
+ functions: list[_lambda.Function],
+ ) -> None:
+ super().__init__(scope, id_)
+ self.id_ = id_
+ self._build_high_level_dashboard(crud_api)
+ self._build_low_level_dashboard(db, idempotency_table, functions)
+
+ def _build_high_level_dashboard(self, crud_api: aws_apigateway.RestApi):
+ high_level_facade = MonitoringFacade(self, f'{self.id_}HighFacade')
+ high_level_facade.add_large_header('Order REST API High Level Dashboard')
+ high_level_facade.monitor_api_gateway(
+ api=crud_api,
+ add5_xx_fault_rate_alarm={'internal_error': ErrorRateThreshold(max_error_rate=1)},
+ )
+ metric_factory = high_level_facade.create_metric_factory()
+ create_metric = metric_factory.create_metric(
+ metric_name='ValidCreateOrderEvents',
+ namespace=constants.METRICS_NAMESPACE,
+ statistic=MetricStatistic.N,
+ dimensions_map={constants.METRICS_DIMENSION_KEY: constants.SERVICE_NAME},
+ label='create order events',
+ period=Duration.days(1),
+ )
+
+ group = CustomMetricGroup(metrics=[create_metric], title='Daily Order Requests')
+ high_level_facade.monitor_custom(metric_groups=[group], human_readable_name='Daily KPIs', alarm_friendly_name='KPIs')
+
+ def _build_low_level_dashboard(self, db: dynamodb.Table, idempotency_table: dynamodb.Table, functions: list[_lambda.Function]):
+ low_level_facade = MonitoringFacade(self, f'{self.id_}LowFacade')
+ low_level_facade.add_large_header('Orders REST API Low Level Dashboard')
+ for func in functions:
+ low_level_facade.monitor_lambda_function(
+ lambda_function=func,
+ add_latency_p90_alarm={'p90': LatencyThreshold(max_latency=Duration.seconds(3))},
+ )
+ low_level_facade.monitor_log(
+ log_group_name=func.log_group.log_group_name,
+ human_readable_name='Error logs',
+ pattern='ERROR',
+ alarm_friendly_name='error logs',
+ )
+
+ low_level_facade.monitor_dynamo_table(table=db, billing_mode=dynamodb.BillingMode.PAY_PER_REQUEST)
+ low_level_facade.monitor_dynamo_table(table=idempotency_table, billing_mode=dynamodb.BillingMode.PAY_PER_REQUEST)

docs/index.md

@@ -37,6 +37,7 @@ This project aims to reduce cognitive load and answer these questions for you by
 - AWS Lambda handler uses [AWS Lambda Powertools](https://docs.powertools.aws.dev/lambda-python/){:target="_blank" rel="noopener"}.
 - AWS Lambda handler 3 layer architecture: handler layer, logic layer and data access layer
 - Features flags and configuration based on AWS AppConfig
+- CloudWatch dashboards - High level and low level including CloudWatch alarms
 - Idempotent API
 - Unit, infrastructure, security, integration and E2E tests.
 

poetry.lock

@@ -33,6 +33,7 @@ constructs = ">=10.0.0"
 cdk-nag = ">2.0.0"
 "aws-cdk.aws-lambda-python-alpha" = "^2.99.0-alpha.0"
 "aws-cdk.aws-appconfig-alpha" = "^2.99.0-alpha.0"
+cdk-monitoring-constructs = "*"
 # DEV
 pytest = "*"
 pytest-mock = "*"

pyproject.toml

@@ -1,4 +1,3 @@
-from http import HTTPMethod
 from typing import Any
 
 from aws_lambda_env_modeler import get_environment_variables, init_environment_variables
@@ -18,7 +17,7 @@
 from service.schemas.output import CreateOrderOutput
 
 
-@app.route(ORDERS_PATH, method=HTTPMethod.POST)
+@app.post(ORDERS_PATH)
 def handle_create_order() -> dict[str, Any]:
  env_vars: MyHandlerEnvVars = get_environment_variables(model=MyHandlerEnvVars)
  logger.debug('environment variables', env_vars=env_vars.model_dump())

service/handlers/handle_create_order.py

@@ -2,7 +2,7 @@
 from aws_lambda_powertools.metrics.metrics import Metrics
 from aws_lambda_powertools.tracing.tracer import Tracer
 
-METRICS_NAMESPACE = 'my_product_kpi'
+METRICS_NAMESPACE = 'orders_kpi'
 
 # JSON output format, service name can be set by environment variable "POWERTOOLS_SERVICE_NAME"
 logger: Logger = Logger()