Datadog는 AWS SAM을 사용하여 서버리스 애플리케이션을 배포하는 고객에게 서버리스 CloudFormation 매크로를 권장합니다.

매크로는 다음과 같은 방법으로 서버리스 애플리케이션에서 메트릭, 트레이스 및 로그 수집을 자동으로 설정합니다:

• 파이썬(Python)]1, Node.js, .NET, 자바(Java) 람다 함수를 위한 Datadog 람다 라이브러리 및 람다 확장 프로그램을 설치하고 설정하세요.
• 람다 함수에서 향상된 람다 메트릭 및 커스텀 메트릭 수집을 활성화합니다.
• 원하는 경우 Datadog 포워더(Forwarder)에서 람다 함수 로그 그룹으로의 구독을 관리합니다.

설치

Datadog 서버리스 매크로를 AWS 계정에서 사용하려면 Datadog에서 제공하는 템플릿을 사용하여 CloudFormation 스택을 배포합니다. 이 배포에는 CloudFormation 매크로 리소스 및 매크로가 실행될 때 호출되는 람다 함수가 포함됩니다. 이 스택을 배포하면 동일한 계정에 배포된 다른 CloudFormation 스택에서 매크로를 사용할 수 있습니다. 계정에서 매크로를 정의하는 방법에 대한 자세한 내용은 CloudFormation 설명서 페이지를 참조하세요.

참고: Datadog 서버리스 매크로는 변환할 스택이 포함된 각 영역에 한 번씩 생성해야 합니다.

옵션 1: AWS Console

위의 Launch Stack 템플릿 링크를 사용하여 AWS 계정에서 Datadog 서버리스 매크로 스택을 만듭니다.

옵션 2: AWS CLI

처음 설치하는 경우 다음과 함께 배포합니다:

aws cloudformation create-stack \
  --stack-name datadog-serverless-macro \
  --template-url https://datadog-cloudformation-template.s3.amazonaws.com/aws/serverless-macro/latest.yml \
  --capabilities CAPABILITY_AUTO_EXPAND CAPABILITY_IAM

AWS SAM과 함께 사용

SAM을 사용하여 서버리스 애플리케이션을 배포하려면 필요한 SAM 변환 후 template.yml 파일의 Transform섹션 아래에 Datadog 서버리스 CloudFormation 매크로를 추가합니다. 또한 Datadog 소스 코드 통합을 활성화하려면 DDGitData 파라미터를 추가하고 매크로에 전달합니다:

Transform:
  - AWS::Serverless-2016-10-31
  - Name: DatadogServerless
    Parameters:
      stackName: !Ref "AWS::StackName"
      apiKey: "<DATADOG_API_KEY>"
      pythonLayerVersion: "<LAYER_VERSION>" # Use appropriate parameter for other runtimes
      extensionLayerVersion: "<LAYER_VERSION>"
      service: "<SERVICE>" # Optional
      env: "<ENV>" # Optional
      version: "<VERSION>" # Optional
      tags: "<TAGS>" # Optional
      # Pass DDGitData here to enable Source Code Integration tagging
      gitData: !Ref DDGitData
      # For additional parameters, see the Configuration section

Parameters:
  DDGitData:
    Type: String
    Default: ""
    Description: "The output of $(git rev-parse HEAD),$(git config --get remote.origin.url). Used for Datadog Source Code Integration tagging"

Datadog의 소스 코드 통합에 대한 DDGitData 파라미터를 설정하려면 SAM의 --parameter-overrides 옵션을 사용합니다:

sam deploy --parameter-overrides  DDGitData="$(git rev-parse HEAD),$(git config --get remote.origin.url)"

참고: 매크로를 설치할 때 제공된 template.yml 파일을 수정하지 않은 경우 계정에 정의된 매크로의 이름은 DatadogServerless입니다. 원본 템플릿을 수정한 경우 여기에 추가하는 변환의 이름이 AWS::CloudFormation::Macro 리소스의 Name 속성과 일치하는지 확인합니다.

참고: 일부 설정을 한 번만 지정하려는 경우 template.yml를 수정하고 해당 영역에 설정할 환경 변수를 추가할 수 있습니다. 이것은 추가 기본값을 제어하는 방법입니다. 아래 예시에서는 DD_API_KEY_SECRET_ARN 및 DD_ENV를 설정하고, 이를 매크로가 기본값으로 처리합니다:

