Event Grid によるメッセージの配信と再試行

[アーティクル]
03/09/2023

Event Grid は、持続性のある配信を提供します。一致する各サブスクリプションに対して、最低 1 回は各メッセージを直ちに配信しようとします。サブスクライバーのエンドポイントがイベントの受信を認識しない場合、またはエラーが発生した場合、Event Grid では、固定された再試行スケジュールと再試行ポリシーに基づいて配信を再試行します。既定では、Event Grid によって、サブスクライバーに一度に 1 つのイベントが配信されます。ただし、ペイロードは 1 つのイベントを持つ配列です。

Note

Event Grid によるイベント配信の順序は保証されません。そのため、サブスクライバーはこれらを順序どおりに受信できない場合があります。

再試行のスケジュール

イベント配信の試行に関するエラーを Event Grid で受信した場合は、エラーの種類に基づいて、イベント配信の再試行、イベントの配信不能処理、イベントの削除のいずれを行う必要があるかが Event Grid により決定されます。

サブスクライブされたエンドポイントによって返されたエラーが、再試行によって修正できない構成関連のエラー (エンドポイントが削除された場合など) である場合、Event Grid によりイベントの配信不能処理が行われます。配信不能が構成されていない場合は、イベントが削除されます。

次の表では、再試行が行われないエンドポイントとエラーの種類について説明します。

エンドポイントの種類	エラーコード
Azure リソース	400 (無効な要求)、413 (要求エンティティが大きすぎます)
Webhook	400 (無効な要求)、413 (要求エンティティが大きすぎます)、401 (権限がありません)

Note

エンドポイントに対して配信不能が構成されていない場合、上記のエラーが発生すると、イベントは削除されます。この種のイベントを削除したくない場合は、配信不能を構成することを検討してください。配信不能イベントは、配信不能メッセージの宛先が見つからない場合、削除されます。

サブスクライブされたエンドポイントによって返されたエラーが上記の一覧にない場合、次に示すポリシーを使用して、Event Grid によって再試行が実行されます。

Event Grid は、メッセージの配信後、応答を 30 秒間待機します。 30 秒経過しても、エンドポイントが応答していない場合は、メッセージは再試行のためにキューに入れられます。 Event Grid は、イベント配信に対して指数バックオフ再試行ポリシーを使用します。 Event Grid ではベストエフォート方式で次のスケジュールに従って配信を再試行します。

10 秒
30 秒
1 分
5 分
10 分
30 分
1 時間
3 時間
6 時間
12 時間ごと (最大 24 時間)

エンドポイントが 3 分以内に応答した場合、Event Grid はベストエフォート方式でイベントを再試行キューから削除しようとしますが、それでも重複が受信される可能性があります。

Event Grid では、すべての再試行の手順に小規模なランダム化を追加します。また、エンドポイントが一貫して正常ではない、長期間ダウンしている、または圧迫されていることがわかっている場合は、状況に応じて、特定の再試行をスキップできます。

再試行ポリシー

イベントサブスクリプションを作成するときには、次の 2 つの構成を使用して再試行ポリシーをカスタマイズできます。再試行ポリシーの制限のいずれかに達すると、イベントは削除されます。

最大試行回数 - 値は 1 ～ 30 の整数にする必要があります。既定値は 30 です。
イベントの Time-To-Live (TTL) - 値は 1 ～ 1,440 の整数にする必要があります。既定値は 1,440 分です

これらの設定を構成するためのサンプルの CLI および PowerShell コマンドについては、「再試行ポリシーの設定」を参照してください。

注意

Event time to live (TTL) と Maximum number of attempts の両方を設定した場合、Event Grid は期限切れについて最初の設定を使用して、イベント配信を停止するタイミングを判別します。たとえば、Time-to-live (TTL) を 30 分に設定し、配信の最大試行回数を 5 回に設定したとします。イベントが 30 分の時間経過または 5 回の試行 (どちらか先に発生した方) の後に配信されなかった場合、そのイベントは配信不能となります。指数再試行スケジュールに関して、配信の最大試行回数を 10 に設定した場合、TTL に達する 30 分前に最大 6 回の配信試行が行われます。したがって、最大試行回数を 10 に設定しても、この場合は影響を受けず、イベントは 30 分後に配信不能になります。

出力のバッチ処理

