trigger イベントを AWS EventBridge に送信する

項目一覧

手順

MongoDB パートナーイベントソースを設定する
trigger の構成
trigger イベントソースとイベントバスの関連付け
カスタムエラー処理
新しいカスタムエラーハンドラーの作成
Error Handler Parameters
エラーコード
エラーハンドラーログ
サンプルイベント
パフォーマンスの最適化

MongoDBは AWS Eventbridge を提供します提携するイベントソースを使用すると、Atlas Functionを呼び出す代わりに Atlas trigger イベントをイベントバスに送信できます。イベントを EventBridge に送信するには、任意の trigger タイプを構成できます。データベーストリガーは、非致命的なエラーによる trigger の停止を減らすために、カスタムエラー処理もサポートしています。

triggerイベントを EventBridge に送信するために必要なものはすべて、 Amazon Web ServicesアカウントIDです。このガイドでは、アカウントIDの検索、trigger の構成、triggerイベントソースとイベントバスの関連付け、カスタムエラー処理の設定について説明します。

注意

公式 AWS パートナーイベントソースガイド

このガイドは、SaaS パートナーからの Amazon の受信イベントに基づいていますドキュメント。

手順

注意

EventBridge triggerイベントの個々のエントリは 256 KB より小さくなければなりません。

PutEventsエントリのサイズを小さくする方法については、「パフォーマンスの最適化」セクションを参照してください。

MongoDB パートナーイベントソースを設定する

