AwsServerlessObservabilityArgs

interface AwsServerlessObservabilityArgs {
alarms?: false | AwsServerlessObservabilityAlarmArgs;
logGroup?: false | AwsServerlessObservabilityLogGroupArgs;
}

Optional observability capability for AwsServerless.

Remarks

Set logGroup or alarms to false to disable that part of the bundle.

When logGroup is set to false, each function in args.functions must provide logging.logGroup as an AwsCloudwatch log-group reference.

Example

CODE

const observability: AwsServerlessObservabilityArgs = {
  logGroup: {
    retentionInDays: 14,
  },
  alarms: {
    errorThreshold: 1,
    throttleThreshold: 1,
  },
};

CODE

const apiLogs = new AwsCloudwatch({
  logGroup: {
    name: 'apiLogs',
  },
});

const observabilityDisabled: AwsServerlessObservabilityArgs = {
  logGroup: false,
  alarms: false,
};

const functionsWithExplicitLogGroups: Record<string, AwsServerlessFunctionDefinitionArgs> = {
  api: {
    codePath: './dist/lambda',
    handler: 'index.handler',
    runtime: 'nodejs22.x',
    logging: {
      logGroup: apiLogs,
    },
  },
};

Properties

`alarms: false | AwsServerlessObservabilityAlarmArgs`

Baseline alarm settings or false to disable alarm creation.

`logGroup: false | AwsServerlessObservabilityLogGroupArgs`

Log-group capability settings or false to disable log-group management.