Eventarc トリガーは、特定のイベントまたは一連のイベントに関心があることを宣言します。イベント ルーティングを構成するには、トリガーのフィルタ（イベントソースとターゲット ワークフローを含む）を指定します。
イベントは、HTTP リクエストを介して CloudEvents 形式で配信されます。Workflows サービスは、CloudEvents 仕様に従ってイベントを JSON オブジェクトに変換し、ワークフロー ランタイム引数としてワークフロー実行に渡します。イベントサイズが 512 KB を超えていないことを確認してください。Workflows の引数サイズの上限を超えるイベントはワークフローの実行をトリガーしません。
以下では、Firebase Alerts 直接イベントに応答してワークフローの実行がトリガーされるように、イベント ルーティングを構成する方法について説明します。詳細については、サポートされている直接イベントのリストをご覧ください。 Firebase アラートが Firebase サービスによって発行されると、イベントに応答してサービスへのリクエストがトリガーされます。トリガーを作成する準備
ターゲット ワークフローの Eventarc トリガーを作成する前に、次の作業を完了します。
コンソール
Google Cloud コンソールのプロジェクト セレクタ ページで、Google Cloud プロジェクトを選択または作成します。
Eventarc API、Eventarc Publishing API、Workflows API、Workflow Executions API を有効にします。
該当する場合は、直接イベントに関連する API を有効にします。たとえば、Firebase Alerts イベントの場合は Firebase Alerts API を有効にします。
アカウントがない場合は、ユーザー管理のサービス アカウントを作成し、Eventarc がターゲット ワークフローのイベントを管理できるように、必要なロールと権限を付与します。
Google Cloud コンソールで、[サービス アカウント] ページに移動します。
プロジェクトを選択します。
[サービス アカウント名] フィールドに名前を入力します。Google Cloud コンソールでは、この名前に基づいて [サービス アカウント ID] フィールドに値が設定されます。
[サービス アカウントの説明] フィールドに説明を入力します。例:
Service account for event trigger[作成して続行] をクリックします。
適切なアクセス権を付与するには、[ロールを選択] リストで、サービス アカウントに必要な Identity and Access Management（IAM）ロールを選択します。詳細については、Workflows ターゲットのロールと権限をご覧ください。
ロールを追加するには、[別のロールを追加] をクリックして各ロールを追加します。
[続行] をクリックします。
アカウントの作成を完了するには、[完了] をクリックします。
gcloud
Google Cloud コンソールで、「Cloud Shell をアクティブにする」をクリックします。
Google Cloud コンソールの下部で Cloud Shell セッションが開始し、コマンドライン プロンプトが表示されます。Cloud Shell はシェル環境です。Google Cloud CLI がすでにインストールされており、現在のプロジェクトの値もすでに設定されています。セッションが初期化されるまで数秒かかることがあります。
Eventarc API、Eventarc Publishing API、Workflows API、Workflow Executions API を有効にします。
gcloud services enable eventarc.googleapis.com \ eventarcpublishing.googleapis.com \ workflows.googleapis.com \ workflowexecutions.googleapis.com該当する場合は、直接イベントに関連する API を有効にします。たとえば、Firebase Alerts イベントの場合は
firestore.googleapis.comを有効にします。アカウントがない場合は、ユーザー管理のサービス アカウントを作成し、Eventarc がターゲット ワークフローのイベントを管理できるように、必要なロールと権限を付与します。
サービス アカウントを作成します。
gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
SERVICE_ACCOUNT_NAMEは、サービス アカウントの名前に置き換えます。6～30 文字で、小文字の英数字とダッシュを使用できます。作成したサービス アカウントの名前は変更できません。必要な Identity and Access Management（IAM）のロールまたは権限を付与します。詳細については、Workflows ターゲットのロールと権限をご覧ください。
トリガーを作成する
イベント レシーバとしてデプロイされたワークフローに Eventarc トリガーを作成するには、Google Cloud CLI（gcloud または Terraform）を使用するか、Google Cloud コンソールを使用します。
コンソール
- Google Cloud コンソールで、[Eventarc] の [トリガー] ページに移動します。
- [トリガーを作成] をクリックします。
- トリガー名を入力します。
これはトリガーの ID で、先頭は英字にする必要があります。63 文字以下とし、小文字、数字、ハイフンを使用することができます。
- [トリガーのタイプ] で、[Google のソース] を選択します。
- [イベント プロバイダ] リストで「Firebase Alerts」を選択します。
関連する Google Cloud のドキュメントでは、イベント プロバイダ名の前に Cloud または Google Cloud が付いていない場合があります。たとえば、Memorystore for Redis はコンソールで Google Cloud Memorystore for Redis と表示されます。
- [イベントタイプ] リストで、直接イベントからイベントタイプを選択します。
- イベント ペイロードのエンコードを指定するには、[イベントデータのコンテンツ タイプ] リストで application/json または application/protobuf を選択します。
JSON 形式のイベント ペイロードは、Protobuf 形式のイベント ペイロードよりも大きくなります。イベントの宛先とイベントサイズの制限によっては、信頼性に影響する可能性があります。詳細については、既知の問題をご覧ください。
- [リージョン] リストで、[global (グローバル)] を選択します。
詳細については、Eventarc のロケーションをご覧ください。
- [属性 1] フィールドでは、alerttype リソース ID がイベント フィルタとして機能します。このフィルタの演算子を選択します。
- 等しい
- パスパターン
詳細については、パスパターンについてをご覧ください。
- [属性の値 1] フィールドで、次のいずれかを選択します。
appDistribution.inAppFeedback: テスターが特定のアプリのアプリ内フィードバックを送信すると、イベントが送信されます。appDistribution.newTesterIosDevice: 特定のアプリに新しい iOS テスター デバイスが登録されるとイベントが送信されます。billing.planAutomatedUpdate: Firebase プロジェクトの料金プランが自動的に更新されると、イベントが送信されます。たとえば、支払いに関する問題でプランがダウングレードされた場合などです。billing.planUpdate: ユーザーが Firebase プロジェクトの料金プランを変更すると、イベントが送信されます。たとえば、プロジェクトで請求先アカウントの適用または解除が行われた場合などです。crashlytics.missingSymbolFile: 受信クラッシュ レポートをシンボリケートするための適切なデバッグ シンボルがないと Firebase Crashlytics が判断したときにイベントが送信されます。crashlytics.newAnrIssue: アプリで新しいアプリケーション応答なし（ANR）エラーが発生した場合にイベントが送信されます（後続の同一のイベントでは送信されません）。crashlytics.newFatalIssue: アプリで新しい致命的なクラッシュが発生したとき送信されます（後続の同じイベントに対しては送信されません）。crashlytics.newNonfatalIssue: アプリで新しい非致命的なエラーが発生するとイベントが送信されます（後続の同じイベントでは送信されません）。crashlytics.regression: 以前のアプリのバージョンで解決とマークされた問題でクラッシュが発生するとイベントが送信されます。crashlytics.stabilityDigest: Crashlytics でトレンドになっている問題の通知があると、イベントが送信されます。crashlytics.velocity: 1 つの問題が原因で多数のアプリ セッションがクラッシュしたときにイベントが送信されます。performance.threshold: 指標のパフォーマンスが、設定されたしきい値を超えた時点でイベントが送信されます。
- 必要に応じて、特定の Firebase アプリ ID でイベントをフィルタできます。[addフィルタを追加] をクリックして、appid を指定します。
- サービスまたはワークフローを呼び出すサービス アカウントを選択します。
新しいサービス アカウントを作成することもできます。
これにより、トリガーに関連付けられた Identity and Access Management（IAM）サービス アカウントのメールアドレスが設定されます。このメールアドレスには、Eventarc が必要とする特定のロールがすでに付与されています。
- [イベントの宛先] リストで、[Workflows] を選択します。
- ワークフローを選択します。
これは、イベントを渡すワークフローの名前です。ワークフロー実行用のイベントは、変換されてランタイム引数としてワークフローに渡されます。
詳細については、Workflows のトリガーを作成するをご覧ください。
- [作成] をクリックします。
トリガーの作成後は、イベントソースのフィルタを変更できません。代わりに、新しいトリガーを作成して古いトリガーを削除します。詳しくは、トリガーの管理をご覧ください。
gcloud
gcloud eventarc triggers create TRIGGER \
--location=global \
--destination-workflow=DESTINATION_WORKFLOW \
--destination-workflow-location=DESTINATION_WORKFLOW_LOCATION \
--event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
--event-filters="alerttype=ALERT_TYPE" \
--event-data-content-type="EVENT_DATA_CONTENT_TYPE" \
--service-account="MY_SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com"
次のように置き換えます。
TRIGGER: トリガーの ID または完全修飾識別子。-
DESTINATION_WORKFLOW: トリガーからイベントを受け取る、デプロイ済みワークフローの ID。ワークフローは、Workflows でサポートされている任意のロケーションに配置できます。トリガーと同じロケーションに存在する必要はありません。ただし、ワークフローはトリガーと同じプロジェクトに存在する必要があります。 -
DESTINATION_WORKFLOW_LOCATION（省略可）: 宛先ワークフローがデプロイされるロケーション。指定しない場合、ワークフローはトリガーと同じロケーションにあるとみなされます。 ALERT_TYPE: Firebase アラートのタイプ。次のいずれかの値になります。appDistribution.inAppFeedback: テスターが特定のアプリのアプリ内フィードバックを送信すると、イベントが送信されます。appDistribution.newTesterIosDevice: 特定のアプリに新しい iOS テスター デバイスが登録されるとイベントが送信されます。billing.planAutomatedUpdate: Firebase プロジェクトの料金プランが自動的に更新されると、イベントが送信されます。たとえば、支払いに関する問題でプランがダウングレードされた場合などです。billing.planUpdate: ユーザーが Firebase プロジェクトの料金プランを変更すると、イベントが送信されます。たとえば、プロジェクトで請求先アカウントの適用または解除が行われた場合などです。crashlytics.missingSymbolFile: 受信クラッシュ レポートをシンボリケートするための適切なデバッグ シンボルがないと Firebase Crashlytics が判断したときにイベントが送信されます。crashlytics.newAnrIssue: アプリで新しいアプリケーション応答なし（ANR）エラーが発生した場合にイベントが送信されます（後続の同一のイベントでは送信されません）。crashlytics.newFatalIssue: アプリで新しい致命的なクラッシュが発生したとき送信されます（後続の同じイベントに対しては送信されません）。crashlytics.newNonfatalIssue: アプリで新しい非致命的なエラーが発生するとイベントが送信されます（後続の同じイベントでは送信されません）。crashlytics.regression: 以前のアプリのバージョンで解決とマークされた問題でクラッシュが発生するとイベントが送信されます。crashlytics.stabilityDigest: Crashlytics でトレンドになっている問題の通知があると、イベントが送信されます。crashlytics.velocity: 1 つの問題が原因で多数のアプリ セッションがクラッシュしたときにイベントが送信されます。performance.threshold: 指標のパフォーマンスが、設定されたしきい値を超えた時点でイベントが送信されます。
ALERT_TYPEの演算子は次のいずれかにする必要があります。- 等しい。例:
--event-filters="alerttype=appDistribution.inAppFeedback" - パスパターン。例:
--event-filters-path-pattern="alerttype=appDistribution."または--event-filters-path-pattern="alerttype=crashlytics.new"。詳細については、パスパターンについてをご覧ください。
-
EVENT_DATA_CONTENT_TYPE:（省略可）イベント ペイロードのエンコード。値はapplication/jsonまたはapplication/protobufです。デフォルトのエンコードはapplication/jsonです。JSON 形式のイベント ペイロードは、Protobuf 形式のイベント ペイロードよりも大きくなります。イベントの宛先とイベントサイズの制限によっては、信頼性に影響する可能性があります。詳細については、既知の問題をご覧ください。
SERVICE_ACCOUNT_NAME: Workflows で必要な特定のロールを付与した IAM サービス アカウントの名前。-
PROJECT_ID: 実際の Google Cloud プロジェクト ID
注:
--locationフラグはglobalにする必要があります。詳細については、Eventarc のロケーションをご覧ください。- 以下のフラグは必須です。
--event-filters="type=google.firebase.firebasealerts.alerts.v1.published"--event-filters="alerttype=ALERT_TYPE"または--event-filters-path-pattern="alerttype=ALERT_TYPE"
- トリガーの作成後に、イベント フィルタのタイプを変更することはできません。別のイベントタイプには、新しいトリガーを作成する必要があります。
- 必要に応じて、
--event-filters="appid=APP_ID"フラグを使用して完全一致を指定することで、特定の Firebase アプリ ID のイベントをフィルタできます。 -
--service-account: Eventarc トリガーがワークフロー実行の呼び出しに使用する IAM サービス アカウントのメールアドレス。必要なリソースにアクセスするために必要な最小権限を持つサービス アカウントを使用することを強くおすすめします。サービス アカウントの詳細については、サービス アカウントの作成と管理をご覧ください。 - デフォルトでは、Eventarc 用に作成された Pub/Sub サブスクリプションはアクティビティに関係なく保持され、期限切れになりません。非アクティブ期間を変更するには、サブスクリプションのプロパティをご覧ください。
例:
gcloud eventarc triggers create firealerts-workflows-trigger \
--location=global \
--destination-workflow=my-workflow \
--destination-workflow-location=europe-west4 \
--event-filters="type=google.firebase.firebasealerts.alerts.v1.published" \
--event-filters="alerttype=crashlytics.velocity" \
--service-account="${SERVICE_ACCOUNT_NAME}@${PROJECT_ID}.iam.gserviceaccount.com"
このコマンドは、google.firebase.firebasealerts.alerts.v1.published として識別されるイベントと crashlytics.velocity アラートタイプに対して firealerts-workflows-trigger というトリガーを作成します。
Terraform
Terraform を使用して、ワークフローのトリガーを作成できます。詳細については、Eventarc と Terraform を使用してワークフローをトリガーするをご覧ください。
トリガーを一覧表示する
トリガーの作成を確認するには、Google Cloud CLI または Google Cloud コンソールを使用して Eventarc トリガーを一覧表示します。
コンソール
Google Cloud コンソールで、[Eventarc] の [トリガー] ページに移動します。
このページには、すべてのロケーションのトリガーが一覧表示されます。また、名前、リージョン、イベント プロバイダ、宛先などの詳細情報も表示されます。
トリガーをフィルタするには:
- [ フィルタ] フィールドまたは [トリガーをフィルタリング] フィールドをクリックします。
- [プロパティ] リストで、トリガーをフィルタするオプションを選択します。
1 つのプロパティを選択することも、論理演算子
ORを使用して複数のプロパティを追加することもできます。トリガーを並べ替えるには、サポートされている列見出しの横にある [ 並べ替え] をクリックします。
gcloud
次のコマンドを実行してトリガーを一覧表示します。
gcloud eventarc triggers list --location=-
すべてのロケーションのトリガーが一覧表示されます。名前、タイプ、宛先、ステータスなどの詳細情報も表示されます。