CloudFormationを使用して、Lambda Insightを有効化する

CloudFormationを使用して、Lambda Insightを有効化する
構築する環境
CloudFormationテンプレートファイル
テンプレートファイルのポイント解説
1. Lambda
2. EventBridge
環境構築
1. CloudFormationスタックを作成し、スタック内のリソースを確認する
2. 動作確認
まとめ

CloudFormationを使用して、Lambda Insightを有効化する

AWS DVAの出題範囲の1つでもある、モニタリング・トラブルシューティングに関する内容です。

LambdaおよびCloudWatchが提供する機能の1つにLambda Insightsがあります。

CloudWatch Lambda Insights は、で実行されているサーバーレスアプリケーション用のモニタリングおよびトラブルシューティングソリューションですAWS Lambda このソリューションでは、CPU 時間、メモリ、ディスク、ネットワーク使用率などのシステムレベルのメトリクスが収集、集約、要約されます。
Amazon CloudWatch での Lambda Insights の使用

本ページでは、以下のページを参考に、CloudFormationを使用して、Lambda Insightsを有効化したLambda関数を作成する方法を確認します。

既存の Lambda 関数で Lambda Insights を有効にするために AWS CloudFormation を使用する - Amazon CloudWatch

AWS CloudFormation を使用して、既存の Lambda 関数で Lambda Insights を有効にするには、次の手順に従います。

AWSの登竜門として人気のSAAですが、残念ながら、取得できれば即戦力になれるというわけではありません。

やはり手を動かすことで、真の理解が得られます。

SAA取得済みの方であれば、以下のコンテンツに沿って理解を再確認することがオススメです。

【AWS初心者向け】手を動かして身につける！実戦で役立つAWSサービスの基礎とアーキテクチャ(SAAレベル)

多くの実績のあるServerworksさんのコンテンツなので安心です。

構築する環境

Diagram of enabling Lambda Insight using CloudFormation

AWSを理解するためには、手を動かしてアウトプットすることが大切です。座学によるインプットに偏った資格勉強では、パフォーマンスが高まりません。

いざ何か作ってみようとしても、無数にあるサービスのどこから手をつけたらいいのか途方に暮れている方もいると思います。
以下のコンテンツは、資格取得を目指している方にオススメです。

AWS：ゼロから実践するAmazon Web Services。手を動かしながらインフラの基礎を習得

3つのLambda関数を作成します。

各関数にLambdaレイヤーを関連付けます。
これはLambda Insightsを有効化するために必要な手順です。

同様に、各関数にIAMロールを関連付けます。
こちらもLambda Insightsを動作させるために必要です。

Lambda Insightsによって収集されたメトリクスは、CloudWatchに保存されます。

CloudFormationテンプレートファイル

上記の構成をCloudFormationで構築します。
以下のURLにCloudFormationテンプレートを配置しています。

awstut-dva/05/004 at main · awstut-an-r/awstut-dva

Contribute to awstut-an-r/awstut-dva development by creating an account on GitHub.

資格取得を目指して学習された方が、次のステップのために何をしたらいいか悩んでしまうという話を聞きます。

ぜひAWSを使ってWebアプリを開発してみてください。
手を動かそうとすると、資格勉強だけでは理解が不十分だったことに気づけると思います。

AWSで初めてのWebアプリを作るのでしたら、以下のコンテンツがオススメです。

AWSで作るWEBアプリケーション実践講座

丁寧な構成で、初心者の方でも安心です。

テンプレートファイルのポイント解説

Lambda

関数1

Resources:
  Function1:
    Type: AWS::Lambda::Function
    Properties:
      Architectures:
        - !Ref Architecture
      Code:
        ZipFile: |
          import datetime
          
          def lambda_handler(event, context):
            print('awstut!')
            return {
              'statusCode': 200,
              'body': str(datetime.datetime.now())
            }
      FunctionName: !Sub "${Prefix}-function1"
      Handler: !Ref Handler
      Layers:
        - !Ref LambdaInsightsLayer
      MemorySize: !Ref MemorySize
      Runtime: !Ref Runtime
      Role: !GetAtt FunctionRole.Arn
      Timeout: !Ref Timeout
      
  FunctionUrl:
    Type: AWS::Lambda::Url
    Properties:
      AuthType: NONE
      TargetFunctionArn: !GetAtt Function1.Arn
      
  FunctionUrlPermission:
    Type: AWS::Lambda::Permission
    Properties:
      Action: lambda:InvokeFunctionUrl
      FunctionName: !GetAtt Function1.Arn
      FunctionUrlAuthType: NONE
      Principal: "*"
Code language: YAML (yaml)

Lambda Insightsを有効化する上でのポイントは、Lambdaレイヤーです。

Lambda Insights は、Lambda レイヤーとして提供される新しい CloudWatch Lambda 拡張機能を使用します。この拡張機能を、サポートされているランタイムで、Lambda 関数で有効にすると、システムレベルのメトリクスが収集され、その Lambda 関数の呼び出しごとに 1 つのパフォーマンスログイベントが発生します。
Lambda Insights によるサーバーレスアプリケーションのモニタリング方法

