MID Web サービスイベントコレクターコンテキストの設定

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:7分
  • MID Web サービスイベントコレクターコンテキストを設定して、URL メソッドで外部ソースからのイベントメッセージを MID サーバー にプッシュできるようにします。

    始める前に

    イベント管理 Connectors (sn_em_connector) プラグインが Now Platform インスタンスにインストールされていることを確認します。

    必要なロール:evt_mgmt_admin

    このタスクについて

    外部ソースからのイベントメッセージを MID サーバー にプッシュするためのデフォルトの URL 形式は、http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2 です。この URL は良好なパフォーマンスで動作します。

    外部ソースからの jsonv2 形式以外のイベントメッセージをプッシュするための URL 形式は http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event?Transform={Name_of_Transform_Script} です。ここで、{Name_of_Transform_Script} 変数は、スクリプトのフルネームで、常にテキスト「TransformEvents_」で始まります。

    たとえば、次の値を想定します。
    • {MID_Server_IP}:10.118.69.27
    • {MID_Web_Server_Port}:8097
    • 変換スクリプト名:EventsToProcess
    この結果として使用される URL:http://10.118.69.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess
    注:
    • http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/{transform_script_name} 形式の URL もサポートされています。
    • イベントの日付形式は、yyyy-M-d h:mm:ss です

      日付形式が異なるイベントを受信した場合は、受信イベントの日付形式に適した {transform_script_name} を使用する必要があります。そうしないと、イベントは正しく処理されません。

      たとえば、2019/06/27/ 11:25:00 a という日付が記載されたイベントが 2019 年 6 月 27 日、午前 11:25 に到達した場合は、受信したイベントの形式に合わせて、yyyy/MM/dd/ HH:mm:ss a の日付形式で {transform_script_name} を使用します。

    手順

    1. 移動先 すべて > イベント管理 > 統合 > MID Web サービスイベントリスナー.
    2. [MID Web サービスイベントコレクタ―コンテキスト] リストで、[新規] をクリックします。
    3. フォームのフィールドに入力します。
      表 : 1. [MID Web サービスイベントコレクタ―コンテキスト] フォーム
      フィールド 説明
      名前 このコレクターを簡単に識別するための一意の名前。
      簡単な説明 Enter a brief, meaningful description of this collector.
      MID Web サーバー拡張 MID Web サーバー拡張を指定してから開始します。サポートされている認証方法は、MID Web サーバー拡張の [認証タイプ] フィールドに一覧表示されます。MID Web サーバー拡張の設定方法の詳細については、「MID Web サーバーの設定」を参照してください。
      ステータス このフィールドには、MID Web サーバー拡張のステータスが自動的に設定されます。MID Web サーバー拡張が開始されるまで、このフィールドは空白です。MID Web サーバー拡張に対してコマンドを発行すると、次のいずれかの値が表示されます。
      • 開始:コレクターは実行中です。
      • 停止:コレクターは実行されていません。
      • オフラインMID サーバー は停止しています。
      • エラー:エラーのためコレクターが失敗しました ([エラーメッセージ] にエラーメッセージが表示されます)。
      • 警告:ランタイム例外が発生しました。
      実行日 指定された MID Web サーバー拡張で定義されている [特定の MID サーバー] または [特定の MID サーバークラスター]
      MID サーバー 指定された MID Web サーバー拡張で定義されている [特定の MID サーバー] または [特定の MID サーバークラスター]
      実行日 MID Web サーバー拡張が実行されている MID サーバー の名前。
    4. フォームヘッダーを右クリックし、 [保存] をクリックします。
    5. [関連リンク] の下の [開始] をクリックしてコレクターを開始します。
      表 : 2. イベント管理 コンテキストフォームのコマンド
      関連リンク 説明
      開始 コレクターが実行されていない場合、コレクターを開始します。このアクションで、 イベント管理 アプリケーションを備えた WEB サービス API エンドポイントが MID サーバー で実行中であることを確認します。
      停止 設定された MID サーバー 上で実行中のコレクターを停止します。コレクターが実行されていない場合、アクションは実行されません。
      再起動 設定された MID サーバー 上でコレクターを停止してから開始します。
      パラメーターの更新 更新されたパラメーターをコレクタに送信します。イベント管理 MID サーバー コンテキスト拡張が更新されると、パラメーターも更新されます。コレクタが実行されていないときにこのコントロールをクリックすると、更新は行われません。

    JSON v2 形式のイベントメッセージを変換するための URL の使用方法の説明

    JSON v2 形式のイベントメッセージが MID サーバー に送信されるものとします。jsonv2 URL を使用する場合、スクリプトインクルードを使用する必要はありません。

    表 : 3. JSON v2 のデータの例
    フィールド
    MID_Server_IP 10.218.64.27
    MID_Web_Server_Extension_Port 8097
    イベントメッセージ形式 jsonv2

    デフォルト形式の URL http://<my-instance>.service-now.com/api/global/em/jsonv2 の変数は、前出のテーブルからの値「http://10.218.64.27:8097/api/global/em/jsonv2」に置き換えられます。

    jsonv2 形式以外のメッセージをプッシュするための URL を示す例

    外部ソースからの jsonv2 形式以外のイベントメッセージをプッシュするための URL の形式は、http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/inbound_event/Transform={Name_of_Transform_Script} です。ここで、{Name_of_Transform_Script} 変数は、スクリプトのフルネームで、常にテキスト「TransformEvents_」で始まります。スクリプト名は、Transform ヘッダーパラメーターとして指定する必要があり、常にプリフィックス「TransformEvents_」で始まる必要があります。

    この例では、スクリプト名を EventsToProcess と仮定しているため、URL は http://10.138.64.27:8097/api/mid/em/inbound_event/TransformEvents_EventsToProcess となります。

    JSON v2 形式のイベントメッセージを示す例
    注:
    以下のテキストをコピーして貼り付けると、隠し文字もコピーされることがあり、予期しない結果を招くおそれがあります。
    
    curl -v -H "Accept: application/json" -H "Content-Type: application/json" -X POST --data "{
        "records":
        [ {
             \"source\" : \"Simulated\",
            \"node\" : \"nameofnode\",
            \"type\" : \"High Virtual Memory\",
            \"resource\" : \"C:\",
            \"severity\" : \"5\",
            \"description\" : \"Virtual memory usage exceeds 98%\",
            \"ci_type\":\"cmdb_ci_app_server_tomcat\",
            \"additional_info\":\"{\\\"name\\\":\\\"My Airlines\\\"}\"
          },
          {
          \"source\" : \"Simulated\",
          \"node\" : \"01.myairlines.com\",
          \"type\" : \"High CPU Utilization\",
          \"resource\" : \"D:\",
          \"severity\" : \"5\",
          \"description\" : \"CPU on 01.my.com at 60%\"
          }
       ]
    }" -u UserName:Password http://{MID_Server_IP}:{MID_Web_Server_Port}/api/mid/em/jsonv2