BigQuery Data Transfer Service 실행 알림

이 페이지에서는 BigQuery Data Transfer Service의 실행 알림 개요를 설명합니다.

개요

BigQuery Data Transfer Service에서는 다음 2가지 유형의 실행 알림을 구성할 수 있습니다.

• Pub/Sub 알림: 시스템이 읽을 수 있는 알림으로써 전송 실행 성공 또는 실패 시 전송됩니다
• 이메일 알림: 전송 실행 실패 시 사람이 읽을 수 있는 알림이 전송됩니다.

각 유형을 개별적으로 구성하거나 Pub/Sub 알림과 이메일 실행 알림을 모두 사용할 수도 있습니다.

Pub/Sub 알림

Pub/Sub 알림은 전송 실행에 대한 정보를 Pub/Sub 주제로 전송합니다. Pub/Sub 알림은 다음 상태로 완료된 전송 실행에 의해 트리거됩니다.

• SUCCEEDED
• FAILED
• CANCELLED

프로젝트에 대한 권한이 충분한 경우 어떤 Pub/Sub 주제에도 알림을 전송할 수 있습니다. Pub/Sub 주제로 수신된 후에는 결과 메시지를 모든 주제 구독자에게 전송할 수 있습니다.

시작하기 전에

Pub/Sub 전송 실행 알림을 구성하기 전에 다음 내용을 수행해야 합니다.

1. 알림을 수신할 프로젝트에서 Pub/Sub API를 사용 설정합니다.

   API 사용 설정

2. 알림을 수신할 프로젝트에서 충분한 권한이 있어야 합니다.

   • 알림을 수신할 프로젝트를 소유하고 있다면 필요한 권한을 가지고 있을 가능성이 높습니다.

   • 알림을 수신할 주제를 만들려면 pubsub.topics.create 권한이 있어야 합니다.

   • 신규 또는 기존 주제 중 무엇을 사용하더라도 pubsub.topics.getIamPolicy 및 pubsub.topics.setIamPolicy 권한이 있어야 합니다. 주제를 만들면 일반적으로 주제에 대한 권한이 부여됩니다. 사전 정의된 IAM 역할인 pubsub.admin에는 pubsub.topics.getIamPolicy 및 pubsub.topics.setIamPolicy 권한이 모두 있습니다. 자세한 내용은 Pub/Sub 액세스 제어를 참조하세요.

3. 알림을 전송하려는 기존 Pub/Sub 주제가 있어야 합니다.

주의: pubsub.publisher 사전 정의된 IAM 역할에서 BigQuery Data Transfer Service 에이전트를 삭제하지 마세요. 삭제하면 Pub/Sub 주제에 대한 알림 게시가 실패할 수 있습니다.

주의: Pub/Sub 주제를 만들 때 시 커스텀 스키마를 지정하지 마세요. 커스텀 스키마를 지정하면 알림 게시가 실패할 수 있습니다.

알림 형식

Pub/Sub 주제로 전송되는 알림은 다음 두 부분으로 구성됩니다.

• 속성: 이벤트를 설명하는 키:값 쌍의 조합입니다.
• 페이로드: 변경된 객체의 메타데이터를 포함하는 문자열입니다.

속성

속성은 BigQuery Data Transfer Service가 Pub/Sub 주제로 전송하는 모든 알림에 포함되는 키:값 쌍입니다. 알림 페이로드에 관계없이 알림에는 항상 다음 키:값 쌍 조합이 포함됩니다.

속성 이름	예시	설명
eventType	TRANSFER_RUN_FINISHED	방금 발생한 이벤트의 유형. TRANSFER_RUN_FINISHED가 가능한 유일한 값입니다.
payloadFormat	JSON_API_V1	객체 페이로드의 형식. JSON_API_V1이 가능한 유일한 값입니다.

페이로드

페이로드는 전송 실행의 메타데이터가 포함된 문자열입니다. 현재는 페이로드 유형을 구성할 수 없으며, 향후 API 버전 변경을 수용하기 위해 제공됩니다.

페이로드 유형	설명
JSON_API_V1	페이로드는 TransferRun의 리소스 표현을 포함하는 UTF-8 JSON 직렬화된 문자열이 됩니다.

이메일 알림

이메일 알림은 전송 실행 실패 시 사람이 읽을 수 있는 이메일 메시지를 전송합니다. 이러한 메시지는 전송을 설정한 사용자에게 전송됩니다. 메시지는 구성이 불가능합니다.

다른 사용자도 전송 실행 이메일 알림을 수신해야 한다면 메시지를 배포하는 이메일 전달 규칙을 설정하세요. Gmail을 사용 중인 경우, Gmail 메시지를 다른 계정에 자동으로 전달할 수 있습니다.

이메일 알림은 BigQuery Data Transfer Service에서 전송되며, 전송 구성과 전송 실행에 대한 세부정보와 실패한 실행의 실행 기록 링크가 포함되어 있습니다. 예를 들면 다음과 같습니다.

From: [e-mail]
To: user_who_set_up_transfer
Title: BigQuery Data Transfer Service — Transfer Run Failure —
display_name

Transfer Configuration
Display Name: display_name
Source: data_source
Destination: project_id

Run Summary
Run: run_name
Schedule Time: schedule_time
Run Time: run_time
View Run History

Google LLC 1600 Amphitheatre Parkway, Mountain View, CA 94043