triggerイベントをAWS Eventbridge に送信するには、イベントを受信するアカウントのAWS account ID {0 が必要です。

Amazon EventBridge コンソールを開きますナビゲーションPartner event sources メニューで [ ] をクリックします。
MongoDB提携するイベントソースを検索し、[ Set up ] をクリックします。
MongoDB提携するイベントソースのページからCopy [] をクリックして、Amazon Web Services IDアカウントをクリップボードにコピーします。

trigger の構成

AWS account ID が取得されたら、データベースtriggerまたは予定されたtriggerを構成して、イベントを EventBridge に送信できます。

Atlas UIまたは App Services CLI を使用して trigger を構成できます。

Atlas UIで、次の設定で新しいデータベースtriggerまたは予定さtriggerたトリガーを作成し、構成します。

イベントタイプとしてEventBridgeを選択します。
EventBridge からコピーしたAWS Account IDを貼り付けます。
trigger イベントを送信するAWS Regionを選択します。
注意
サポート対象の AWS リージョン
サポートされているAmazon Web Services リージョンの完全なリストについては、Amazon SaaS パートナーからのの受信イベントを参照してくださいガイドを参照してください。
（データベース trigger のみの任意） trigger エラーを処理する関数を構成します。
詳細については、このページの「カスタムエラー処理」セクションを参照してください。
クリックして拡大します
拡張JSONを有効にするには、 Advanced (Optional)セクションでEnable Extended JSON設定を切り替えます。
デフォルトでは、trigger はイベントオブジェクト内のBSON typesを標準のJSON型に変換します。
拡張JSONを有効にすると、代わりにイベントオブジェクトが拡張JSON形式に直列化されることで、 BSON type 情報が保持されます。これにより、読みやすさと相互運用性を犠牲にして、型情報が保持されます。

MongoDB Atlas ユーザーの認証
MongoDB Atlas Administration APIキーを使用して、App Services CLI にログします。
```
appservices login --api-key="<API KEY>" --private-api-key="<PRIVATE KEY>"
```
アプリの最新の構成ファイルを取得する
次のコマンドを実行して、構成ファイルのローカルコピーを取得します。
```
appservices pull --remote=<App ID>
```
デフォルトでは、コマンドは現在の作業ディレクトリにファイルをプルします。任意の--localフラグを使用してディレクトリパスを指定できます。
ローカルの/triggersディレクトリに trigger構成ファイルを作成します。 function_nameフィールドを省略し、 AWS_EVENTBRIDGEイベントプロセッサを定義します。
account_idフィールドに、EventBridge からコピーしたAWS Account IDを設定します。
regionフィールドをAmazon Web Servicesリージョンに設定します。
注意
サポート対象の AWS リージョン
サポートされているAmazon Web Services リージョンの完全なリストについては、Amazon SaaS パートナーからのの受信イベントを参照してくださいガイドを参照してください。
拡張 JSON を有効にするには、 extended_json_enabledフィールドをtrueに設定します。
デフォルトでは、trigger はイベントオブジェクト内のBSON typesを標準のJSON型に変換します。
拡張JSONを有効にすると、代わりにイベントオブジェクトが拡張JSON形式に直列化されることで、 BSON type 情報が保持されます。これにより、読みやすさと相互運用性を犠牲にして、型情報が保持されます。
（データベース trigger のみの任意） trigger エラーを処理する関数を構成します。
詳細については、このページの「カスタムエラー処理」セクションを参照してください。

trigger の構成ファイルは、次のようになります。

{
   "name": "...",
   "type": "...",
   "event_processors": {
      "AWS_EVENTBRIDGE": {
         "config": {
            "account_id": "<AWS Account ID>",
            "region": "<AWS Region>",
            "extended_json_enabled": <boolean>
         }
      }
   }
}

trigger イベントソースとイベントバスの関連付け

EventBridge コンソールに戻ります。

ナビゲーションペインでパートナーイベントソースを選択します。
Partner event sourcesテーブルで、 Pending trigger ソースを検索及び選択し、 Associate with event busをクリックします。
Associate with event bus画面で、他のアカウントと組織に必要なアクセス権限を定義し、 Associateをクリックします。

関連付けが確認されると、triggerイベントソースのステータスがPendingからActiveに変わり、イベントイベント名と一致するように更新されます。その提携するイベントソースのイベントでtriggerするルールを作成できるようになりました。

詳細については、「 SaaS パートナーイベントでトリガーするルールの作成」を参照してください。

カスタムエラー処理

注意

データベーストリガーのみがカスタムエラーハンドラーをサポートします

現在、データベーストリガーのみがカスタムエラー処理をサポートしています。認証トリガーと予定されたトリガーは、現時点ではカスタムエラー処理をサポートしていません。

再試行が成功しない場合に trigger が失敗したときに実行するエラーハンドラーを作成できます。カスタムエラー処理を使用すると、 AWS Eventbridgeからのエラーがtriggerを一時停止するのに十分であるか、またはエラーを無視して他のイベントの処理を続行できるかどうかを判断できます。

一時停止されたデータベース trigger の詳細については、「一時停止された trigger 」を参照してください。

新しいカスタムエラーハンドラーの作成

App Services CLI を使用して、または App Services Admin APIを通じて Atlas UIに新しいエラーハンドラーを作成できます。

この手順では、 Create a Triggerページで新しい関数を直接作成する方法について説明します。

Functionsページから関数を作成することもできます。 Atlas で関数を定義する方法の詳細については、「関数の定義」を参照してください。

新しいエラーハンドラーの作成

Create a TriggerページのConfigure Error Functionセクションから、 + NewFunctionを選択します。

また、ドロップダウンから関数がすでに定義されている場合は、既存の関数を選択することもできます。

新規関数の命名

Nameフィールドに関数の一意の識別名を入力します。この名前は、アプリケーション内の他のすべての関数と異なる必要があります。

関数コードの書込み

Functionセクションでは、関数エディターでJavaScriptコードを直接記述します。関数エディターには、必要に応じて編集できるデフォルトの関数が含まれています。関数の作成の詳細については、関数のドキュメントを参照してください。

関数をテストする

Testing Console関数エディターの下のタブでは、テストコンソールのコメントに示されているように、パラメーターとerror changeEventパラメーターに例値を渡すことで関数をテストできます。

これらのパラメーターの詳細については、このページの「エラーハンドラーパラメーター」セクションを参照してください。

テストを実行するには、 Runをクリックします。

関数の保存

カスタムエラーハンドラーが満足できるものになったら、[ Save ] をクリックします。

App Services CLI を使用して、エラーハンドラーで trigger の構成を更新できます。詳しくは、「アプリの更新手順」を参照してください。

MongoDB Atlas ユーザーの認証

MongoDB Atlas Administration APIキーを使用して、App Services CLI にログします。

appservices login --api-key="<API KEY>" --private-api-key="<PRIVATE KEY>"

アプリの最新の構成ファイルを取得する

次のコマンドを実行して、構成ファイルのローカルコピーを取得します。

appservices pull --remote=<App ID>

デフォルトでは、コマンドは現在の作業ディレクトリにファイルをプルします。任意の--localフラグを使用してディレクトリパスを指定できます。

エラーハンドラーを記述する

関数の定義の手順に従って、エラーハンドラーのソースコードと構成ファイルを記述します。

の例としては、次のテンプレートエラーハンドラーを参照してください。

<functionName>.js

exports = async function(error, changeEvent) {
   // This sample function will log additional details if the error is not
   // a DOCUMENT_TOO_LARGE error
   if (error.code === 'DOCUMENT_TOO_LARGE') {
      console.log('Document too large error');
      // Comment out the line below in order to skip this event and not suspend the Trigger
      throw new Error('Encountered error: ${error.code}');
   }
   console.log('Error sending event to EventBridge');
   console.log('DB: ${changeEvent.ns.db}');
   console.log('Collection: ${changeEvent.ns.coll}');
   console.log('Operation type: ${changeEvent.operationType}');
   // Throw an error in your Function to suspend the Trigger
   // and stop processing additional events
   throw new Error('Encountered error: ${error.message}');
};

関数の作成の詳細については、「関数」を参照してください。

エラーハンドラーをtrigger構成に追加する

Triggersフォルダー内の trigger構成ファイルにerror_handler属性を追加します。

trigger の構成ファイルは、次のようになります。

<triggerName>.json

      {
         "name": "...",
         "type": "DATABASE",
         "event_processors": {
            "AWS_EVENTBRIDGE": {
               "config": {
                  "account_id": "<AWS Account ID>",
                  "region": "<AWS Region>",
                  "extended_json_enabled": <boolean>
               }
            }
         },
         "error_handler": {
            "config": {
               "enabled": <boolean>,
               "function_name": "<Error Handler Function Name>"
            }
         }
      }

詳細については、「 trigger 構成ファイル」を参照してください。

変更を配置する

次のコマンドを実行して、変更を配置します。

appservices push

注意

この手順では、App Services Admin APIエンドポイントを参照します。 Atlas Administration APIエンドポイントは使用されません。

MongoDB Atlas ユーザーの認証

MongoDB Atlas Administration APIキーペアを使用して Login エンドポイントを呼び出します。

curl -X POST \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "username": "<Public API Key>",
    "apiKey": "<Private API Key>"
  }'

