このドキュメントでは、push サブスクリプション、そのワークフロー、関連するプロパティの概要について説明します。
push 配信では、Pub/Sub がサブスクライバー アプリケーションに対してリクエストを開始し、メッセージを配信します。メッセージは、HTTPS POST リクエストなどの一般公開されているサーバーまたは Webhook に配信されます。
push サブスクリプションでは、Pub/Sub 固有のクライアント ライブラリと認証メカニズムに対する依存関係が最小限に抑えられます。また、Cloud Run 関数、Cloud Run、Google Kubernetes Engine など、サーバーレスで自動スケーリングのサービス テクノロジーとも連携します。
始める前に
このドキュメントを読む前に、次のことを理解しておいてください。
Pub/Sub の仕組みとさまざまな Pub/Sub の用語。
Pub/Sub でサポートされているさまざまなサブスクリプションの種類と、push サブスクリプションを使用する理由。
push サブスクリプションのワークフロー
push サブスクリプションでは、Pub/Sub サーバーがサブスクライバー クライアントにリクエストを開始し、メッセージを配信します。
次の図は、サブスクライバー クライアントとプッシュ サブスクリプション間のワークフローを示しています。
図 3 を参照するワークフローの概要は次のとおりです。
- Pub/Sub サーバーは、事前構成されたエンドポイントで、サブスクライバー クライアントに各メッセージを HTTPS リクエストとして送信します。このリクエストは、画像では
PushRequestとして示されています。 - エンドポイントは、HTTP 成功ステータス コードを返すことでメッセージに確認応答します。成功以外のレスポンスは、Pub/Sub がメッセージを再送信する必要があることを示します。このレスポンスは、画像では
PushResponseとして表示されます。 - Pub/Sub は、成功のレスポンスを受信するレートに基づいて、push リクエストのレートを動的に調整します。
push サブスクリプションのプロパティ
push サブスクリプション用に構成するプロパティによって、サブスクリプションにメッセージを書き込む方法が決まります。詳細については、サブスクリプション プロパティをご覧ください。
push エンドポイントがメッセージを受信する仕組み
Pub/Sub が push エンドポイントにメッセージを配信するときに、メッセージをラップまたはラップ解除して送信することを選択できます。デフォルトでは、メッセージはラップして送信されます。
- ラップ済み。Pub/Sub は、
POSTリクエストの JSON 本文にメッセージを送信します。 - ラップ解除。Pub/Sub は、未加工のメッセージ データを HTTP 本文として直接送信します。
次の例は、message.data フィールドに文字列 Hello there を含む push エンドポイントへの JSON POST リクエストのラップされた本文を示しています。
POST リクエストの本文は JSON オブジェクトです。メッセージ データは message.data フィールドにあり、base64 でエンコードされています。
最小値を含むリクエストの例
{ "message": { "data": "SGVsbG8gQ2xvdWQgUHViL1N1YiEgSGVyZSBpcyBteSBtZXNzYWdlIQ==", "messageId": "2070443601311540", "message_id": "2070443601311540", "publishTime": "2021-02-26T19:13:55.749Z", "publish_time": "2021-02-26T19:13:55.749Z" }, "subscription": "projects/myproject/subscriptions/mysubscription" }
最大値を含むリクエストの例
この例は現在の最大値を示しています。この値は時間とともに変化する可能性があります。また、属性マップにさまざまな値を含めることができます。
{ "deliveryAttempt": 5, "message": { "attributes": { "key": "value" }, "data": "SGVsbG8gQ2xvdWQgUHViL1N1YiEgSGVyZSBpcyBteSBtZXNzYWdlIQ==", "messageId": "2070443601311540", "message_id": "2070443601311540", "orderingKey": "key", "publishTime": "2021-02-26T19:13:55.749Z", "publish_time": "2021-02-26T19:13:55.749Z" }, "subscription": "projects/myproject/subscriptions/mysubscription" }
push サブスクリプションからメッセージを受信するには、Webhook を使用して、Pub/Sub によって push エンドポイントに送信される POST リクエストを処理します。App Engine でのこれらの POST リクエストの処理の詳細については、Pub/Sub メッセージの作成とレスポンスをご覧ください。
push リクエストの受信後、HTTP ステータス コードを返します。メッセージへ確認応答するには、次のいずれかのステータス コードを返します。
102200201202204
メッセージに対し否定応答を送信するには、他のステータス コードを返します。否定応答を送信するか、確認応答期限が切れた場合、Pub/Sub はメッセージを再送信します。push サブスクリプションから受信する個々のメッセージの確認応答期限は、変更できません。
push サブスクリプションの認証
push サブスクリプションが認証を使用する場合、Pub/Sub サービスは JWT に署名し、push リクエストの認可ヘッダーで JWT を送信します。
認証の設定の詳細については、push リクエストを認証するをご覧ください。
メッセージ配信の停止と再開
Pub/Sub で push エンドポイントに対するリクエストの送信を一時的に停止するには、サブスクリプションを pull に変更します。変更が適用されるまで、数分かかることがあります。
push 配信を再開するには、URL を有効なエンドポイントにもう一度設定します。配信を完全に停止するには、サブスクリプションを削除します。
push バックオフ
push サブスクライバーが送信する否定確認応答が多すぎる場合、Pub/Sub は push バックオフを使用してメッセージ配信を開始する可能性があります。Pub/Sub が push バックオフを使用すると、事前に設定された期間、メッセージの配信を停止します。この時間範囲は 100 ミリ秒から 60 秒の間で設定できます。この時間が経過すると、Pub/Sub はメッセージの配信を開始します。
push バックオフは、指数バックオフ アルゴリズムを使用して、Pub/Sub がメッセージの送信間に使用する遅延を決定します。この期間は、サブスクライバーが送信する否定応答の数に基づいて計算されます。
たとえば、push サブスクライバーが 1 秒あたり 5 件のメッセージを受信して、1 秒あたり 1 件の否定確認応答を送信する場合は、Pub/Sub は約 500 ミリ秒ごとにメッセージを配信します。push サブスクライバーが毎秒 5 つの否定確認応答を送信する場合、Pub/Sub は 30～60 秒ごとにメッセージを配信します。
push バックオフについては、次の点を考慮してください。
- push バックオフはオンまたはオフにできません。また、遅延の計算に使用される値は変更できません。
- push バックオフは、次のアクションに対してトリガーされます。
- 否定確認応答を受け取った場合。
- メッセージの確認応答期限が切れた場合。
- プッシュ バックオフは、サブスクリプション内のすべてのメッセージ（グローバル）に適用されます。
配信レート
スロースタート アルゴリズムを使用して同時 push リクエストの数を調整します。push ウィンドウは、同時 push リクエストの最大数です。push ウィンドウは、配信が成功すると増加し、失敗すると減少します。システムは、1 桁の小さなウィンドウサイズから開始します。
サブスクライバーがメッセージの確認応答を行うと、ウィンドウは急激に増加します。サブスクライバーがメッセージの 99% 以上を確認応答し、push リクエストのレイテンシが平均 1 秒未満であるサブスクリプションの場合、push ウィンドウはパブリッシュ スループットに対応できるように拡張する必要があります。
push リクエストのレイテンシには、次のものなどがあります。
Pub/Sub サーバーと push エンドポイントの間の往復ネットワーク レイテンシ
サブスクライバーの処理時間
リージョンあたりの未処理のメッセージが 3,000 件を超えると、ウィンドウは比例して増加し、push エンドポイントがメッセージを過剰に受け取ることを回避できます。平均レイテンシが 1 秒を超えるか、サブスクライバーの確認応答がリクエストの 99% 未満の場合、ウィンドウは未処理のメッセージの下限 3,000 件に減少します。
push 配信のモニタリングに使用できる指標の詳細については、push サブスクリプションのモニタリングをご覧ください。
割り当てと上限
push サブスクリプションには割り当てとリソース上限があります。
次のステップ
トピックの push サブスクリプションを作成します。
gcloud CLI を使用してサブスクリプションを作成または変更する。
REST API を使用してサブスクリプションを作成または変更する。
REST API を使用してサブスクリプションを作成または変更する。