MID Hermes API 拡張機能

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間:5分
  • MID Hermes API は、MID サーバー を介した通信をHermesできるようにするMID サーバー拡張です。

    MID スクリプトインクルードと MID Hermes プロデューサー API を使用して、Hermesトピックにメッセージペイロードを送信します。MID スクリプトには、スクリプト可能な API インターフェイスを介して Hermes するプッシュデータが含まれるため、 ストリームコネクト は必要ありません。この拡張機能を使用するには、 ServiceNow MID Hermes API (com.glide.mid.hermes_api) プラグインをアクティブ化します。

    拡張コンテキストレコード

    MID Hermes API 拡張機能の構成の詳細は、コンテキストレコードに保存されます。コンテキストレコードは、拡張コンテキストが実行される MID サーバー を指定します。コンテキストレコードを作成したら、次の目的にも使用できます。
    • 拡張コンテキストのステータスを表示します。
    • 拡張コンテキストを開始、停止、および再起動します。
    • パラメーターを更新します。
    • 許可された Hermes トピックを表示し、トピックを編集または作成します。
    次の画像は、完成した MID Hermes API コンテキストレコードの例を示しています。

    入力された MID Hermes API コンテキストレコードのスクリーンショット

    統計情報

    MID Hermes API 拡張機能の統計情報を表示するには、次に移動します。 すべて > MID サーバー > 拡張 > MID Hermes API 統計情報 または、MID Hermes API 統計情報 [sys_mid_hermes_api_metric] テーブルに直接移動できます。

    このテーブルには、次の統計情報が含まれています。
    • バイト数:収集間隔中に生成されたバイト数。
    • 収集時間:収集間隔が終了した時間。
    • 収集間隔 (秒):収集間隔の長さ。デフォルトは 60 秒です。
    • メッセージ数:収集間隔中に生成されたメッセージの数。
    • MID Hermes API 拡張コンテキスト:メッセージの生成に使用される拡張コンテキストレコードの名前。
    • MID サーバー:拡張コンテキストを実行している MID サーバー への参照。
    • トピック:拡張コンテキストがメッセージを生成している Hermes トピックの名前。

    このテーブルのメトリクスは、(extension_context、トピック) ごとにメモリ内で収集され、60 秒ごとに継続的に集計されます。その後、それらは単一のバッチとして ServiceNow に送信されるため、メッセージごとに個別のレコードではなく、間隔ごとに一意のコンテキストトピックの組み合わせごとに 1 つのデータベースレコードになります。

    このテーブルには、データ保持ポリシーに基づいて古い統計情報レコードを自動的に消去するテーブルクリーナーがあり、テーブルが無制限に大きくなるのを防ぐのに役立ちます。

    アクセス証明書

    mTLS Hermes アクセス証明書には、トピック ACL が含まれています。MID サーバー が CSR を生成するときに、MID 拡張コンテキストテーブルの [topics_acl] フィールドの値が CSR の ACL として設定されます。CSR に署名する REST 呼び出しは MID 拡張コンテキストsys_idを渡すため、サーバーは ACL がコンテキスト構成と一致することを検証できます。

    Hermes アクセス証明書の ACL が MID 拡張コンテキストレコードの ACL と一致しない場合、MID サーバー は自動的に最大 3 回検証を再試行します。試行するたびに、 MID サーバー はインスタンスから最新の ACL を再フェッチします。最後の試行後も ACL が一致しない場合は、REST エラーが返され、ログに記録されます。

    MID 拡張コンテキストが開始されると、提供されるトピック ACL 文字列が、mTLS Hermes アクセス証明書の一部である文字列と比較されます。異なる場合は、正しい ACL を持つ新しい mTLS 証明書が生成されます。

    許可されたトピックが変更されると、ビジネスルールによって MID 拡張コンテキストが自動的に再起動されます。拡張が再起動中でも、新しい構成がロードされるまで、生成は古い構成で引き続き機能します。

    証明書の有効期限は 7 日間です。証明書が作成されると、5 日間のタイマーが、期限切れになる前にアクセス証明書の再要求を開始します。

    MID Hermes API 拡張機能の構成

    MID Hermes API 拡張機能を構成して、MID Hermes プロデューサー API が MID サーバー を介してHermesするメッセージを生成できるようにします。

    始める前に

    • 必要なロール:kafka_admin
    • MID サーバー を展開して起動します。
    • ServiceNow MID Hermes API (com.glide.mid.hermes_api) プラグインをアクティブ化します。

    手順

    1. 移動先 すべて > MID サーバー > 拡張 > MID Hermes API.
    2. [New (新規)] を選択します。
    3. フォームで、フィールドに入力します。
      表 : 1. [MID Hermes API コンテキスト] フォーム
      フィールド 説明
      名前 MID サーバー拡張コンテキストの名前。
      簡単な説明 MID サーバー 拡張コンテキストの説明。
      拡張 このコンテキストの MID サーバー 拡張の名前。このフィールドは自動的に [MID Hermes API 拡張機能] に設定されます。
      ステータス 拡張コンテキストの現在のステータス。このフィールドは自動的に設定されます。
      実行 この拡張コンテキストが実行される場所を示します。このフィールドは、自動的に [特定の MID サーバー] に設定されます。
      MID サーバー このコンテキストを実行する MID サーバー の名前。
      注:
      同じ MID サーバー を使用して複数のコンテキストレコードを作成することはできません (重複レコードは作成されません)。
      実行日 このコンテキストを実行している MID サーバー の名前。このフィールドは自動的に設定されます。
    4. [送信] を選択します。
    5. 新しく作成されたコンテキストレコードを MID Hermes API コンテキスト [ecc_agent_ext_context_mid_hermes_api] テーブルから選択します。
    6. [関連リンク] で、[ 開始] を選択します。
      拡張コンテキストが開始します。[ステータス] フィールドに [開始済み] が表示されます。

    次のタスク

    [許可されたトピック] タブで [新規] を選択して、Hermes トピックを追加します。新しいトピックを追加すると、そのトピックは作成およびリンクされるため、[ 許可されたトピック ] タブに表示されます。
    注:
    許可されたトピックのリストを変更すると、MID Hermes API コンテキストレコードは [ 再起動 中] ステータスになります。許可されたトピックの新しいリストは、レコードが [開始済み ] ステータスに戻った後に適用されます。