Event Grid の既定では、サブスクライバーに各イベントが個別に送信されます。サブスクライバーは、イベント 1 つが格納された配列を受け取ります。高スループットの状況で HTTP のパフォーマンスを向上させるため、イベントを一括配信するように Event Grid を構成することができます。バッチ処理は、既定では無効になっており、サブスクリプションごとに有効にできます。

バッチ処理のポリシー

一括配信には、次の 2 つの設定があります。

[バッチごとの最大イベント数] - Event Grid によってバッチごとに配信されるイベントの最大数。この数を超えることはありませんが、発行時に利用できるイベントが他にない場合は、これより少ない数のイベントが配信される可能性があります。配信できるイベントの数が少ない場合、バッチを作成するために Event Grid でイベントが遅延されることはありません。 1 から 5,000 の間である必要があります。
優先バッチサイズ (KB 単位) - バッチサイズの目標上限 (KB 単位)。最大イベント数と同様に、発行の時点で使用できないイベントが増えると、バッチサイズが小さくなることがあります。 1 つのイベントが優先サイズより大きい "場合"、バッチが優先バッチサイズより大きくなることがあります。たとえば、優先サイズが 4 KB で、10 KB のイベントが Event Grid にプッシュされた場合でも、10 KB のイベントは削除されるのではなく、独自のバッチで配信されます。

バッチ配信は、ポータル、CLI、PowerShell、または SDK を使用して、イベントごとのサブスクリプションで構成されます。

バッチ処理の動作

すべてまたはなし

Event Grid 操作は、"すべてまたはなし" のセマンティクスです。バッチ配信の一部成功はサポートされていません。サブスクライバーは、バッチごとに 30 秒で合理的に処理できるだけの数のイベントを要求するように注意する必要があります。
オプティミスティックバッチ処理

バッチ処理ポリシー設定は、バッチ処理動作に対する厳密な限界ではなく、ベストエフォートベースで尊重されます。イベントレートが低い場合、バッチのサイズが、バッチごとのイベントの要求した最大数より小さいことがよくあります。
既定値は OFF に設定されています

既定では、Event Grid によって、各配信要求に 1 つのイベントのみが追加されます。バッチ処理を有効にする方法は、イベントサブスクリプション JSON で、この記事で前述した設定のいずれかを指定することです。
既定値

イベントサブスクリプションを作成するときに、両方の設定 (バッチあたりの最大イベント数とキロバイト単位の概算バッチサイズ) を指定する必要はありません。 1 つの設定さえ指定されれば、Event Grid によって (構成可能な) 既定値が使用されます。既定値と、それらをオーバーライドする方法については、以降のセクションを参照してください。

Azure portal:

これらの設定は、[イベントサブスクリプション] ページの [追加機能] タブに表示されます。

[バッチ処理] セクションが強調表示されている [イベントサブスクリプション] ページの [追加機能] タブを示すスクリーンショット。

Azure CLI

イベントサブスクリプションを作成するときは、次のパラメーターを使用します。

max-events-per-batch - バッチ内のイベントの最大数。 1 から 5000 までの数値を指定する必要があります。
preferred-batch-size-in-kilobytes - 優先バッチサイズ (KB 単位)。 1 から 1024 までの数値を指定する必要があります。

storageid=$(az storage account show --name <storage_account_name> --resource-group <resource_group_name> --query id --output tsv)
endpoint=https://$sitename.azurewebsites.net/api/updates

az eventgrid event-subscription create \
  --resource-id $storageid \
  --name <event_subscription_name> \
  --endpoint $endpoint \
  --max-events-per-batch 1000 \
  --preferred-batch-size-in-kilobytes 512

Event Grid での Azure CLI の使用の詳細については、「Azure CLI を使用してストレージイベントを Web エンドポイントにルーティングする」を参照してください。

遅延配信

エンドポイントで配信エラーが発生すると、Event Grid はそのエンドポイントへのイベント配信とイベントの再試行を遅らせ始めます。たとえば、エンドポイントに発行された最初の 10 個のイベントが失敗した場合、Event Grid はそのエンドポイントで問題が発生していると想定し、その後の再試行 "および新しい" 配信はしばらく (場合によっては数時間) 遅延されます。

配信が遅延する機能的な目的は、正常でないエンドポイントと Event Grid システムを保護することです。バックオフや正常でないエンドポイントへの配信の遅延がなければ、Event Grid の再試行ポリシーとボリューム機能によって、システムがすぐに過負荷になる可能性があります。

配信不能イベント