리소스:
  MacroFunction:
    유형: AWS::서버리스::기능/함수
    DependsOn: MacroFunctionZip
    속성:
      FunctionName:
        Fn::If:
          - SetFunctionName
          - 참조: 함수 이름
          - 참조: AWS::NoValue
      설명: 프로세스 Lambda용 Datadog Lambda 레이어를 설치하기 위한 CloudFormation 템플릿 기능/함수.
      핸들러: src/index.handler
      ...
     환경:
        변수:
          DD_API_KEY_SECRET_ARN: "arn:AWS:secretsmanager:us-west-2:123456789012:secret:DdApiKeySecret-e1v5Yn7TvIPc-d1Qc4E"
          DD_ENV: "dev"

업데이트

새 릴리스 후 매크로를 업데이트하는 경우 다음 update-stack 방법을 사용합니다:

aws cloudformation update-stack \
  --stack-name datadog-serverless-macro \
  --template-url https://datadog-cloudformation-template.s3.amazonaws.com/aws/serverless-macro/latest.yml \
  --capabilities CAPABILITY_AUTO_EXPAND CAPABILITY_IAM

또한 0.1.2.yml와 같이 릴리스 버전을 latest.yml로 대체함으로써 최신 릴리스에서 매크로 버전을 지정할 수도 있습니다.

설정

플러그인을 추가로 설정하려면 다음 커스텀 파라미터를 사용합니다:

작동 방식

이 매크로는 Node.js, 파이썬(Python), .NET, 자바(Java)에 대한 람다 레이어를 함수에 첨부하여 Datadog 람다 라이브러리를 설치하도록 CloudFormation 템플릿을 수정합니다. 필요한 코드 변경 없이 람다 라이브러리를 초기화하는 대체 핸들러로 리디렉션됩니다.

트러블슈팅

디버그 로그

문제를 디버깅하는 데 도움이 되도록 매크로 람다 함수에 대한 CloudWatch 로그를 살펴볼 수 있습니다. CloudWatch 로그를 찾으려면 다음과 같이 하세요:

• 매크로 CloudFormation 스택을 찾습니다 (지침에 따라 명령을 복사한 경우 datadog-serverless-macro 이름 지정).
• 리소스 탭을 클릭하면 CloudWatch 로그 그룹을 Logical ID MacroFunctionLogGroup와 함께 사용할 수 있습니다

오류 메시지: ‘FunctionName’ property is undefined for…

이 오류는 forwarderArn를 제공하고 람다 함수를 처음 배포할 때 발생하므로 로그 그룹이 존재하지 않으며 매크로가 이 로그 그룹을 만들거나 포워더를 구독할 수 없습니다. 이 문제를 해결하기 위해 람다에 FunctionName 속성을 명시적으로 정의하세요 (아래 예시 참조).

Resources:
  MyLambda:
    Type: AWS::Serverless::Function
    Properties:
      Handler: index.handler
      Runtime: nodejs12.x
      FunctionName: MyFunctionName # Add this property to your Lambdas

FunctionName를 명시적으로 정의할 수 없거나 (원하지 않는 경우) SAM 템플릿 또는 CDK 소스 코드에서 forwarderArn 파라미터를 제거한 후 아래와 같이 AWS::Logs::SubscriptionFilter 리소스를 사용하여 구독 필터를 정의합니다.

Resources:
  MyLogSubscriptionFilter:
    Type: "AWS::Logs::SubscriptionFilter"
    Properties:
      DestinationArn: "<DATADOG_FORWARDER_ARN>"
      LogGroupName: "<CLOUDWATCH_LOG_GROUP_NAME>"
      FilterPattern: ""

오류 메시지: ’logGroupNamePrefix’ failed to satisfy constraint…

!Sub와 같이 FunctionName가 CloudFormation 함수를 포함한 경우에는 forwarderArn 옵션이 작동하지 않습니다. 이 경우 매크로는 실제 함수 이름에 액세스할 수 없습니다 (CloudFormation은 변환 후 함수를 실행합니다). 따라서 함수에 대한 로그 그룹 및 구독 필터를 생성할 수 없습니다.

SAM 템플릿 또는 CDK 소스 코드에서 forwarderArn 파라미터를 제거하고 아래와 같이 AWS::Logs::SubscriptionFilter 리소스를 사용하여 구독 필터를 정의합니다.

Resources:
  MyLogSubscriptionFilter:
    Type: "AWS::Logs::SubscriptionFilter"
    Properties:
      DestinationArn: "<DATADOG_FORWARDER_ARN>"
      LogGroupName: "<CLOUDWATCH_LOG_GROUP_NAME>"
      FilterPattern: ""

오류 메시지: ‘Failed to execute transform DatadogServerless’

이 오류는 명령을 실행하는 IAM 사용자에게 lambda:InvokeFunction 권한이 없는 경우 발생할 수 있습니다. 사용자의 IAM 역할에 권한을 추가합니다.

커뮤니티

제품 피드백 및 질문이 있는 경우 슬랙의 Datadog 커뮤니티의 #serverless 채널에 가입하세요.