AWS Lambdaにおけるサーバレスエラーハンドリング(5)

今回は、実際にCloudWatch Logsに出力されたログをサブスクリプションして、Mattermostへメッセージ通知する環境を構築します。

CloudFormationを使用したLambda環境の構築／CloudWatchサブスリプションの設定

第8回で解説した手順で構築したLambdaテンプレートに、前回実装したLambdaファンクションを追加して、スタックを作成し直します。

AWSTemplateFormatVersion: '2010-09-09'

#omit

Resources:
  LambdaForSyncExecuteSystemErrorFuntion:
    Type: AWS::Lambda::Function
    Properties:
      Code:
        S3Bucket:
          Fn::ImportValue: debugroom-mynavi-sample-lambda-errorhandling-deploy-s3-bucket
        S3Key: spring-cloud-3-1-lambda-function-0.0.1-SNAPSHOT-aws.jar
      Handler: org.springframework.cloud.function.adapter.aws.FunctionInvoker::handleRequest
      FunctionName: mynavi-sample-aws-lambda-errorhandling-sync-system-error
      Environment:
        Variables:
          SPRING_CLOUD_FUNCTION_DEFINITION: syncExecuteSystemErrorFunction
      MemorySize: 1024
      Runtime: java11
      Timeout: 120
      Role: !GetAtt LambdaRole.Arn


  #omit

  LambdaForNotifySystemErrorFuntion:
    Type: AWS::Lambda::Function
    Properties:
      Code:
        S3Bucket:
          Fn::ImportValue: debugroom-mynavi-sample-lambda-errorhandling-deploy-s3-bucket
        S3Key: spring-cloud-3-1-lambda-function-0.0.1-SNAPSHOT-aws.jar
      Handler: org.springframework.cloud.function.adapter.aws.FunctionInvoker::handleRequest
      FunctionName: mynavi-sample-aws-lambda-errorhandling-notify-system-error
      Environment:
        Variables:
          SPRING_CLOUD_FUNCTION_DEFINITION: notifySystemErrorFunction
      MemorySize: 1024
      Runtime: java11
      Timeout: 120
      Role: !GetAtt LambdaRole.Arn

  #omit

Outputs:
  #omit

  LambdaForSyncExecuteSystemErrorFuntion:
    Description: Sync execute Lambda function for occuring system error function.
    Value: !Ref LambdaForSyncExecuteSystemErrorFuntion
    Export:
      Name: mynavi-sample-lambda-errorhandling-sync-execute-system-error-function-name

  LambdaForSyncExecuteSystemErrorFuntionArn:
    Description: Sync execute Lambda function for occuring system error function.
    Value: !GetAtt LambdaForSyncExecuteSystemErrorFuntion.Arn
    Export:
      Name: mynavi-sample-lambda-errorhandling-sync-execute-system-error-function-arn

  #omit

  LambdaForNotifySystemErrorFuntion:
    Description: Lambda function for notifying system error function.
    Value: !Ref LambdaForNotifySystemErrorFuntion
    Export:
      Name: mynavi-sample-lambda-errorhandling-notify-system-error-function-name

  LambdaForNotifiySystemErrorFuntionArn:
    Description: Lambda function for notifying system error function.
    Value: !GetAtt LambdaForNotifySystemErrorFuntion.Arn
    Export:
      Name: mynavi-sample-lambda-errorhandling-notify-system-error-function-arn

同様に、API Gatewayのテンプレートも、システムエラーが発生するファンクション向けにメソッドやリソースを定義して構築し直します。

#omit

ApiGatewaySystemExceptionResource:
  Type: "AWS::ApiGateway::Resource"
  Properties:
    RestApiId:
      Ref: ApiGatewayRestApi
    ParentId:
      Fn::GetAtt:
        - ApiGatewayRestApi
        - RootResourceId
    PathPart: "system-exception-sample-resource"

#omit

