The purpose of this system is to manage the state of all applications within GHGC, by consolidating and tracking performance metrics and logs into actionable data and alerts.
All significant design decisions are captured in Architectural Decision Records (ADR). Currently, the following ADRs exist:
Deployment of monitoring services is managed via AWS CDK.
Configuration is provided via environment variables. These environment variables can be provided to the application in a number of ways:
- set on the environment manually prior to running CDK commands (e.g.
export STAGE=my-stage) - provided inline when running CDK (e.g.
STAGE=my-stage cdk diffnpx) - specified within a dotenv file. When our settings class initializes, it will attempt to load a dotenv file (located at
.envby default, configurable via theDOTENVenvironment variable). Note that some environment variables such asAWS_PROFILEare best provided via methods other than a dotenv file as CDK will make available required related environment variables (e.g.CDK_DEFAULT_ACCOUNT,CDK_DEFAULT_REGION) before initializing our settings class
An example of the environment variables used by our settings class can be found in .env.example.
cdk lslist all stacks in the appcdk synthemits the synthesized CloudFormation templatecdk deploydeploy this stack to your default AWS account/regioncdk diffcompare deployed stack with current statecdk docsopen CDK documentation