Event Grid では、一定の時間内にイベントを配信できない場合、あるいはイベントの配信を一定回数試行したが配信できない場合、未配信イベントをストレージアカウントに送信できます。このプロセスは配信不能処理と呼ばれます。 Event Grid では、次のいずれかの条件に一致したとき、イベントが配信不能処理されます。

イベントが Time-To-Live 期間内に配信されない。
イベント配信の試行回数が上限を超えている。

いずれかの条件が満たされた場合、イベントは削除されるか、配信不能になります。既定では、Event Grid は配信不能処理を有効にしません。この処理を有効にするには、イベントサブスクリプションの作成時に、配信不能イベントを保持するようにストレージアカウントを指定する必要があります。このストレージアカウントからイベントをプルして配信を解決します。

Event Grid は、そのすべての再試行を試行し終わると、配信不能の場所にイベントを送信します。 Event Grid で 400 (正しくない要求) または 413 (要求のエンティティが大きすぎます) の応答コードが受信された場合、そのイベントの配信不能処理が即時にスケジュールされます。これらの応答コードは、イベントの配信が決して成功しないことを示します。

Time-To-Live の期限が切れたかどうかは、スケジュールされている次の配信試行時にのみ確認されます。したがって、スケジュールされている次の配信試行の前に Time-To-Live の期限が切れた場合でも、イベントの期限切れは次の配信時にのみチェックされ、その後で配信不能になります。

イベントの配信を最後に試してから、それが配信不能の場所に届くまで、5 分間の遅延があります。この遅延の目的は、BLOB ストレージの操作数を減らすことにあります。配信不能の場所が 4 時間にわたって使用できない場合、そのイベントは破棄されます。

配信不能の場所を設定するには、コンテナーを含むストレージアカウントが必要です。イベントサブスクリプションの作成時に、このコンテナーのエンドポイントを指定します。エンドポイントの形式は次のとおりです。/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Storage/storageAccounts/<storage-name>/blobServices/default/containers/<container-name>

イベントが配信不能の場所に送信されたら通知を受け取るようにすることもできます。 Event Grid を使用して配信不能イベントに応答するには、配信不能 Blob ストレージ用のイベントサブスクリプションを作成します。配信不能 Blob ストレージが配信不能イベントを受信するたびに、Event Grid はハンドラーに通知します。ハンドラーは、配信不能イベントを調整するためのアクションで応答します。配信不能の場所と再試行ポリシーの設定の例については、配信不能と再試行のポリシーに関する記事を参照してください。

Note

配信不能に対してマネージド ID を有効にする場合は、配信不能イベントを保持する Azure Storage アカウントの適切なロールベースのアクセス制御 (RBAC) ロールにマネージド ID を追加する必要があります。詳細については、「サポートされている配信先と Azure ロール」を参照してください。

配信イベントの形式

このセクションでは、さまざまな配信スキーマ形式 (Event Grid スキーマ、CloudEvents 1.0 スキーマ、およびカスタムスキーマ) のイベントおよび配信不能イベントの例を示します。これらの形式の詳細については、Event Grid スキーマおよび CloudEvents 1.0 スキーマに関する記事を参照してください。

Event Grid スキーマ

event

{
    "id": "93902694-901e-008f-6f95-7153a806873c",
    "eventTime": "2020-08-13T17:18:13.1647262Z",
    "eventType": "Microsoft.Storage.BlobCreated",
    "dataVersion": "",
    "metadataVersion": "1",
    "topic": "/subscriptions/000000000-0000-0000-0000-00000000000000/resourceGroups/rgwithoutpolicy/providers/Microsoft.Storage/storageAccounts/myegteststgfoo",
    "subject": "/blobServices/default/containers/deadletter/blobs/myBlobFile.txt",    
    "data": {
        "api": "PutBlob",
        "clientRequestId": "c0d879ad-88c8-4bbe-8774-d65888dc2038",
        "requestId": "93902694-901e-008f-6f95-7153a8000000",
        "eTag": "0x8D83FACDC0C3402",
        "contentType": "text/plain",
        "contentLength": 0,
        "blobType": "BlockBlob",
        "url": "https://myegteststgfoo.blob.core.windows.net/deadletter/myBlobFile.txt",
        "sequencer": "00000000000000000000000000015508000000000005101c",
        "storageDiagnostics": { "batchId": "cfb32f79-3006-0010-0095-711faa000000" }
    }
}

配信不能イベント

