feat: add logging format configuration and integrate pino logger

- Added `CDK_APP_LOGGING_FORMAT` to configuration schema with options for 'text' and 'json'.
- Integrated pino as the logging library for structured logging.
- Updated logger utility to support both text and JSON formats based on configuration.
- Modified logging statements across the application to include contextual information.
- Enhanced tests to validate logging behavior for both formats.

Author: mwarman

docs/InfrastructureGuide.md

@@ -324,6 +324,7 @@ All configuration is managed through environment variables prefixed with `CDK_`:
 | `CDK_OWNER`              | No       | Resource owner             | `unknown`        |
 | `CDK_APP_ENABLE_LOGGING` | No       | Enable application logging | `true`           |
 | `CDK_APP_LOGGING_LEVEL`  | No       | Application logging level  | `info`           |
+| `CDK_APP_LOGGING_FORMAT` | No       | Application logging format | `json`           |
 
 ### Configuration Validation
 
@@ -342,6 +343,7 @@ const configSchema = z.object({
     .transform((val) => val === 'true')
     .default('true'),
   CDK_APP_LOGGING_LEVEL: z.enum(['debug', 'info', 'warn', 'error']).default('info'),
+  CDK_APP_LOGGING_FORMAT: z.enum(['text', 'json']).default('json'),
 });
 ```
 
@@ -432,6 +434,7 @@ const tableName = process.env.TASK_TABLE_NAME;
   - `TASKS_TABLE`: DynamoDB table name
   - `ENABLE_LOGGING`: Logging enabled flag (from `CDK_APP_ENABLE_LOGGING`)
   - `LOG_LEVEL`: Minimum log level (from `CDK_APP_LOGGING_LEVEL`)
+  - `LOG_FORMAT`: Log output format (from `CDK_APP_LOGGING_FORMAT`)
 
 **CloudWatch Logs**:
 
@@ -486,16 +489,24 @@ The Lambda stack uses environment variables to configure application behavior:
   - Passed to Lambda as `LOG_LEVEL` environment variable
   - Controls verbosity of application logging
 
+- **CDK_APP_LOGGING_FORMAT**: Sets the log output format
+  - Valid values: `text`, `json` (default)
+  - Passed to Lambda as `LOG_FORMAT` environment variable
+  - `json`: Structured JSON logs ideal for CloudWatch Logs Insights and log aggregation
+  - `text`: Human-readable text format with stringified context
+
 **Example Usage**:
 
 ```bash
-# Development with debug logging
+# Development with debug logging in text format
 CDK_APP_ENABLE_LOGGING=true
 CDK_APP_LOGGING_LEVEL=debug
+CDK_APP_LOGGING_FORMAT=text
 
-# Production with info logging
+# Production with info logging in JSON format
 CDK_APP_ENABLE_LOGGING=true
 CDK_APP_LOGGING_LEVEL=info
+CDK_APP_LOGGING_FORMAT=json
 
 # Disable logging (not recommended)
 CDK_APP_ENABLE_LOGGING=false

infrastructure/.env.example

@@ -25,3 +25,5 @@ CDK_ENV=dev
 # CDK_APP_ENABLE_LOGGING=true
 ## Application logging level: debug, info, warn, error (default: info)
 # CDK_APP_LOGGING_LEVEL=info
+## Application logging format: text, json (default: json)
+# CDK_APP_LOGGING_FORMAT=json

infrastructure/README.md