認証に成功すると、レスポンス本文にはaccess_token値を持つ JSON オブジェクトが含まれます。

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

access_tokenは App Services Admin APIへのアクセスを許可します。すべての App Services Admin APIリクエストのAuthorizationヘッダーに Bearer トークンとして含める必要があります。

Tip

以下も参照してください。

App Services Admin API認証に関するドキュメント

配置案の作成（任意）

配置案は、単一のユニットとして配置または破棄できるアプリケーション変更のグループを表します。配置案を作成しない場合、更新は自動的に個別に配置されます。

配置案を作成するには、配置案を作成するエンドポイントに本文を入れずにPOSTリクエストを送信します。

curl -X POST 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access_token>'

エラーハンドラー関数の作成

新しい関数の作成AWS Eventbridgetrigger POSTエンドポイントへのリクエスト、失敗したのエラーを処理する関数を作成します。

curl -X POST \
   https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/functions \
   -H 'Authorization: Bearer <access_token>' \
   -d '{
         "name": "string",
         "private": true,
         "source": "string",
         "run_as_system": true
      }'

AWS Eventbridge trigger作成する

エンドポイントの作成 AWS EventbridgetriggerエンドポイントへのPOST リクエストにより、エラー処理が有効になっているを作成します。trigger

curl -X POST \
   https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/triggers \
   -H 'Authorization: Bearer <access_token>' \
   -d '{
         "name": "string",
         "type": "DATABASE",
         "config": {
            "service_id": "string",
            "database": "string",
            "collection": "string",
            "operation_types": {
               "string"
            },
            "match": ,
            "full_document": false,
            "full_document_before_change": false,
            "unordered": true
         },
         "event_processors": {
            "AWS_EVENTBRIDGE": {
               "account_id": "string",
               "region": "string",
               "extended_json_enabled": false
            },
         },
         "error_handler": {
            "enabled": true,
            "function_id": "string"
         }
      }'

変更を配置する

配置案を作成した場合は、配置案を配置案に含まれるすべての変更を配置できPOST 。

最初のステップとして配置案を作成しなかった場合、個々の関数と trigger のリクエストは自動的に配置されます。

curl -X POST \
'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/drafts/{draftId}/deployment' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <access_token>' \

Error Handler Parameters

デフォルトのエラーハンドラーには、 errorとchangeEventの 2 つのパラメータがあります。

`error`

次の 2 つの属性を持つ。

code: エラーが発生した EventBridge put リクエストのコード。エラーハンドラーで使用されるエラーコードのリストについては、このページの「エラーコード」セクションを参照してください。
message: エラーが発生した EventBridge put リクエストからのフィルタリングされていないエラーメッセージ。

`changeEvent`

EventBridge によって行われたデータに対するリクエストされた変更。変更イベントの種類とその構成の詳細については、「変更イベントタイプ」を参照してください。

エラーコード

EventBridge からエラーを受信した場合、イベントプロセッサはエラーをDOCUMENT_TOO_LARGEまたはOTHERとして解析します。この解析されたエラーは、 errorパラメーターを介してエラーハンドラー関数に渡されます。

