プラットフォームイベントの割り当て

一般的なプラットフォームイベントの割り当て

標準量プラットフォームイベントと大規模プラットフォームイベントには次の割り当てが適用されます。

大規模プラットフォームイベントのデフォルトの割り当て

組織にアドオンライセンスがない場合は、デフォルト割り当てがイベントの公開と配信に適用され、この割り当てを超えることはできません。デフォルトの割り当ては日単位で適用され、マルチテナント環境のリソースが均等に共有されてサービスが保護されます。公開割り当ては、Apex、API、フロー、プロセスなど、任意のメソッドを使用して公開できるイベントの数です。配信割り当ては、empApi Lightning コンポーネントなど、CometD サブスクライバーに配信できるイベント通知の数です。これには Apex トリガ、フロー、プロセスなど、CometD 以外のサブスクライバーは含まれません。さまざまな種類のサブスクライバーがいるため、配信割り当てよりも公開割り当ての方が多くなります。Apex トリガ、フロー、プロセスなど、CometD 以外のサブスクライバーに配信される公開済みイベントメッセージは、配信割り当てに反映されません。

CometD クライアントに配信されたイベント数は、登録されたクライアントごとに計数されます。複数のクライアントサブスクライバーがいる場合、使用量はすべてのサブスクライバーに対して追加されます。たとえば、デフォルトの割り当てが 24 時間で 50,000 件のイベントの Unlimited Edition の組織があるとします。数時間以内に、20,000 件のイベントメッセージが 2 つの登録済みクライアントに配信されます。40,000 件のイベントを消費したことになり、まだこの 24 時間の期間内に 10,000 件のイベントを配信できます。

デフォルトのイベント配信の割り当てを超えると、「403::Organization total events daily limit exceeded (組織の 1 日あたりの合計イベント数の制限を超えました)」のエラーが発生します。このエラーは、CometD サブスクライバーが最初に接続したときに Bayeux の /meta/connect チャネルで返されるか、既存のサブスクライバーの接続で返されます。詳細は、『ストリーミング API 開発者ガイド』の「ストリーミング API エラーコード」を参照してください。割り当てを超えた後に生成されたイベントメッセージは、イベントバスに保存されます。保存されたイベントメッセージは、72 時間の保持ウィンドウである限り取得できます。

大規模プラットフォームイベントのアドオンライセンスと使用量ベースのエンタイトルメント

組織にアドオンライセンスがある場合、CometD クライアントに配信されるイベントの割り当ては月次エンタイトルメントモデルに移行されます。アドオンにより、使用量ベースのエンタイトルメントとして、配信されるイベント通知の 24 時間の割り当てが 1 日ごとに 100,000 件増加します (1 か月ごとに 300 万件)。エンタイトルメントにより、割り当ての使用方法の選��肢が広がります。エンタイトルメントは、デフォルトの割り当てほど厳密には適用されません。エンタイトルメントにより、ある程度は 24 時間のイベント配信割り当てを超えることができます。エンタイトルメントは、契約開始日以降、毎月リセットされます。エンタイトルメントの使用量は本番組織でのみ計算されます。Sandbox またはトライアル組織では使用できません。詳細は、「使用量ベースのエンタイトルメント項目」を参照してください。

Salesforce は、契約開始日から始まるカレンダー月に基づいてイベント超過を監視します。月次エンタイトルメントを超えた場合、Salesforce からイベント使用量のニーズについて話し合うために連絡します。月次イベント超過を監視するために使用されるエンタイトルメントは、日次割り当てに 30 を掛けた値です。

アドオンライセンスを購入すると、1 時間のイベント公開割り当てが 1 時間あたり 25,000 件のイベントが増加します。

公開できるイベントメッセージの最大サイズは 1 MB です。イベントオブジェクトに数百件のカスタム項目または多数のロングテキストエリア項目が含まれる場合、この制限に達する可能性もあります。この場合、公開コールでエラーが発生します。

割り当てに対する大規模イベントの利用状況の監視

組織のイベントの利用状況を確認する方法を確認してください。