@@ -180,6 +180,7 @@ All CDK configuration is managed through environment variables prefixed with `CD
 | `CDK_OWNER`              | No       | Team or owner name                         | Any string                       | `unknown`                          |
 | `CDK_APP_ENABLE_LOGGING` | No       | Enable application logging                 | `true`, `false`                  | `true`                             |
 | `CDK_APP_LOGGING_LEVEL`  | No       | Application logging level                  | `debug`, `info`, `warn`, `error` | `info`                             |
+| `CDK_APP_LOGGING_FORMAT` | No       | Application logging format                 | `text`, `json`                   | `json`                             |
 
 ### AWS Account and Region Resolution
 
@@ -294,12 +295,18 @@ npm run cdk destroy --all
 
 **Logging Configuration:**
 
-The Lambda stack uses the `CDK_APP_ENABLE_LOGGING` and `CDK_APP_LOGGING_LEVEL` environment variables to configure application logging:
+The Lambda stack uses the `CDK_APP_ENABLE_LOGGING`, `CDK_APP_LOGGING_LEVEL`, and `CDK_APP_LOGGING_FORMAT` environment variables to configure application logging:
 
 - **CDK_APP_ENABLE_LOGGING**: Controls whether logging is enabled in the Lambda functions
 - **CDK_APP_LOGGING_LEVEL**: Sets the minimum log level (`debug`, `info`, `warn`, `error`)
+- **CDK_APP_LOGGING_FORMAT**: Sets the log output format (`text` or `json`)
 
-These values are passed to the Lambda functions as environment variables (`ENABLE_LOGGING` and `LOG_LEVEL`) and control both CloudWatch log output and application-level logging behavior.
+These values are passed to the Lambda functions as environment variables (`ENABLE_LOGGING`, `LOG_LEVEL`, and `LOG_FORMAT`) and control both CloudWatch log output and application-level logging behavior.
+
+**Log Format Options:**
+
+- **json** (default): Structured JSON logs ideal for CloudWatch Logs Insights and log aggregation tools. Each log entry is a JSON object with fields like `timestamp`, `level`, `message`, and any additional context fields.
+- **text**: Human-readable text format with timestamp, level, and message. Context is stringified and appended to the message.
 
 ## Resource Tagging
 

infrastructure/app.ts

@@ -36,6 +36,7 @@ new LambdaStack(app, `${config.CDK_APP_NAME}-lambda-stack-${config.CDK_ENV}`, {
   taskTable: dataStack.taskTable,
   enableLogging: config.CDK_APP_ENABLE_LOGGING,
   loggingLevel: config.CDK_APP_LOGGING_LEVEL,
+  loggingFormat: config.CDK_APP_LOGGING_FORMAT,
   ...(environmentConfig && { env: environmentConfig }),
 });
 

infrastructure/stacks/data-stack.test.ts

@@ -21,13 +21,13 @@ describe('DataStack', () => {
         BillingMode: 'PAY_PER_REQUEST',
         KeySchema: [
           {
-            AttributeName: 'id',
+            AttributeName: 'pk',
             KeyType: 'HASH',
           },
         ],
         AttributeDefinitions: [
           {
-            AttributeName: 'id',
+            AttributeName: 'pk',
             AttributeType: 'S',
           },
         ],

infrastructure/stacks/lambda-stack.test.ts

@@ -42,6 +42,7 @@ describe('LambdaStack', () => {
         taskTable: testMockTable,
         enableLogging: true,
         loggingLevel: 'debug',
+        loggingFormat: 'json',
       });
       template = Template.fromStack(stack);
     });
@@ -63,6 +64,7 @@ describe('LambdaStack', () => {
             TASKS_TABLE: Match.anyValue(),
             ENABLE_LOGGING: 'true',
             LOG_LEVEL: 'debug',
+            LOG_FORMAT: 'json',
           },
         },
       });
@@ -179,6 +181,7 @@ describe('LambdaStack', () => {
         taskTable: testMockTable,
         enableLogging: true,
         loggingLevel: 'info',
+        loggingFormat: 'json',
       });
       template = Template.fromStack(stack);
     });
@@ -233,6 +236,7 @@ describe('LambdaStack', () => {
         taskTable: testMockTable,
         enableLogging: true,
         loggingLevel: 'debug',
+        loggingFormat: 'json',
       });
       template = Template.fromStack(stack);
     });

infrastructure/stacks/lambda-stack.ts

@@ -35,6 +35,11 @@ export interface LambdaStackProps extends cdk.StackProps {
    * Application logging level.
    */
   loggingLevel: string;
+
+  /**
+   * Application logging format (text or json).
+   */
+  loggingFormat: string;
 }
 
 /**
@@ -64,6 +69,7 @@ export class LambdaStack extends cdk.Stack {
         TASKS_TABLE: props.taskTable.tableName,
         ENABLE_LOGGING: props.enableLogging.toString(),
         LOG_LEVEL: props.loggingLevel,
+        LOG_FORMAT: props.loggingFormat,
       },
       timeout: cdk.Duration.seconds(10),
       memorySize: 256,

infrastructure/utils/config.test.ts

@@ -32,6 +32,7 @@ describe('config', () => {
       process.env.CDK_OWNER = 'platform-team';
       process.env.CDK_APP_ENABLE_LOGGING = 'false';
       process.env.CDK_APP_LOGGING_LEVEL = 'warn';
+      process.env.CDK_APP_LOGGING_FORMAT = 'text';
 
       const config = getConfig();
 
@@ -44,6 +45,7 @@ describe('config', () => {
         CDK_OWNER: 'platform-team',
         CDK_APP_ENABLE_LOGGING: false,
         CDK_APP_LOGGING_LEVEL: 'warn',
+        CDK_APP_LOGGING_FORMAT: 'text',
       });
     });
 
@@ -58,6 +60,26 @@ describe('config', () => {
 
       expect(() => getConfig()).toThrow('CDK_ENV must be one of: dev, qat, prd');
     });
+
+    it('should validate CDK_APP_LOGGING_FORMAT enum values', () => {
+      process.env.CDK_ENV = 'dev';
+
+      // Valid values
+      const validFormats = ['text', 'json'];
+      validFormats.forEach((format) => {
+        jest.resetModules();
+        process.env.CDK_APP_LOGGING_FORMAT = format;
+        const config = getConfig();
+        expect(config.CDK_APP_LOGGING_FORMAT).toBe(format);
+      });
+    });
+
+    it('should throw error when CDK_APP_LOGGING_FORMAT is invalid', () => {
+      process.env.CDK_ENV = 'dev';
+      process.env.CDK_APP_LOGGING_FORMAT = 'xml';
+
+      expect(() => getConfig()).toThrow('CDK configuration validation failed');
+    });
   });
 
   describe('getTags', () => {
@@ -69,6 +91,7 @@ describe('config', () => {
         CDK_OWNER: 'platform-team',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const tags = getTags(config);
@@ -87,6 +110,7 @@ describe('config', () => {
         CDK_ENV: 'qat',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const tags = getTags(config);
@@ -105,6 +129,7 @@ describe('config', () => {
         CDK_ENV: 'dev',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const tags = getTags(config);
@@ -130,6 +155,7 @@ describe('config', () => {
         CDK_REGION: 'us-west-2',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const envConfig = getEnvironmentConfig(config);
@@ -151,6 +177,7 @@ describe('config', () => {
         CDK_ENV: 'dev',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const envConfig = getEnvironmentConfig(config);
@@ -172,6 +199,7 @@ describe('config', () => {
         CDK_REGION: 'ap-southeast-2',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const envConfig = getEnvironmentConfig(config);
@@ -193,6 +221,7 @@ describe('config', () => {
         CDK_ENV: 'dev',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const envConfig = getEnvironmentConfig(config);
@@ -209,6 +238,7 @@ describe('config', () => {
         CDK_ENV: 'dev',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const envConfig = getEnvironmentConfig(config);
@@ -225,6 +255,7 @@ describe('config', () => {
         CDK_ENV: 'dev',
         CDK_APP_ENABLE_LOGGING: true,
         CDK_APP_LOGGING_LEVEL: 'info',
+        CDK_APP_LOGGING_FORMAT: 'json',
       };
 
       const envConfig = getEnvironmentConfig(config);

infrastructure/utils/config.ts

@@ -16,6 +16,7 @@ const configSchema = z.object({
     .default('true')
     .transform((val) => val === 'true'),
   CDK_APP_LOGGING_LEVEL: z.enum(['debug', 'info', 'warn', 'error'] as const).default('info'),
+  CDK_APP_LOGGING_FORMAT: z.enum(['text', 'json'] as const).default('json'),
 });
 
 /**