Datadog 서버리스 CLI

CLI를 사용하여 Datadog으로 AWS 람다 함수를 계측할 수 있습니다. CLI는 기존 람다 함수의 설정을 수정하여 계측을 활성화하므로 재배치할 필요가 없습니다. Datadog 서버리스 모니터링을 시작하는 가장 빠른 방법입니다.

또한 CI/CD 파이프라인에 명령을 추가하여 모든 서버리스 애플리케이션에 대한 계측을 활성화할 수 있습니다. Datadog CLI 명령에 의해 변경된 내용이 재정의되지 않도록 일반 서버리스 애플리케이션 배포 후 명령을 실행합니다.

설치

datadog-ci lambda instrument 명령을 사용하여 람다 함수를 계측하려면 아래 나열된 특정 런타임에 대한 지침을 따르세요:

명령어

instrument

람다에 Datadog 계측을 적용하려면 datadog-ci lambda instrument를 실행합니다. 이 명령은 계측된 람다 함수에 Datadog 람다 라이브러리 및/또는 Datadog 람다 확장을 람다 레이어로 추가하고 설정을 수정합니다.


datadog-ci lambda instrument -f <function-name> -f <another-function-name> -r us-east-1 -v 81 -e 49

# Instrument multiple functions specified by full ARNs
datadog-ci lambda instrument -f <lambda-arn> -f <another-lambda-arn> -f <a-third-lambda-arn> -v 81 -e 49

# Instrument function(s) in interactive mode
datadog-ci lambda instrument -i

# Instrument multiple functions that match a regex pattern
datadog-ci lambda instrument --functions-regex <valid-regex-pattern> -r us-east-1 -v 81 -e 49

# Dry run of all updates
datadog-ci lambda instrument -f <function-name> -f <another-function-name> -r us-east-1 -v 81 -e 49 --dry-run

uninstrument

람다에서 Datadog 계측을 되돌리려면 datadog-ci lambda uninstrument를 실행하세요. 이 명령은 Datadog 람다 라이브러리 및 Datadog 람다 확장 레이어와 같은 Datadog 설정과 datadog-ci에 의해 적용된 다른 설정을 자동으로 제거합니다.

# Uninstrument multiple functions specified by names
datadog-ci lambda uninstrument -f <function-name> -f <another-function-name> -r us-east-1

# Uninstrument function(s) in interactive mode
datadog-ci lambda uninstrument -i

# Uninstrument multiple functions that match a regex pattern
datadog-ci lambda uninstrument --functions-regex <valid-regex-pattern> -r us-east-1

# Dry run of all updates
datadog-ci lambda uninstrument -f <function-name> -f <another-function-name> -r us-east-1 --dry-run

추가적인 세팅은 설정 섹션을 확인하세요.

설정

AWS 자격 증명

datadog-ci lambda 명령을 실행하는 람다와 클라우드와치(CloudWatch) 서비스에 대한 액세스 권한이 있는 유효한 AWS 자격 증명이 설정되어 있어야 합니다.

환경 변수

datadog-ci lambda instrument를 실행 중인 환경에서 다음과 같은 환경 변수를 노출해야 합니다:

환경 변수설명예시
DATADOG_API_KEYDatadog API 키입니다. 람다 함수 설정에서 DD_API_KEY 환경 변수를 설정합니다. Datadog API 키를 받는 방법에 대한 자세한 정보는 API 키 설명서를 참조하세요.export DATADOG_API_KEY=<API_KEY>
DATADOG_API_KEY_SECRET_ARNAWS 비밀 관리자에서 Datadog API 키를 저장하는 암호의 ARN입니다. 람다 함수 설정에서DD_API_KEY_SECRET_ARN를 설정합니다. 참고: DD_KMS_API_KEY를 설정하면 DD_API_KEY_SECRET_ARN는 무시됩니다. 람다 실행 역할에 secretsmanager:GetSecretValue 권한을 추가합니다.export DATADOG_API_KEY_SECRET_ARN=<SECRETS_MANAGER_RESOURCE_ARN>
DATADOG_KMS_API_KEYKMS를 사용하여 암호화된 Datadog API 키입니다. 람다 함수 설정에서 DD_KMS_API_KEY 환경 변수를 설정합니다. 참고: DD_KMS_API_KEY가 설정되면 DD_API_KEY는 무시됩니다.export DATADOG_KMS_API_KEY=<KMS_ENCRYPTED_API_KEY>
DATADOG_SITE데이터를 보낼 Datadog 사이트를 설정합니다. Datadog 람다 확장을 사용하는 경우에만 필요합니다. 가능한 값은datadoghq.com , datadoghq.eu, us3.datadoghq.com,us5.datadoghq.com , ap1.datadoghq.com 및 ddog-gov.com입니다. 기본값은 datadoghq.com입니다. 람다 함수 설정에서 DD_SITE 환경 변수를 설정합니다.export DATADOG_SITE="datadoghq.com"

