Functions logging (#2245)

* Functions logging

* changeset

* more

* conversation handler

* conversation handler

* this works

* more tests

* more tests

* more tests

* fix build

* fix build

* pr feedback

* pr feedback

* api

* pr feedback

Author: Kamil Sobol

.changeset/poor-moons-refuse.md

@@ -0,0 +1,9 @@
+---
+'@aws-amplify/ai-constructs': minor
+'@aws-amplify/backend-ai': minor
+'@aws-amplify/backend-function': minor
+'@aws-amplify/backend': minor
+'@aws-amplify/platform-core': minor
+---
+
+Add options to control log settings

package-lock.json

@@ -7,12 +7,14 @@
 /// <reference types="node" />
 
 import { AIConversationOutput } from '@aws-amplify/backend-output-schemas';
+import { ApplicationLogLevel } from 'aws-cdk-lib/aws-lambda';
 import { BackendOutputStorageStrategy } from '@aws-amplify/plugin-types';
 import * as bedrock from '@aws-sdk/client-bedrock-runtime';
 import { Construct } from 'constructs';
 import { FunctionResources } from '@aws-amplify/plugin-types';
 import * as jsonSchemaToTypeScript from 'json-schema-to-ts';
 import { ResourceProvider } from '@aws-amplify/plugin-types';
+import { RetentionDays } from 'aws-cdk-lib/aws-logs';
 
 declare namespace __export__conversation {
     export {
@@ -55,6 +57,10 @@ type ConversationHandlerFunctionProps = {
         region?: string;
     }>;
     memoryMB?: number;
+    logging?: {
+        level?: ApplicationLogLevel;
+        retention?: RetentionDays;
+    };
     outputStorageStrategy?: BackendOutputStorageStrategy<AIConversationOutput>;
 };
 

packages/ai-constructs/API.md

@@ -5,6 +5,8 @@ import { ConversationHandlerFunction } from './conversation_handler_construct';
 import { Template } from 'aws-cdk-lib/assertions';
 import path from 'path';
 import { StackMetadataBackendOutputStorageStrategy } from '@aws-amplify/backend-output-storage';
+import { ApplicationLogLevel } from 'aws-cdk-lib/aws-lambda';
+import { RetentionDays } from 'aws-cdk-lib/aws-logs';
 
 void describe('Conversation Handler Function construct', () => {
   void it('creates handler with log group with JWT token redacting policy', () => {
@@ -284,4 +286,41 @@ void describe('Conversation Handler Function construct', () => {
       }, new Error('memoryMB must be a whole number between 128 and 10240 inclusive'));
     });
   });
+
+  void describe('logging options', () => {
+    void it('sets log level', () => {
+      const app = new App();
+      const stack = new Stack(app);
+      new ConversationHandlerFunction(stack, 'conversationHandler', {
+        models: [],
+        logging: {
+          level: ApplicationLogLevel.DEBUG,
+        },
+      });
+      const template = Template.fromStack(stack);
+
+      template.hasResourceProperties('AWS::Lambda::Function', {
+        LoggingConfig: {
+          ApplicationLogLevel: 'DEBUG',
+          LogFormat: 'JSON',
+        },
+      });
+    });
+
+    void it('sets log retention', () => {
+      const app = new App();
+      const stack = new Stack(app);
+      new ConversationHandlerFunction(stack, 'conversationHandler', {
+        models: [],
+        logging: {
+          retention: RetentionDays.ONE_YEAR,
+        },
+      });
+      const template = Template.fromStack(stack);
+
+      template.hasResourceProperties('AWS::Logs::LogGroup', {
+        RetentionInDays: 365,
+      });
+    });
+  });
 });

packages/ai-constructs/src/conversation/conversation_handler_construct.test.ts