This email was sent because you indicated you are willing to receive Run
Notifications from the BigQuery Data Transfer Service. If you do not wish to
receive such emails in the future, click View Transfer Configuration and
un-check the "Send E-mail Notifications" option.

알림 사용

다음 안내를 따라 알림 사용을 설정할 수 있습니다.

콘솔

1. Google Cloud 콘솔에서 BigQuery 페이지로 이동합니다.

   BigQuery 페이지로 이동

2. 탐색 메뉴에서 데이터 전송을 클릭합니다.

3. 새 전송에 대한 알림을 사용 설정하려면 전송 만들기를 클릭합니다. 기존 전송의 알림을 조정하려면 전송 이름을 클릭한 다음 수정을 클릭합니다.

4. 알림 옵션 섹션에서 사용 설정할 알림 유형 옆의 전환 버튼을 클릭합니다.

   • 이메일 알림: 이 옵션을 사용 설정하면 전송 실행이 실패할 때 전송 관리자에게 이메일 알림이 발송됩니다.
   • Pub/Sub 알림: 이 옵션을 사용 설정하려면 주제 이름을 선택하거나 주제 만들기를 클릭합니다. 이 옵션은 전송에 대한 Pub/Sub 실행 알림을 구성합니다.

Java

이 샘플을 사용해 보기 전에 BigQuery 빠른 시작: 클라이언트 라이브러리 사용의 Java 설정 안내를 따르세요. 자세한 내용은 BigQuery Java API 참고 문서를 확인하세요.

BigQuery에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 클라이언트 라이브러리의 인증 설정을 참조하세요.

import com.google.api.gax.rpc.ApiException;
import com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest;
import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient;
import com.google.cloud.bigquery.datatransfer.v1.ProjectName;
import com.google.cloud.bigquery.datatransfer.v1.TransferConfig;
import com.google.protobuf.Struct;
import com.google.protobuf.Value;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;

// Sample to get run notification
public class RunNotification {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    final String projectId = "MY_PROJECT_ID";
    final String datasetId = "MY_DATASET_ID";
    final String pubsubTopicName = "MY_TOPIC_NAME";
    final String query =
        "SELECT CURRENT_TIMESTAMP() as current_time, @run_time as intended_run_time, "
            + "@run_date as intended_run_date, 17 as some_integer";
    Map<String, Value> params = new HashMap<>();
    params.put("query", Value.newBuilder().setStringValue(query).build());
    params.put(
        "destination_table_name_template",
        Value.newBuilder().setStringValue("my_destination_table_{run_date}").build());
    params.put("write_disposition", Value.newBuilder().setStringValue("WRITE_TRUNCATE").build());
    params.put("partitioning_field", Value.newBuilder().build());
    TransferConfig transferConfig =
        TransferConfig.newBuilder()
            .setDestinationDatasetId(datasetId)
            .setDisplayName("Your Scheduled Query Name")
            .setDataSourceId("scheduled_query")
            .setParams(Struct.newBuilder().putAllFields(params).build())
            .setSchedule("every 24 hours")
            .setNotificationPubsubTopic(pubsubTopicName)
            .build();
    runNotification(projectId, transferConfig);
  }

  public static void runNotification(String projectId, TransferConfig transferConfig)
      throws IOException {
    try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
      ProjectName parent = ProjectName.of(projectId);
      CreateTransferConfigRequest request =
          CreateTransferConfigRequest.newBuilder()
              .setParent(parent.toString())
              .setTransferConfig(transferConfig)
              .build();
      TransferConfig config = dataTransferServiceClient.createTransferConfig(request);
      System.out.println(
          "\nScheduled query with run notification created successfully :" + config.getName());
    } catch (ApiException ex) {
      System.out.print("\nScheduled query with run notification was not created." + ex.toString());
    }
  }
}

Python

이 샘플을 사용해 보기 전에 BigQuery 빠른 시작: 클라이언트 라이브러리 사용의 Python 설정 안내를 따르세요. 자세한 내용은 BigQuery Python API 참고 문서를 확인하세요.

BigQuery에 인증하려면 애플리케이션 기본 사용자 인증 정보를 설정합니다. 자세한 내용은 클라이언트 라이브러리의 인증 설정을 참조하세요.

transfer_config_name = "projects/1234/locations/us/transferConfigs/abcd"
pubsub_topic = "projects/PROJECT-ID/topics/TOPIC-ID"
from google.cloud import bigquery_datatransfer
from google.protobuf import field_mask_pb2

transfer_client = bigquery_datatransfer.DataTransferServiceClient()

transfer_config = bigquery_datatransfer.TransferConfig(name=transfer_config_name)
transfer_config.notification_pubsub_topic = pubsub_topic
update_mask = field_mask_pb2.FieldMask(paths=["notification_pubsub_topic"])

transfer_config = transfer_client.update_transfer_config(
    {"transfer_config": transfer_config, "update_mask": update_mask}
)

print(f"Updated config: '{transfer_config.name}'")
print(f"Notification Pub/Sub topic: '{transfer_config.notification_pubsub_topic}'")

실행 알림 가격 책정

Pub/Sub 실행 알림을 구성하면 Pub/Sub 요금이 청구됩니다. 자세한 내용은 Pub/Sub 가격 책정 페이지를 참조하세요.

다음 단계

• Pub/Sub 자세히 알아보기
• Pub/Sub 주제 만들기 자세히 알아보기.
• BigQuery Data Transfer Service 자세히 알아보기