Lambda Insightsを有効化するために使用するべきLambdaレイヤーは、関数をデプロイするリージョンおよびアーキテクチャに依存します。
詳細は以下のページをご確認いただきたいのですが、例えば本環境(東京リージョン、ARM64)ですと、以下を選択します。

Lambda Insights 拡張機能の利用可能なバージョン - Amazon CloudWatch

このセクションでは、Lambda Insights 拡張機能のバージョンと、各 AWS リージョンでこれらの拡張機能に使用する ARN の一覧を示します。

arn:aws:lambda:ap-northeast-1:580247275435:layer:LambdaInsightsExtension-Arm64:2

上記の文字列をLayersプロパティに指定します。

Lambda関数で実行するコードをインライン表記で定義します。
詳細につきましては、以下のページをご確認ください。

コードの内容ですが、関数を実行した日時を返します。

またprint関数を使って、文字列を出力させます。
これは後述のテキストログに出力先を確認するためです。

本関数はFunction URLを有効化します。
本機能を有効化すると、HTTPSエンドポイントが生成され、URLにアクセスすると、本関数が実行できます。
Function URLに関する詳細は、以下のページをご確認ください。

AWSを扱う上で、Lambdaは最も使用されるサービスの1つです。Lambdaへの理解が、AWS力の向上に繋がります。

Lambdaに関して体系的に学びたい方には、以下のコンテンツがオススメです。

AWS Lambda / Serverless Framework 速習ハンズオン

関数2

Resources:
  Function2:
    Type: AWS::Lambda::Function
    Properties:
      Architectures:
        - !Ref Architecture
      Environment:
        Variables:
          FUNCTION_URL: !GetAtt FunctionUrl.FunctionUrl
      Code:
        ZipFile: |
          import json
          import os
          import urllib.request
          
          function_url = os.environ['FUNCTION_URL']
          limit = 5
          
          def lambda_handler(event, context):
            responses = [urllib.request.urlopen(function_url).read().decode("utf-8") for i in range(limit)]
            
            return {
              'statusCode': 200,
              'body': json.dumps(responses, indent=2)
            }
      FunctionName: !Sub "${Prefix}-function2"
      Handler: !Ref Handler
      Layers:
        - !Ref LambdaInsightsLayer
      MemorySize: !Ref MemorySize
      Runtime: !Ref Runtime
      Role: !GetAtt FunctionRole.Arn
      Timeout: !Ref Timeout
Code language: YAML (yaml)

先述の関数1を5回呼び出す内容です。

Lambda Insightsを有効化するために、先述のLambdaレイヤーを使用するように設定します。

関数3

Resources:
  Function3:
    Type: AWS::Lambda::Function
    Properties:
      Architectures:
        - !Ref Architecture
      Code:
        ZipFile: |
          def lambda_handler(event, context):
            while True:
              pass
      FunctionName: !Sub "${Prefix}-function3"
      Handler: !Ref Handler
      Layers:
        - !Ref LambdaInsightsLayer
      MemorySize: !Ref MemorySize
      Runtime: !Ref Runtime
      Role: !GetAtt FunctionRole.Arn
      Timeout: !Ref Timeout
Code language: YAML (yaml)

while文で空のループを繰り返す内容です。
タイムアウトを過ぎるまで繰り返し、関数の実行に失敗して終了します。

Lambda Insightsを有効化するために、先述のLambdaレイヤーを使用するように設定します。

IAMロール

Resources:
  FunctionRole:
    Type: AWS::IAM::Role
    DeletionPolicy: Delete
    Properties:
      AssumeRolePolicyDocument:
        Version: 2012-10-17
        Statement:
          - Effect: Allow
            Action: sts:AssumeRole
            Principal:
              Service:
                - lambda.amazonaws.com
      ManagedPolicyArns:
        - arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole
        - arn:aws:iam::aws:policy/CloudWatchLambdaInsightsExecutionRolePolicy
Code language: YAML (yaml)

Lambda Insightsを有効化する上で、もう1つのポイントは、IAMロールです。

CloudWatchLambdaInsightsExecutionRolePolicy IAM ポリシーを関数実行ロールに追加します。
既存の Lambda 関数で Lambda Insights を有効にするために AWS CloudFormation を使用する

加えて、AWS管理ポリシーAWSLambdaBasicExecutionRoleをアタッチします。
これはCloudWatch Logsにテキストログを配信するために必要な権限を与えるものです。

EventBridge

Resources:
  Rule1:
    Type: AWS::Events::Rule
    Properties: 
      Name: !Sub "${Prefix}-EventsRule-01"
      ScheduleExpression: rate(1 minute)
      State: ENABLED
      Targets: 
        - Arn: !Ref FunctionArn1
          Id: !Ref Function1

  EventsRulePermission1: 
    Type: AWS::Lambda::Permission
    Properties: 
      FunctionName: !Ref Function1
      Action: lambda:InvokeFunction
      Principal: events.amazonaws.com
      SourceArn: !GetAtt Rule1.Arn
Code language: YAML (yaml)