@@ -6,6 +6,7 @@ import {
 import { Duration, Stack, Tags } from 'aws-cdk-lib';
 import { Effect, PolicyStatement } from 'aws-cdk-lib/aws-iam';
 import {
+  ApplicationLogLevel,
   CfnFunction,
   Runtime as LambdaRuntime,
   LoggingFormat,
@@ -40,6 +41,12 @@ export type ConversationHandlerFunctionProps = {
    * Default is 512MB.
    */
   memoryMB?: number;
+
+  logging?: {
+    level?: ApplicationLogLevel;
+    retention?: RetentionDays;
+  };
+
   /**
    * @internal
    */
@@ -100,8 +107,9 @@ export class ConversationHandlerFunction
           bundleAwsSDK: !!this.props.entry,
         },
         loggingFormat: LoggingFormat.JSON,
+        applicationLogLevelV2: this.props.logging?.level,
         logGroup: new LogGroup(this, 'conversationHandlerFunctionLogGroup', {
-          retention: RetentionDays.INFINITE,
+          retention: this.props.logging?.retention ?? RetentionDays.INFINITE,
           dataProtectionPolicy: new DataProtectionPolicy({
             identifiers: [
               new CustomDataIdentifier(

packages/ai-constructs/src/conversation/conversation_handler_construct.ts

@@ -8,12 +8,17 @@ import { AiModel } from '@aws-amplify/data-schema-types';
 import { ConstructFactory } from '@aws-amplify/plugin-types';
 import { ConversationTurnEventVersion } from '@aws-amplify/ai-constructs/conversation';
 import { FunctionResources } from '@aws-amplify/plugin-types';
+import { LogLevel } from '@aws-amplify/plugin-types';
+import { LogRetention } from '@aws-amplify/plugin-types';
 import { ResourceProvider } from '@aws-amplify/plugin-types';
 import * as runtime from '@aws-amplify/ai-constructs/conversation/runtime';
 
 declare namespace __export__conversation {
     export {
         ConversationHandlerFunctionFactory,
+        ConversationHandlerFunctionLogLevel,
+        ConversationHandlerFunctionLogRetention,
+        ConversationHandlerFunctionLoggingOptions,
         DefineConversationHandlerFunctionProps,
         defineConversationHandlerFunction
     }
@@ -36,6 +41,18 @@ type ConversationHandlerFunctionFactory = ConstructFactory<ResourceProvider<Func
     readonly eventVersion: ConversationTurnEventVersion;
 };
 
+// @public (undocumented)
+type ConversationHandlerFunctionLoggingOptions = {
+    retention?: ConversationHandlerFunctionLogRetention;
+    level?: ConversationHandlerFunctionLogLevel;
+};
+
+// @public (undocumented)
+type ConversationHandlerFunctionLogLevel = LogLevel;
+
+// @public (undocumented)
+type ConversationHandlerFunctionLogRetention = LogRetention;
+
 // @public (undocumented)
 type ConversationTurnEvent = runtime.ConversationTurnEvent;
 
@@ -54,6 +71,7 @@ type DefineConversationHandlerFunctionProps = {
         region?: string;
     }>;
     memoryMB?: number;
+    logging?: ConversationHandlerFunctionLoggingOptions;
 };
 
 // @public (undocumented)

packages/backend-ai/API.md

@@ -203,4 +203,41 @@ void describe('ConversationHandlerFactory', () => {
       MemorySize: 271,
     });
   });
+
+  void it('passes log level to construct', () => {
+    const factory = defineConversationHandlerFunction({
+      entry: './test-assets/with-default-entry/handler.ts',
+      name: 'testHandlerName',
+      models: [],
+      logging: {
+        level: 'debug',
+      },
+    });
+    const lambda = factory.getInstance(getInstanceProps);
+    const template = Template.fromStack(Stack.of(lambda.resources.lambda));
+    template.resourceCountIs('AWS::Lambda::Function', 1);
+    template.hasResourceProperties('AWS::Lambda::Function', {
+      LoggingConfig: {
+        ApplicationLogLevel: 'DEBUG',
+        LogFormat: 'JSON',
+      },
+    });
+  });
+
+  void it('passes log retention to construct', () => {
+    const factory = defineConversationHandlerFunction({
+      entry: './test-assets/with-default-entry/handler.ts',
+      name: 'testHandlerName',
+      models: [],
+      logging: {
+        retention: '1 day',
+      },
+    });
+    const lambda = factory.getInstance(getInstanceProps);
+    const template = Template.fromStack(Stack.of(lambda.resources.lambda));
+    template.resourceCountIs('AWS::Lambda::Function', 1);
+    template.hasResourceProperties('AWS::Logs::LogGroup', {
+      RetentionInDays: 1,
+    });
+  });
 });

packages/backend-ai/src/conversation/factory.test.ts

@@ -7,6 +7,8 @@ import {
   ConstructFactoryGetInstanceProps,
   FunctionResources,
   GenerateContainerEntryProps,
+  LogLevel,
+  LogRetention,
   ResourceProvider,
 } from '@aws-amplify/plugin-types';
 import {
@@ -17,6 +19,10 @@ import {
 import path from 'path';
 import { CallerDirectoryExtractor } from '@aws-amplify/platform-core';
 import { AiModel } from '@aws-amplify/data-schema-types';
+import {
+  LogLevelConverter,
+  LogRetentionConverter,
+} from '@aws-amplify/platform-core/cdk';
 
 class ConversationHandlerFunctionGenerator
   implements ConstructContainerEntryGenerator
@@ -47,6 +53,18 @@ class ConversationHandlerFunctionGenerator
       outputStorageStrategy: this.outputStorageStrategy,
       memoryMB: this.props.memoryMB,
     };
+    const logging: typeof constructProps.logging = {};
+    if (this.props.logging?.level) {
+      logging.level = new LogLevelConverter().toCDKLambdaApplicationLogLevel(
+        this.props.logging.level
+      );
+    }
+    if (this.props.logging?.retention) {
+      logging.retention = new LogRetentionConverter().toCDKRetentionDays(
+        this.props.logging.retention
+      );
+    }
+    constructProps.logging = logging;
     const conversationHandlerFunction = new ConversationHandlerFunction(
       scope,
       this.props.name,
@@ -115,6 +133,15 @@ class DefaultConversationHandlerFunctionFactory
   };
 }
 
+export type ConversationHandlerFunctionLogLevel = LogLevel;
+
+export type ConversationHandlerFunctionLogRetention = LogRetention;
+
+export type ConversationHandlerFunctionLoggingOptions = {
+  retention?: ConversationHandlerFunctionLogRetention;
+  level?: ConversationHandlerFunctionLogLevel;
+};
+
 export type DefineConversationHandlerFunctionProps = {
   name: string;
   entry?: string;
@@ -128,6 +155,7 @@ export type DefineConversationHandlerFunctionProps = {
    * Default is 512MB.
    */
   memoryMB?: number;
+  logging?: ConversationHandlerFunctionLoggingOptions;
 };
 
 /**

packages/backend-ai/src/conversation/factory.ts

@@ -1,11 +1,17 @@
 import {
   ConversationHandlerFunctionFactory,
+  ConversationHandlerFunctionLogLevel,
+  ConversationHandlerFunctionLogRetention,
+  ConversationHandlerFunctionLoggingOptions,
   DefineConversationHandlerFunctionProps,
   defineConversationHandlerFunction,
 } from './factory.js';
 
 export {
   ConversationHandlerFunctionFactory,
+  ConversationHandlerFunctionLogLevel,
+  ConversationHandlerFunctionLogRetention,
+  ConversationHandlerFunctionLoggingOptions,
   DefineConversationHandlerFunctionProps,
   defineConversationHandlerFunction,
 };

packages/backend-ai/src/conversation/index.ts

@@ -8,6 +8,8 @@ import { AmplifyResourceGroupName } from '@aws-amplify/plugin-types';
 import { BackendSecret } from '@aws-amplify/plugin-types';
 import { ConstructFactory } from '@aws-amplify/plugin-types';
 import { FunctionResources } from '@aws-amplify/plugin-types';
+import { LogLevel } from '@aws-amplify/plugin-types';
+import { LogRetention } from '@aws-amplify/plugin-types';
 import { ResourceAccessAcceptorFactory } from '@aws-amplify/plugin-types';
 import { ResourceProvider } from '@aws-amplify/plugin-types';
 import { StackProvider } from '@aws-amplify/plugin-types';
@@ -28,6 +30,22 @@ export type FunctionBundlingOptions = {
     minify?: boolean;
 };
 
+// @public (undocumented)
+export type FunctionLoggingOptions = ({
+    format: 'json';
+    level?: FunctionLogLevel;
+} | {
+    format?: 'text';
+}) & {
+    retention?: FunctionLogRetention;
+};
+
+// @public (undocumented)
+export type FunctionLogLevel = LogLevel;
+
+// @public (undocumented)
+export type FunctionLogRetention = LogRetention;
+
 // @public (undocumented)
 export type FunctionProps = {
     name?: string;
@@ -40,6 +58,7 @@ export type FunctionProps = {
     layers?: Record<string, string>;
     bundling?: FunctionBundlingOptions;
     resourceGroupName?: AmplifyResourceGroupName;
+    logging?: FunctionLoggingOptions;
 };
 
 // @public (undocumented)