ApiGatewaySystemExceptionMethod:
  Type: "AWS::ApiGateway::Method"
  DependsOn: ApiGatewayModel
  Properties:
    RestApiId:
      Ref: ApiGatewayRestApi
    ResourceId:
      Ref: ApiGatewaySystemExceptionResource
    HttpMethod: "GET"
    AuthorizationType: "NONE"
    Integration:
      Type: "AWS_PROXY"
      Uri:
        Fn::Join:
          - ""
          - - "arn:aws:apigateway"
            - ":"
            - Ref: AWS::Region
            - ":"
            - "lambda:path/2015-03-31/functions/"
            - Fn::ImportValue: mynavi-sample-lambda-errorhandling-sync-execute-system-error-function-arn
            - "/invocations"
      IntegrationHttpMethod: "POST"
      PassthroughBehavior: WHEN_NO_MATCH
    MethodResponses:
      - StatusCode: 200
        ResponseModels:
          application/json: SampleSchema
      - StatusCode: 400
        ResponseModels:
          application/json: Error

SystemErrorLambdaPermission:
  Type: "AWS::Lambda::Permission"
  Properties:
    FunctionName:
      Fn::ImportValue: mynavi-sample-lambda-errorhandling-sync-execute-system-error-function-name
    Action: "lambda:InvokeFunction"
    Principal: "apigateway.amazonaws.com"

続いて、CloudWatchにサブスクリプションフィルタおよびロググループ、実行権限に関するテンプレートを実装します。

AWSTemplateFormatVersion: '2010-09-09'

#omit

Resources:
  CloudWatchLogsSyncExecuteSystemErrorSubscription:  #(1)
    Type: AWS::Logs::SubscriptionFilter
    Properties:
      LogGroupName: !Ref LogsGroupSyncExecuteSystemError
      FilterPattern: "Exception"                     #(2)
      DestinationArn:
        Fn::ImportValue: mynavi-sample-lambda-errorhandling-notify-system-error-function-arn #(3)

  LogsGroupSyncExecuteSystemError:
    Type: AWS::Logs::LogGroup
    Properties:
      LogGroupName:
        Fn::Join:
          - ""
          - - "/aws/lambda/"
            - Fn::ImportValue: mynavi-sample-lambda-errorhandling-sync-execute-system-error-function-name #(4)

  NotifyErrorLambdaPermission: #(5)
    Type: AWS::Lambda::Permission
    Properties:
      FunctionName:
        Fn::ImportValue: mynavi-sample-lambda-errorhandling-notify-system-error-function-name
      Action: lambda:InvokeFunction
      Principal: !Join [ ".", [ "logs", !Ref "AWS::Region", "amazonaws.com" ] ]
      SourceAccount: !Ref AWS::AccountId

上記のコードのポイントは以下の通りです。

これらのテンプレートを実行し、環境を構築します。また、本連載では説明は省略しますが、Mattermost環境の構築やWebhookの設定を行い^※、URLを「SystemsManager ParameterStore」に設定しておきます。なお、SystemsManager ParameterStoreの設定に関しては、連載「AWSで実践! 基盤構築・デプロイ自動化」の第29回などを適宜参考にしてください。

必要な環境を構築／設定後、第8回と同じ要領でAPI Gatewayからシステムエラーが発生するファンクションを実行すると、以下のようにAPI Gatewayからインターナルサーバエラーが返却されます。

※　Mattermost環境の構築やWebhookの設定については、公式サイトの「Installing Mattermost」や「Mattermost Integration Guide」を参照してください。

CloudWatch Logsには発生したエラーのスタックトレースが記録されます。

CloudWatch Logsのサブスクリプションが別途Lambdaファンクションを呼び出し、Mattermost側へエラー内容を通知します。システム管理者や運用担当者は、エラーの内容を確認して、AWSの外で優先度を設定し、対応することができます。

*　*　*

今回は、API GatewayとLambdaを使用した同期呼び出しでシステムエラーが発生した際に、CloudWatchに出力されたエラーログを契機として、システム管理者へ通知を行うLambdaファンクション実装について解説しました。

次回は、S3などのマネージドサービスから非同期に実行されるLambdaファンクション内で発生したエラーのハンドリングについて解説を進めていきます。