`DOCUMENT_TOO_LARGE`

EventBridge triggerイベントのエントリが 256 KB を超えると、EventBridge はエラーをスローします。エラーには次のいずれかが含まれます。

ステータスコード:400 とtotal size of the entries in the request is over the limit 。
ステータスコード:413 は、ペイロードが大きすぎることを示します。

エントリサイズを縮小する方法の詳細については、「パフォーマンスの最適化」を参照してください。

`OTHER`

その他のすべてのエラーのデフォルトのバケット。

Tip

他のコードによるエラーのエラー処理の最適化

最も一般的なエラーメッセージに対して特別なエラー処理ケースを作成して、 OTHERコードでエラーのエラー処理を最適化できます。どのエラーに特殊なケースが必要かを判断するには、 error.messageで表示される最も一般的なエラーメッセージを追跡することをお勧めします。

エラーハンドラーログ

EventBridgetrigger エラーハンドラーのtrigger trigger は、アプリケーションログで表示できます。

Atlas UIのTriggersページから、 Logsタブを選択します。

すべてのログはデフォルトで表示されます。エラーハンドラーのログのみを表示するには、 Show errors onlyトグルをクリックします。

すべてのエラーハンドラーログを表示するには、 trigger_error_handler値を--typeフラグに渡します。

appservices logs list --type=trigger_error_handler

注意

この手順では、App Services Admin APIエンドポイントを参照します。 Atlas Administration APIエンドポイントは使用されません。

App Services ログの取得エンドポイントへのGETリクエストを使用して、 TRIGGER_ERROR_HANDLERタイプのログを取得します。

curl -X GET 'https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps/{appId}/logs' \
   -H 'Content-Type: application/json' \
   -H 'Authorization: Bearer <access_token>'
   -d '{
      "type": "TRIGGER_ERROR_HANDLER"
      }'

アプリケーションログの表示の詳細については、「アプリケーションログの表示」を参照してください。

サンプルイベント

trigger次のオブジェクトは、イベントをに送信し、エラーを処理するAWS Eventbridge を構成します。

"event_processors": {
   "AWS_EVENTBRIDGE": {
      "config": {
         "account_id": "012345678901",
         "region": "us-east-1"
      }
   }
},
 "error_handler": {
   "config": {
      "enabled": true,
      "function_name": "myErrorHandler.js"
   }
}

パフォーマンスの最適化

EventBridge triggerイベントの個々のエントリは 256 KB より小さくなければなりません。

詳細については、「Amazon Web Services のドキュメント」を参照してAmazon putEventsイベントエントリサイズを計算します。データベーストリガーを使用する場合、プロジェクト式には指定されたフィールドのみを含めることができるため、 EventBridge にメッセージを送信する前にドキュメントサイズを縮小できます。プロジェクト式の詳細については、データベースtriggerプロジェクト式のドキュメントを参照してください。

戻る

trigger を無効にする

関数

注意

公式 AWS パートナー イベント ソース ガイド

手順

注意

MongoDB パートナー イベント ソースを設定する

trigger の構成

注意

サポート対象の AWS リージョン

注意

サポート対象の AWS リージョン

trigger イベントソースとイベント バスの関連付け

カスタムエラー処理

注意

データベーストリガーのみがカスタムエラーハンドラーをサポートします

新しいカスタム エラー ハンドラーの作成

新しいエラー ハンドラーの作成

新規関数の命名

関数コードの書込み

関数をテストする

関数の保存

MongoDB Atlas ユーザーの認証

アプリの最新の構成ファイルを取得する

エラー ハンドラーを記述する

エラー ハンドラーをtrigger構成に追加する

変更を配置する

注意

MongoDB Atlas ユーザーの認証

Tip

以下も参照してください。

配置案の作成（任意）

エラー ハンドラー関数の作成

AWS Eventbridge trigger作成する

変更を配置する

Error Handler Parameters

error

changeEvent

エラー コード

DOCUMENT_TOO_LARGE

OTHER

Tip

他のコードによるエラーのエラー処理の最適化

エラー ハンドラー ログ

注意

サンプル イベント

パフォーマンスの最適化

公式 AWS パートナーイベントソースガイド

MongoDB パートナーイベントソースを設定する

trigger イベントソースとイベントバスの関連付け

新しいカスタムエラーハンドラーの作成

新しいエラーハンドラーの作成

エラーハンドラーを記述する

エラーハンドラーをtrigger構成に追加する

エラーハンドラー関数の作成

`error`

`changeEvent`

エラーコード

`DOCUMENT_TOO_LARGE`

`OTHER`

エラーハンドラーログ

サンプルイベント