{
    "id": "93902694-901e-008f-6f95-7153a806873c",
    "eventTime": "2020-08-13T17:18:13.1647262Z",
    "eventType": "Microsoft.Storage.BlobCreated",
    "dataVersion": "",
    "metadataVersion": "1",
    "topic": "/subscriptions/0000000000-0000-0000-0000-000000000000000/resourceGroups/rgwithoutpolicy/providers/Microsoft.Storage/storageAccounts/myegteststgfoo",
    "subject": "/blobServices/default/containers/deadletter/blobs/myBlobFile.txt",    
    "data": {
        "api": "PutBlob",
        "clientRequestId": "c0d879ad-88c8-4bbe-8774-d65888dc2038",
        "requestId": "93902694-901e-008f-6f95-7153a8000000",
        "eTag": "0x8D83FACDC0C3402",
        "contentType": "text/plain",
        "contentLength": 0,
        "blobType": "BlockBlob",
        "url": "https://myegteststgfoo.blob.core.windows.net/deadletter/myBlobFile.txt",
        "sequencer": "00000000000000000000000000015508000000000005101c",
        "storageDiagnostics": { "batchId": "cfb32f79-3006-0010-0095-711faa000000" }
    },

    "deadLetterReason": "MaxDeliveryAttemptsExceeded",
    "deliveryAttempts": 1,
    "lastDeliveryOutcome": "NotFound",
    "publishTime": "2020-08-13T17:18:14.0265758Z",
    "lastDeliveryAttemptTime": "2020-08-13T17:18:14.0465788Z" 
}

lastDeliveryOutcome に使用できる値とその説明を次に示します。

LastDeliveryOutcome	説明
NotFound	宛先リソースが見つかりませんでした。
無効	宛先でイベントの受信が無効になっています。 Azure Service Bus と Azure Event Hubs に適用されます。
[完全]	宛先で許可されている操作の最大数を超えました。 Azure Service Bus と Azure Event Hubs に適用されます。
権限がありません	宛先から Unauthorized 応答コードが返されました。
BadRequest	宛先から Bad Request 応答コードが返されました。
TimedOut	配信操作がタイムアウトしました。
ビジー	宛先サーバーがビジー状態です。
PayloadTooLarge	メッセージのサイズが宛先で許容される最大サイズを超えました。 Azure Service Bus と Azure Event Hubs に適用されます。
Probation	宛先が Event Grid によってプロベーション状態にされています。プロベーション中に配信が試行されることはありません。
Canceled	配信操作が取り消されました。
Aborted	一定の時間が経過した後、Event Grid によって配信が中止されました。
SocketError	配信中にネットワーク通信エラーが発生しました。
ResolutionError	宛先エンドポイントの DNS 解決に失敗しました。
配信	宛先にイベントを配信中です。
SessionQueueNotSupported	セッションのサポートが有効になっているエンティティに対して、セッション ID のないイベント配信が試行されています。 Azure Service Bus エンティティの宛先に適用されます。
Forbidden	宛先エンドポイントで配信が禁止されています (IP ファイアウォールまたはその他の制限が原因と考えられます)
InvalidAzureFunctionDestination	宛先の Azure 関数が無効です。 EventGridTrigger 型がないことが原因と考えられます。

LastDeliveryOutcome: Probation

イベントサブスクリプションは、その宛先へのイベント配信が失敗し始めた場合、Event Grid によって一定期間プロベーション状態にされます。プロベーションの期間は、宛先エンドポイントから返されるエラーの種類によって異なります。イベントサブスクリプションがプロベーション状態になっている場合、プロベーション状態になっていることが原因で発生したエラーコードに応じて、イベントが配信不能になるか、または配信を試行せずに破棄される可能性があります。

Error	プロベーションの期間
ビジー	10 秒
NotFound	5 分
SocketError	30 秒
ResolutionError	5 分
無効	5 分
[完全]	5 分
TimedOut	10 秒
権限がありません	5 分
Forbidden	5 分
InvalidAzureFunctionDestination	10 分

Note

Event Grid では、配信管理を強化するためにプロベーションの期間を使用していますが、この期間は将来変更される可能性があります。

CloudEvents 1.0 スキーマ

event

{
    "id": "caee971c-3ca0-4254-8f99-1395b394588e",
    "source": "mysource",
    "dataversion": "1.0",
    "subject": "mySubject",
    "type": "fooEventType",
    "datacontenttype": "application/json",
    "data": {
        "prop1": "value1",
        "prop2": 5
    }
}

配信不能イベント