limits REST リソースにより返される利用制限値についての詳細は、『REST API 開発者ガイド』の「制限」および「組織の制限をリストする」を参照してください。

PlatformEventUsageMetric を使用した 24 時間および 1 日ごとのイベント利用状況の監視

イベント公開および CometD クライアントの配信の利用状況データを取得するには、PlatformEventUsageMetric オブジェクトを照会します。PlatformEventUsageMetric に保存されている利用状況総計値は、REST API 制限値から切り離されています。REST API limits リソースでは、プラットフォームイベントと変更データキャプチャイベントの最大および残りの割り当てが返されます。PlatformEventUsageMetric には、プラットフォームイベントと変更データキャプチャイベントの種別ごとに分類された実際のイベントの利用状況データが含まれます。

PlatformEventUsageMetric の利用状況データでは、前の正時までの過去 24 時間の利用状況データと、過去 45 日間の 1 日ごとの利用状況の履歴データを使用できます。PlatformEventUsageMetric を使用して、利用状況のトレンドを表示します。

詳細は、「プラットフォームイベントの公開および配信の使用状況を監視する」を参照してください。

REST API を使用した 1 時間のイベント配信の利用状況の監視

組織のイベント配信の 1 時間の利用状況を監視するには、limits リソースへの REST API コールを 1 時間ごとに実行します。過去 2 時間に取得された各結果の差は、過去 1 時間に配信されたイベントの数を示します。

たとえば、午後 12 時にコールを実行し、40,000 件のイベントが残っていることを確認したとします。次に、午後 1 時に同じコールを実行し、38,500 件のイベントが残っていることを確認しました。この返された応答は、午後 12 時から午後 1 時の間に 1,500 件のイベントが CometD サブスクライバーに配信されたことを示します。

次の結果は、/services/data/v47.0/limits URI への GET 要求で返される応答の例を示しています。

1First call result:
2{
3...  
4"MonthlyPlatformEvents" : {
5    "Max" : 50000,
6    "Remaining" : 40000
7  },
8
9...
10}
11 
12Second call result:
13{
14...  
15"MonthlyPlatformEvents" : {
16    "Max" : 50000,
17    "Remaining" : 38500
18  },
19
20...
21}

標準量プラットフォームイベントの割り当て

API バージョン 44.0 以前で定義された標準量イベントの割り当てを次に示します。

イベント配信割り当てを超えると、403::Organization total events daily limit exceeded (組織の 1 日あたりの合計イベント数の制限を超えました) のエラーが発生します。このエラーは、CometD サブスクライバーが最初に接続したときに Bayeux の /meta/connect チャネルで返されるか、既存のサブスクライバーの接続で返されます。詳細は、『ストリーミング API 開発者ガイド』の「ストリーミング API エラーコード」を参照してください。割り当てを超えた後に生成された標準規模のイベントメッセージは、イベントバスに保存されます。保存された標準規模のイベントメッセージは、24 時間の保持ウィンドウ内にある限り取得できます。

標準量イベント配信の使用状況を監視するには、limits REST API リソースを使用して、DailyStandardVolumePlatformEvents 値を調べます。公開の利用状況を監視するには、HourlyPublishedStandardVolumePlatformEvents 値を調べます。詳細は、『REST API 開発者ガイド』の「組織の制限をリストする」を参照してください。

¹CometD クライアントに配信する標準規模のイベント数の増加を要求する場合は、Salesforce に連絡してアドオンライセンスを購入してください。アドオンライセンスは、配信されるイベントの 1 日の制限を 100,000 イベントずつ増加します。たとえば、Unlimited Edition の場合、アドオンライセンスによって、配信されるイベントの 1 日の制限が 50,000 から 150,000 イベントに増加します。複数のアドオンを購入することで、CometD クライアントのイベント要件を満たすことができます。リリースの問題とサービスの低下を回避するため、CometD クライアントに配信するイベントの数を 1 日あたり 500 万以内に抑えることをお勧めします。これ以上の外部イベントが必要な場合は、Salesforce 担当者に連絡し、製品をどのように拡張すればニーズを満たすことができるかを確認してください。