실패한 워크플로 호출에 대한 알림 구성

이 문서에서는 로그 탐색기를 사용하여 실패한 Dataform 워크플로 호출에 대한 로그 기반 알림을 구성하는 방법을 보여줍니다.

Cloud Monitoring을 사용하여 Dataform 워크플로 호출의 Cloud Logging 로그 추세를 관찰하고 사용자가 설명한 조건이 발생할 때 알림을 받을 수 있습니다.

각 Dataform 워크플로 호출은 Cloud Logging을 사용하여 로깅됩니다. 로깅은 Dataform 워크플로 호출에 자동으로 사용 설정되며, Cloud Logging 청구 요금이 발생할 수 있습니다. 자세한 내용은 Dataform 가격 책정을 참조하세요.

Dataform 워크플로 호출이 실패할 때 알림을 받으려면 로그 기반 알림을 만들면 됩니다.

Google Cloud 콘솔의 로그 탐색기 페이지에서 또는 Monitoring API를 사용하여 로그 기반 알림을 생성할 수 있습니다. 이 가이드에서는 로그 탐색기를 사용하여 Dataform 워크플로 호출 실패에 대한 로그 기반 알림을 만드는 방법을 설명합니다.

시작하기 전에

로그 기반 알림을 만들고 관리하려면 Identity and Access Management 역할에 로그 기반 알림 권한에 설명된 권한이 포함되어야 합니다.

실패한 Dataform 워크플로 호출에 대한 로그 기반 알림 구성

실패한 Dataform 워크플로 호출에 대한 로그 기반 알림을 구성하려면 다음 단계를 따르세요.

  1. Google Cloud Console에서 Logging을 선택한 후 로그 탐색기를 선택합니다.

    로그 탐색기로 이동

  2. 쿼리 창에서 쿼리 표시를 선택하고 다음 쿼리를 입력합니다.

        resource.type="dataform.googleapis.com/Repository"
        jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
        jsonPayload.terminalState="FAILED"
     

    이 쿼리는 실패한 모든 Dataform 워크플로 호출을 알려줍니다.

    1. 선택사항: 출시 구성을 기준으로 실패한 워크플로 호출을 필터링하려면 쿼리에 다음을 추가합니다.

      jsonPayload.releaseConfigId="RELEASE_CONFIGURATION_ID"
      
    2. 선택사항: 워크플로 구성을 기준으로 실패한 워크플로 호출을 필터링하려면 쿼리에 다음을 추가합니다.

      jsonPayload.workflowConfigId="WORKFLOW_CONFIGURATION_ID"
      

    다음 쿼리는 daily 출시 구성 및 production 워크플로 구성과 관련된 Dataform 워크플로 호출이 실패할 경우 알림을 제공합니다.

     resource.type="dataform.googleapis.com/Repository"
     jsonPayload.@type="type.googleapis.com/google.cloud.dataform.logging.v1.WorkflowInvocationCompletionLogEntry"
     jsonPayload.terminalState="FAILED"
     jsonPayload.releaseConfigId="daily"
     jsonPayload.workflowConfigId="production"
    
  3. 선택사항: 쿼리 결과 창에서 쿼리 실행을 사용하여 쿼리를 검증합니다.

  4. 쿼리 결과 창의 헤더에서 알림 만들기를 클릭합니다. 창이 좁을 경우 알림 만들기 옵션이 작업 메뉴에 대신 표시될 수 있습니다.

  5. 알림 세부정보 창에서 알림 이름과 설명을 지정합니다.

    1. 알림 이름 입력란에 알림 이름을 입력합니다. 예를 들면 'Dataform: 워크플로 실패'라고 입력합니다.

    2. 해당 알림에 대한 설명을 입력합니다. 알림 수신자가 문제를 진단하는 데 도움이 되는 정보를 포함할 수도 있습니다. 다음 문자열은 알림이 표시된 이유를 요약해서 보여줍니다.

      Log-based alert in project ${project} detected a failed Dataform workflow.
      

      이 필드의 콘텐츠 형식 지정 및 맞춤설정 방법에 대한 상세 내용은 문서 템플릿에서 마크다운 및 변수 사용을 참조하세요.

  6. 다음 단계로 이동하려면 다음을 클릭하세요.

  7. 알림에서 포함할 로그 선택 창에서 미리보기 로그를 클릭하여 쿼리와 결과를 확인합니다.

    로그 탐색기 쿼리 창에서 쿼리를 빌드하는 것을 권장합니다. 쿼리 창에서 빌드한 쿼리도 이 창에 표시됩니다.

    필요한 경우 이 창에서 쿼리를 수정할 수 있습니다. 쿼리를 수정하는 경우 로그 미리보기를 클릭하여 결과를 확인합니다.

  8. 다음을 클릭합니다.

  9. 알림 사이의 최소 시간을 선택합니다. 이 값을 사용하면 알림이 여러 번 트리거될 때 이 알림으로부터 받는 알림 수를 컨트롤할 수 있습니다. 이 예시에서는 옵션에서 5분을 선택합니다.

  10. 선택사항: 이슈 자동 종료 기간을 선택합니다. 기본적으로 이슈 자동 종료 기간은 7일로 설정됩니다.

  11. 다음을 클릭합니다.

  12. 알림을 받을 알림 채널을 하나 이상 선택하세요. 이 예시에서는 이메일 알림 채널을 선택합니다.

    이메일 알림 채널이 이미 구성되어 있으면 목록에서 선택할 수 있습니다. 그렇지 않으면 알림 채널 관리를 클릭하고 이메일 채널을 추가합니다. 알림 채널 만들기에 대한 자세한 내용은 알림 채널 관리를 참조하세요.

  13. 저장을 클릭합니다.

이제 로그 기반 알림을 테스트할 수 있습니다. 알림을 테스트하는 방법에 대한 안내는 예시 로그 기반 알림 테스트를 참조하세요.

다음 단계