1. Homepage
  2. Runtime Manager
  3. Runtime Manager エージェント
  4. エージェント API

  5. Runtime Manager エージェント通知

Runtime Manager エージェント通知

logo server active Private Cloud Edition

Anypoint Runtime Manager エージェントは、Mule インスタンスで発生するイベントに関する通知を JSON 形式でパブリッシュします。 これによって、通知を受信および処理するシステムを実装できます。 通知は REST および WebSocket トランスポートの両方で送信されます。 トランスポートについての詳細は、​「Runtime Manager エージェントのアーキテクチャ」​を参照してください。

エージェント通知のコールバック URL の設定

Runtime Manager エージェント通知を REST トランスポートで特定の URL に転送するには、​mule-agent.yml​ ファイルで ​callback​ URL を設定してください。

callback​ URL を設定する手順は次のとおりです。

  1. mule-agent.yml​ ファイルに ​callback​ URL を追加します。

    transports:
  rest.agent.transport:
    enabled: true
    callback:
      url: http://localhost:8080/
    port: 8888

    port​ と ​url​ の値は、通知を受け取る外部サーバーによって異なります。

    URL の末尾には URL へのパスがエージェントによって付加されるため、設定する URL の最後はスラッシュ (​/​) である必要があります。

  2. Mule Runtime Engine を再起動します。

アプリケーションデプロイメントの通知

アプリケーションのデプロイ中またはアンデプロイ中に状態が変化するたびに、Runtime Manager エージェントから通知が送信されます。通知は ​PUT​ 要求によって ​applications/<appname>/deployment​ パスに送信されます。

PUT <callback URL>/applications/<application name>/deployment HTTP/1.1

通知の例

{
  "application": {
    "name": "applicationName",
    "domain": "domainName",
    "state": "STARTED"
  },
  "status": "DEPLOYED",
  "message": "Application successfully deployed."
}

通知の項目

各アプリケーションデプロイメントの通知の項目は次のとおりです。

項目 説明

application

アプリケーションに関する次の情報が含まれます。

  • アプリケーション名

  • アプリケーションがデプロイされるドメインの名前

  • アプリケーションの現在の状態

アプリケーションの全状態のリストは、「​アプリケーションの状態とデプロイメントの状況​」セクションを参照してください。

status

デプロイメントの現在の状況。デプロイメント操作の完了後、メッセージは ​DEPLOYED​ のまま変わりません。アンデプロイメント操作の後、メッセージは ​UNDEPLOYED​ のまま変わりません。

すべての状況メッセージのリストは、「​アプリケーションの状態とデプロイメントの状況​」セクションを参照してください。

message

現在のデプロイメントフェーズについての情報メッセージ。デプロイメントが失敗した場合、失敗の理由についての情報がこのメッセージ含まれます。

ドメインデプロイメントの通知

ドメインのデプロイ中またはアンデプロイ中に状態が変化するたびに、Runtime Manager エージェントから通知が送信されます。

通知は PUT 要求によって ​domains/<domainname>/deployment​ パスに送信されます。

PUT <callback URL>/domains/<domain name>/deployment HTTP/1.1

通知の例

"domain": {
    "name": "domainName",
    "applications": [
      {
        "name": "application1",
        "domain": "domainName",
        "state": "STARTED"
      },
      {
        "name": "application2",
        "domain": "domainName",
        "state": "STOPPED"
      },
    ]
  },
  "status": "DEPLOYED",
  "message": "Domain successfully deployed."
}

通知の項目

各ドメインデプロイメントの通知の項目は次のとおりです。

項目 説明

domain

ドメインに関する次の情報が含まれます。

  • ドメイン名

  • 次を含む、ドメインにデプロイされたアプリケーションのリスト。

    • アプリケーション名

    • ドメイン名

    • アプリケーションの状況

status

デプロイメントの現在の状況。デプロイメント操作の完了後、メッセージは ​DEPLOYED​ のまま変わりません。アンデプロイメント操作の後、メッセージは ​UNDEPLOYED​ のまま変わりません。

すべての状況メッセージのリストは、「​アプリケーションの状態とデプロイメントの状況​」セクションを参照してください。

message

現在のデプロイメントフェーズについての情報メッセージ。デプロイメントが失敗した場合、失敗の理由についての情報がこのメッセージ含まれます。

キープアライブ通知

Runtime Manager エージェントは、定期的にキープアライブ通知を送信し、Mule インスタンスがまだ実行中であることを確認します。通知は、​POST​ 要求に空の本文を含めて ​keepAlive​ パスに送信されます。

POST <callback URL>/keepAlive HTTP/1.1

アプリケーションの状態とデプロイメントの状況

アプリケーション状態

アプリケーションの状態は、Mule アプリケーションのライフサイクルのさまざまなフェーズを表します。

アプリケーションの状態のリストについては、​「アプリケーションの状況の状態」​を参照してください。

デプロイメントの状況

デプロイメントの状況は、アプリケーションまたはドメインの正常なデプロイメントまたはアンデプロイメントのさまざまなステップを表します。

有効なデプロイメントの状況のリストについては、​「アプリケーションのデプロイメントの状態」​を参照してください。

関連情報