feat(cdk-docker-cluster): support logging retention

Author: thijsdaniels

.changeset/add-log-retention-to-service-props.md

@@ -0,0 +1,5 @@
+---
+"@codedazur/cdk-docker-cluster": minor
+---
+
+Add `logging` configuration option with `retention` to `ServiceProps`.

package-lock.json

@@ -1,6 +1,7 @@
 import { App, Stack } from "aws-cdk-lib";
 import { Match, Template } from "aws-cdk-lib/assertions";
 import { ContainerImage } from "aws-cdk-lib/aws-ecs";
+import { RetentionDays } from "aws-cdk-lib/aws-logs";
 import { describe, it } from "vitest";
 import { DockerCluster } from "./DockerCluster";
 
@@ -83,4 +84,24 @@ describe("DockerCluster", () => {
       HealthCheckPath: "/api/health",
     });
   });
+
+  it("configures log retention when specified", () => {
+    const app = new App();
+    const stack = new Stack(app, "Test");
+
+    new DockerCluster(stack, "DockerCluster", {
+      source: ContainerImage.fromRegistry("nginx:alpine"),
+      service: {
+        logging: {
+          retention: RetentionDays.ONE_WEEK,
+        },
+      },
+    });
+
+    const template = Template.fromStack(stack);
+
+    template.hasResourceProperties("AWS::Logs::LogGroup", {
+      RetentionInDays: 7,
+    });
+  });
 });

packages/cdk-docker-cluster/src/constructs/DockerCluster.test.ts

@@ -15,6 +15,7 @@ import {
   AssetImageProps,
   Cluster,
   ContainerImage,
+  LogDriver,
   ScalableTaskCount,
   Secret,
 } from "aws-cdk-lib/aws-ecs";
@@ -23,6 +24,7 @@ import {
   ApplicationLoadBalancedFargateServiceProps,
 } from "aws-cdk-lib/aws-ecs-patterns";
 import { HealthCheck } from "aws-cdk-lib/aws-elasticloadbalancingv2";
+import { RetentionDays } from "aws-cdk-lib/aws-logs";
 import { Construct } from "constructs";
 
 export interface ClusterConfig {
@@ -48,6 +50,13 @@ export interface DockerClusterProps {
   readonly cluster?: ClusterConfig;
 }
 
+export interface LoggingConfig {
+  /**
+   * The number of days log events are kept in CloudWatch Logs.
+   */
+  readonly retention?: RetentionDays;
+}
+
 export interface ServiceProps {
   readonly port?: number;
   readonly tasks?: number | AutoScalingConfig;
@@ -59,6 +68,10 @@ export interface ServiceProps {
    * Health check configuration for the Application Load Balancer target group.
    */
   readonly healthCheck?: HealthCheck;
+  /**
+   * CloudWatch logging configuration for the container.
+   */
+  readonly logging?: LoggingConfig;
 }
 
 interface AutoScalingConfig {
@@ -163,6 +176,13 @@ export class DockerCluster extends Construct {
     const containerInsights =
       this.props.containerInsights ?? this.props.cluster?.containerInsights;
 
+    const logDriver = this.props.service?.logging?.retention
+      ? LogDriver.awsLogs({
+          streamPrefix: this.node.id,
+          logRetention: this.props.service.logging.retention,
+        })
+      : undefined;
+
     const service = new ApplicationLoadBalancedFargateService(this, "Service", {
       cluster: new Cluster(this, "Cluster", {
         containerInsights,
@@ -173,6 +193,7 @@ export class DockerCluster extends Construct {
       taskImageOptions: {
         image: this.image,
         containerPort: this.props.service?.port,
+        logDriver,
         environment: this.props.service?.environment,
         secrets: this.props.service?.secrets,
       },

packages/cdk-docker-cluster/src/constructs/DockerCluster.ts

@@ -1,6 +1,7 @@
 import { App, Stack } from "aws-cdk-lib";
 import { Template } from "aws-cdk-lib/assertions";
 import { ContainerImage } from "aws-cdk-lib/aws-ecs";
+import { RetentionDays } from "aws-cdk-lib/aws-logs";
 import { describe, it } from "vitest";
 import { NextApp } from "./NextApp";
 
@@ -45,4 +46,24 @@ describe("NextApp", () => {
       HealthCheckPath: "/api/health",
     });
   });
+
+  it("forwards log retention configuration to the log group", () => {
+    const app = new App();
+    const stack = new Stack(app, "Test");
+
+    new NextApp(stack, "NextApp", {
+      source: ContainerImage.fromRegistry("nginx:alpine"),
+      service: {
+        logging: {
+          retention: RetentionDays.ONE_WEEK,
+        },
+      },
+    });
+
+    const template = Template.fromStack(stack);
+
+    template.hasResourceProperties("AWS::Logs::LogGroup", {
+      RetentionInDays: 7,
+    });
+  });
 });