인수

명령줄 인수 또는 JSON 설정 파일을 사용하여 설정할 수 있습니다 (다음 섹션 참조).

instrument

다음 인수를 instrument에 전달하여 동작을 지정할 수 있습니다. 이러한 인수는 설정 파일에 설정된 값이 있는 경우 재정의합니다.

ArgumentShorthand설명기본
--function-f계측할 람다 함수의 ARN 또는 람다 함수의 이름입니다 (--region을 정의해야 함).
--functions-regex람다 함수 이름과 일치할 정규식 패턴입니다.
--interactive-i사용자가 자신의 함수가 계측되는 방식을 대화형으로 선택할 수 있습니다. 대화형 모드를 사용하도록 선택하면 정보를 입력하라는 메시지가 표시되므로 다른 플래그를 제공할 필요가 없습니다.
--region-rARN 대신 함수 이름으로 --function을 지정할 때 사용할 기본 영역입니다.
--service여기서 --service to group related functions belonging to similar workloads. Learn more about the service 태그를 사용하세요.
--version여기서 --version tag to correlate spikes in latency, load or errors to new versions. Learn more about the version 태그를 추가하세요.
--env여기서 --env to separate out your staging, development, and production environments. Learn more about the env 태그를 사용하세요.
--extra-tagsDatadog에서 람다 함수에 커스텀 태그를 추가합니다. layer:api,team:intake와 같이 쉼표로 구분된 <key>:<value> 목록이어야 합니다.
--profile계측하는 데 사용할 AWS 명명 프로필 자격 증명을 지정하세요. 여기서 AWS 명명 프로필에 대한 자세한 내용을 알아보세요.
--layer-version-v적용할 Datadog 람다 라이브러리 레이어 버전입니다. 런타임 간 다양합니다 최신 레이어 버전을 보려면 JS 또는 파이썬 datadog-lambda-layer 리포지토리 릴리스 정보를 확인하세요.
--extension-version-e적용할 Datadog 람다 확장 레이어의 버전입니다. extension-version이 설정되면 환경에서도 DATADOG_API_KEY(암호화된 경우 DATADOG_KMS_API_KEY 또는 DATADOG_API_KEY_SECRET_ARN)를 내보내야 합니다. extension-version를 사용하는 동안 forwarder을 생략합니다. 여기서 람다 확장에 대해 자세히 알아보세요.
--tracing람다에 대한 dd-trace 추적을 활성화할지 여부입니다.true
--merge-xray-tracesdd-trace 트레이스를 AWS X-Ray 트레이스에 결합할지 여부입니다. API 게이트웨이 스팬을 추적하는 데 유용합니다.false
--flush-metrics-to-logsDatadog 포워더를 통해 비동기적으로 메트릭을 전송할지 여부입니다. 이 파라미터를 사용하지 않으면DATADOG_API_KEY를 내보내야 합니다 (또는 암호화된 경우, DATADOG_KMS_API_KEY 또는 DATADOG_API_KEY_SECRET_ARN).true
--capture-lambda-payload람다 호출의 페이로드 및 응답을 캡처하고 저장할지 여부입니다.false
--forwarder이 함수의 로그 그룹을 추가할 Datadog 포워더의 ARN입니다.
--dry-run-d실행 중인 변경 사항 미리보기 명령이 적용됩니다.false
--log-level문제 해결을 위해 Datadog 람다 라이브러리 및/또는 람다 확장에서 추가 출력을 확인하려면 debug로 설정하세요.
--source-code-integration-sDatadog 소스 코드 통합을 활성화할지 여부입니다. 이렇게 하면 람다에 Git 저장소 URL과 현재 로컬 디렉터리의 최신 커밋 해시로 태그가 지정됩니다. 참고: Git 리포지토리는 원격 리포지토리보다 앞에 있지 않아야 하며 클린 상태여야 합니다.true
--no-source-code-integrationDatadog 소스 코드 통합을 비활성화합니다.
--upload-git-metadata-u소스 코드 통합의 일부로 Git 메타데이터 업로드를 사용할지 여부입니다. Datadog Github 통합을 설치하지 않은 경우에만 Git 메타데이터 업로드가 필요합니다.true
--no-upload-git-metadata소스 코드 통합의 일부로 Git 메타데이터 업로드를 비활성화합니다. Datadog Github 통합을 설치한 경우 Git 메타데이터 업로드가 불필요하므로 이 플래그를 사용합니다.
--apm-flush-deadline밀리초에서 시간 초과하기 전에 기간을 제출할 시기를 결정하는 데 사용됩니다. AWS 람다 호출의 남은 시간이 설정된 값보다 작으면 추적기는 현재 활성 스팬(span)과 완료된 모든 스팬(span)을 제출하려고 시도합니다. NodeJS 및 파이썬(Python)에서 지원됩니다. 기본값은 100밀리초입니다.