{
    "id": "caee971c-3ca0-4254-8f99-1395b394588e",
    "source": "mysource",
    "dataversion": "1.0",
    "subject": "mySubject",
    "type": "fooEventType",
    "datacontenttype": "application/json",
    "data": {
        "prop1": "value1",
        "prop2": 5
    },

    "deadletterreason": "MaxDeliveryAttemptsExceeded",
    "deliveryattempts": 1,
    "lastdeliveryoutcome": "NotFound",
    "publishtime": "2020-08-13T21:21:36.4018726Z",
}

カスタムスキーマ

event

{
    "prop1": "my property",
    "prop2": 5,
    "myEventType": "fooEventType"
}

配信不能イベント

{
    "id": "8bc07e6f-0885-4729-90e4-7c3f052bd754",
    "eventTime": "2020-08-13T18:11:29.4121391Z",
    "eventType": "myEventType",
    "dataVersion": "1.0",
    "metadataVersion": "1",
    "topic": "/subscriptions/00000000000-0000-0000-0000-000000000000000/resourceGroups/rgwithoutpolicy/providers/Microsoft.EventGrid/topics/myCustomSchemaTopic",
    "subject": "subjectDefault",
  
    "deadLetterReason": "MaxDeliveryAttemptsExceeded",
    "deliveryAttempts": 1,
    "lastDeliveryOutcome": "NotFound",
    "publishTime": "2020-08-13T18:11:29.4121391Z",
    "lastDeliveryAttemptTime": "2020-08-13T18:11:29.4277644Z",
  
    "data": {
        "prop1": "my property",
        "prop2": 5,
        "myEventType": "fooEventType"
    }
}

メッセージの配信状態

Event Grid は、HTTP 応答コードを使用してイベントの受信を確認します。

成功コード

Event Grid は、次の HTTP 応答コードのみを正常な配信と見なします。その他のすべてのステータスコードは配信失敗と見なされ、必要に応じて再試行されるか、配信不能とされます。 Event Grid が正常な状態コードを受信すると、配信が完了したと見なされます。

200 OK
201 Created
202 Accepted
203 権限のない情報
204 No Content

エラーコード

上記のセット (200 ～ 204) にない他のすべてのコードはエラーと見なされ、再試行されます (必要に応じて)。一部には、以下で説明するように特定の再試行ポリシーが関連付けられていますが、他はすべて標準の指数的バックオフモデルに従います。重要な注意点としては、Event Grid のアーキテクチャは高度に並列化されているため、再試行の動作は非決定的です。

status code	再試行の動作
400 Bad Request	再試行されません
401 権限がありません	5 分以上後に、Azure のリソースエンドポイントに対して再試行
403 許可されていません	再試行されません
404 見つかりません	5 分以上後に、Azure のリソースエンドポイントに対して再試行
408 要求タイムアウト	2 分以上後に再試行
413 要求のエンティティが大きすぎます	再試行されません
503 サービス利用不可	30 秒以上後に再試行
その他すべて	10 秒以上後に再試行

カスタム配信のプロパティ

イベントサブスクリプションを使用すると、配信されたイベントに含まれる HTTP ヘッダーを設定できます。この機能を使用すると、宛先に必要なカスタムヘッダーを設定できます。イベントサブスクリプションを作成するときに、最大 10 個のヘッダーを設定できます。各ヘッダーの値は、4,096 (4 K) バイトより大きくすることはできません。次の宛先に配信されるイベントにカスタムヘッダーを設定できます。

Webhooks
Azure Service Bus のトピックとキュー
Azure Event Hubs
Relay ハイブリッド接続

詳細については、「カスタム配信のプロパティ」を参照してください。

次のステップ

イベント配信のステータスを表示するには、Event Grid によるメッセージの配信の監視に関する記事をご覧ください。
イベント配信オプションをカスタマイズするには、「配信不能と再試行に関する方針」を参照してください。

Event Grid によるメッセージの配信と再試行

再試行のスケジュール

再試行ポリシー

出力のバッチ処理

バッチ処理のポリシー

バッチ処理の動作

Azure portal:

Azure CLI

遅延配信

配信不能イベント

配信イベントの形式

Event Grid スキーマ

event

配信不能イベント

CloudEvents 1.0 スキーマ

event

配信不能イベント

カスタム スキーマ

event

配信不能イベント

メッセージの配信状態

成功コード

エラー コード

カスタム配信のプロパティ

次のステップ

その他のリソース

カスタムスキーマ

エラーコード