데이터 소스에 대한 사용자 지정 커넥터 생성

이 주제에서는 CloudWatch에 사용자 지정 데이터 소스를 연결하는 방법을 설명합니다. 다음 두 가지 방법으로 CloudWatch에 사용자 지정 데이터 소스를 연결할 수 있습니다.

템플릿 사용

템플릿을 사용하면 샘플 Lambda 함수가 생성되므로 사용자 지정 커넥터를 더 빨리 구축할 수 있습니다. 이러한 샘플 함수는 사용자 지정 커넥터 구축과 관련된 여러 일반적인 시나리오에 대한 샘플 코드를 제공합니다. 템플릿을 사용하여 커넥터를 생성한 후 Lambda 코드를 검사한 다음, 이를 수정하여 데이터 소스에 연결하는 데 사용할 수 있습니다.

또한 템플릿을 사용하는 경우 CloudWatch가 Lambda 권한 정책을 생성하고 Lambda 함수에 리소스 태그를 연결합니다.

처음부터 사용자 지정 데이터 소스 생성

이 섹션의 단계에 따라 데이터 소스에 CloudWatch를 연결하는 Lambda 함수를 생성합니다.

1단계: 함수 생성

사용자 지정 데이터 소스 커넥터는 CloudWatch의 GetMetricData 이벤트를 지원해야 합니다. 필요에 따라 DescribeGetMetricData 이벤트를 구현하여 CloudWatch 콘솔에서 커넥터 사용 방법에 대한 설명서를 사용자에게 제공할 수도 있습니다. DescribeGetMetricData 응답을 사용하여 CloudWatch 사용자 지정 쿼리 작성기에 사용되는 기본값을 설정할 수도 있습니다.

CloudWatch는 시작하는 데 도움이 되는 코드 조각을 샘플로 제공합니다. 자세한 내용은 https://github.com/aws-samples/cloudwatch-data-source-samples의 샘플 리포지토리를 참조하세요.

제약 조건

GetMetricData 이벤트

요청 페이로드

다음은 Lambda 함수에 입력으로 전송된 GetMetricData 요청 페이로드의 예제입니다.

{
  "EventType": "GetMetricData",
  "GetMetricDataRequest": {
    "StartTime": 1697060700,
    "EndTime": 1697061600,
    "Period": 300,
    "Arguments": ["serviceregistry_external_http_requests{host_cluster!=\"prod\"}"] 
  }
}

응답 페이로드

다음은 Lambda 함수에서 반환하는 GetMetricData 응답 페이로드의 예제입니다.

{
   "MetricDataResults": [
      {
         "StatusCode": "Complete",
         "Label": "CPUUtilization",
         "Timestamps": [ 1697060700, 1697061000, 1697061300 ],
         "Values": [ 15000, 14000, 16000 ]
      }
   ]
}

응답 페이로드는 MetricDataResults 필드 또는 Error 필드 중 하나를 포함하되 두 필드 모두를 포함하지는 않습니다.

MetricDataResults 필드는 MetricDataResult 유형의 시계열 필드 목록입니다. 각 시계열 필드는 다음 필드를 포함할 수 있습니다.

Error 객체에 대한 자세한 내용은 다음 섹션을 참조하세요.

오류 응답 형식

필요에 따라 오류 응답을 사용하여 오류에 대한 자세한 정보를 제공할 수 있습니다. 파라미터가 누락되었거나 유형이 잘못된 경우와 같이 검증 오류가 발생하는 경우 코드 검증을 통해 오류를 반환하는 것이 좋습니다.

다음은 Lambda 함수가 GetMetricData 검증 예외를 발생시키려고 할 때 응답의 예제입니다.

{
   "Error": {
      "Code": "Validation",
      "Value": "Invalid Prometheus cluster"
   }
}

다음은 Lambda 함수가 액세스 문제로 인해 데이터를 반환할 수 없다고 표시할 때의 응답 예제입니다. 응답은 상태 코드가 Forbidden인 단일 시계열로 변환됩니다.

{
   "Error": {
      "Code": "Forbidden",
      "Value": "Unable to access ..."
   }
}

다음은 Lambda 함수가 전체 InternalError 예외를 발생시키는 예로, 상태 코드가 InternalError이고 메시지가 있는 단일 시계열로 변환됩니다. CloudWatch는 오류 코드에 Validation 또는 Forbidden 이외의 값이 있을 때마다 일반적인 내부 오류로 간주합니다.

{
   "Error": {
      "Code": "PrometheusClusterUnreachable",
      "Value": "Unable to communicate with the cluster"
   }
}

DescribeGetMetricData 이벤트

요청 페이로드

다음은 DescribeGetMetricData 요청 페이로드의 예제입니다.

{
  "EventType": "DescribeGetMetricData"
}

응답 페이로드

다음은 DescribeGetMetricData 응답 페이로드의 예제입니다.

{
    "Description": "Data source connector",
    "ArgumentDefaults": [{
        Value: "default value"
     }]
}

CloudWatch 경보에 대한 중요 고려 사항

데이터 소스를 사용하여 CloudWatch 경보를 설정하려는 경우 1분마다 타임스탬프가 있는 데이터를 CloudWatch에 보고하도록 설정해야 합니다. 연결된 데이터 소스의 지표에 대한 경보를 생성하는 방법에 대한 자세한 내용과 기타 고려 사항은 연결된 데이터 소스를 기반으로 경보 생성 섹션을 참조하세요.

(선택 사항) AWS Secrets Manager를 사용하여 보안 인증 저장

Lambda 함수가 보안 인증을 사용하여 데이터 소스에 액세스해야 하는 경우 Lambda 함수에 보안 인증을 하드코딩하는 대신 AWS Secrets Manager를 사용하여 보안 인증을 저장하는 것이 좋습니다. Lambda에서 AWS Secrets Manager를 사용하는 방법에 대한 자세한 내용은 AWS Lambda 함수에서 AWS Secrets Manager 보안 암호 사용을 참조하세요.

(선택 사항) VPC의 데이터 소스에 연결

데이터 소스가 Amazon Virtual Private Cloud에서 관리하는 VPC에 있는 경우 이에 액세스하려면 Lambda 함수를 구성해야 합니다. 자세한 내용은 아웃바운드 네트워킹을 VPC의 리소스에 연결을 참조하세요.

AWS Secrets Manager와 같은 서비스에 액세스하려면 VPC 서비스 엔드포인트를 구성해야 할 수도 있습니다. 자세한 내용은 인터페이스 VPC 엔드포인트를 사용하여 AWS 서비스에 액세스를 참조하세요.

2단계: Lambda 권한 정책 생성

생성한 Lambda 함수를 사용할 수 있는 권한을 CloudWatch에 부여하는 정책 설명 생성을 사용해야 합니다. AWS CLI 또는 Lambda 콘솔을 사용하여 정책 설명을 생성할 수 있습니다.

3단계: Lambda 함수에 리소스 태그 연결

CloudWatch 콘솔은 태그를 사용하여 어떤 Lambda 함수가 데이터 소스 커넥터인지 결정합니다. AWS CloudFormation 마법사 중 하나를 사용하여 데이터 소스를 생성하면 이를 구성하는 스택에 의해 태그가 자동으로 적용됩니다. 데이터 소스를 직접 생성할 때 Lambda 함수에 다음 태그를 사용할 수 있습니다. 이렇게 하면 지표를 쿼리할 때 CloudWatch 콘솔의 데이터 소스 드롭다운에 커넥터가 표시됩니다.