uninstrument

다음 인수는 uninstrument에 전달되어 동작을 지정합니다. 이러한 인수는 설정 파일에 설정된 값이 있는 경우 재정의합니다.

instrument 표에 명시되어 있지만 아래에 있지 않은 다른 인수는 무시되므로 필요한 경우 더 빠르게 계측을 해제할 수 있습니다.

ArgumentShorthand설명기본
--function-f계측되지 않은 람다 함수의 ARN 또는 람다 함수의 이름입니다 (--region을 정의해야 함).
--functions-regex계측되지 않은 람다 함수 이름과 일치할 정규식 패턴입니다.
--region-rARN 대신 함수 이름으로 ‘–function’을 지정할 때 사용할 기본 영역입니다.
--profile계측을 해제하는 데 사용할 AWS 명명된 프로필 자격 증명을 지정합니다. 여기서 AWS 명명된 프로필에 대해 자세히 알아보세요.
--forwarder이 함수에서 제거할 datadog 포워더의 ARN입니다.
--dry-run-d실행 중인 변경 사항 미리보기 명령이 적용됩니다.false

설정 파일

인수를 제공하는 대신 프로젝트에서 설정 파일을 생성하고 각 배포에서 datadog-ci lambda {instrument|uninstrument} --config datadog-ci.json 명령을 실행합니다. --config 인수를 사용하여 datadog-ci.json를 지정하고 다음 설정 파일 구조를 사용합니다:

{
    "lambda": {
        "layerVersion": 10,
        "extensionVersion": 8,
        "functions": ["arn:aws:lambda:us-east-1:000000000000:function:autoinstrument"],
        "region": "us-east-1",
        "tracing": true,
        "mergeXrayTraces": true,
        "captureLambdaPayload": true,
        "forwarder": "arn:aws:lambda:us-east-1:000000000000:function:datadog-forwarder",
        "logLevel": "debug",
        "service": "some-service",
        "version": "b17s47h3w1n",
        "profile": "my-credentials",
        "environment": "staging",
        "extraTags": "layer:api,team:intake"
    }
}

람다 계측 트러블슈팅

람다 함수에서 Datadog 모니터링을 사용하는 데 문제가 발생해 트러블슈팅이 필요한 경우 프로젝트 디렉터리에서 datadog-ci lambda flare 명령을 실행합니다. 이 명령은 환경 변수 및 설정 파일 등 람다 함수에 대한 중요 데이터를 수집합니다. 이러한 파일은 제공된 Zendesk 사례 ID와 일치하는 티켓으로 Datadog 지원팀에 제출됩니다.

참고: 이 명령은 람다 함수가 datadog-ci lambda instrument를 사용해 계측되었는지 알려줍니다.

예시

# Collect and send files to Datadog support for a single function
datadog-ci lambda flare -f <function-arn> -c <case-id> -e <email-on-case-id>

# Include recent CloudWatch logs
datadog-ci lambda flare -f <function-name> -r <AWS region> -c <case-id> -e <email-on-case-id> --with-logs

# Dry run: collect data, but don't send to Datadog support
datadog-ci lambda flare -f <function-arn> -c <case-id> -e <email-on-case-id> --with-logs --dry-run

인수

ArgumentShorthand설명기본값
--function-f람다 함수의 ARN은 람다 함수의 이름 또는 데이터를 수집합니다(--region을 정의해야 함).
--region-rARN 대신 함수 이름으로 ‘–function’을 지정할 때 사용할 기본 영역입니다.
--case-id-c파일을 전송할 Datadog 사례 ID입니다.
--email-e지정된 사례 ID에 연결된 이메일입니다.
--with-logs지정된 함수에 대한 최신 클라우드와치(CloudWatch) 로그를 수집합니다.false
--start and --end시간 범위 내에서만 로그를 수집합니다(--with-logs를 포함해야 함). 양 인수는 Unix Epoch 이후 밀리초 단위의 숫자입니다.
--dry-run-dDatadog 지원팀에 전송될 미리 보기 수집 데이터입니다.false

커뮤니티

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

Icon/world Created with Sketch.   한국어
한국어 English Français 日本語
© Datadog 2024 이용 약관  |  개인 정보  |  쿠키
PREVIEWING: may/unit-testing