HTTP API エクスポーター

HTTP API Exporterは、Nexthinkから取得した生データとインサイトを、CMDBやSIEM、IT Ops、AI Ops、ログ、モニタリングなどのオペレーションツールにエクスポートすることで、職場の技術体験を向上させます。

Nexthink APIデータのエクスポートをサードパーティツールと統合することで、データを組み合わせ、集約し、操作して以下のことを可能にします:

  • 特定の指標の時間経過による変化を用いて、強力な最新の可視化を作成します。

  • データの粒度の一貫性を確保します。

  • 複数のソースからデータを組み合わせ、コンプライアンスとセキュリティ基準を満たします。

  • 変更時および変更後の構成アイテムの自動更新を行います。

全体として、HTTP API Exporterは、サービス使用状況の理解を深めることで、組織のコストを削減することを目指しています。例えば、サービスデスクの時間を節約することができます。

前提条件

この統合には以下が必要です:

  • システムがJSONペイロードを介して複数の記録を送信できる公開APIを持つサードパーティツール。

  • サードパーティーツールAPIに接続するための認証メカニズムは、BASIC, Bearer Tokenまたは(Client Credential) OAuth 2.0 のいずれかでなければなりません。

  • 公開APIサードパーティツールのJSONペイロードは以下の形式のいずれかをサポートする必要があります:

    • JSONオブジェクトのコレクション:

      {"property_a":"value_a", "property_b":"value_b"}
      {"property_c":"value_c", "property_d":"value_d"}
      {"property_e":"value_e", "property_f":"value_f"}
  • 複数のJSONオブジェクトを含む配列:

  ```
  [{"property_a":"value_a", "property_b":"value_b"},
  {"property_c":"value_c", "property_d":"value_d"},
  {"property_e":"value_e", "property_f":"value_f"}]
  ```
  • プロパティと1つの配列を持つJSONオブジェクト:

  ```
  {
    "property_a": "値_a",
    "property_b": "値_b",
    "records": [
      {
        "property_c": "値_c",
        "property_d": "値_d",
        "property_e": "値_e",
        "property_f": "値_f"
      }
    ]
  }
  ```

HTTP APIデータエクスポーターの作成

データエクスポーターを設定するには、管理者権限が必要です。 ユーザーロールに関する詳細情報はロールドキュメンテーションを参照してください。

データエクスポートにアクセスするには:

  1. メインメニューから管理を選択してください。

  2. ナビゲーションパネルの統合セクションからアウトバウンドコネクタを選択してください。

Location of the Outbound connectors on the Navigation panel
  1. アウトバウンドコネクタリストからデータエクスポーターを選択してください。 データエクスポーターのページには作成されたデータエクスポーターの総数がリストされます。

最初のデータエクスポーターを作成するまでデータエクスポートページは空のままです。

  1. ページの右上隅にある新しいエクスポーターボタンをクリックして新しいデータエクスポーターを作成し、HTTP APIエクスポーターオプションを選択してください。

ExportersList.png
  1. 新しいエクスポーターのページで[一般]タブおよび[データ]タブを入力してください。

  2. 最大20レコードのロードテストボタンをクリックしてデータタブからNQLクエリを実行します。

  3. ページの下部にある保存ボタンをクリックして新しいデータエクスポーターを検証して作成します。

一般タブ

HTTPAPIExporter-GeneralTab-1 (1).png
  • 名前: データエクスポーターの名前を入力してください。

  • 説明(オプション): データエクスポーターに意味のあるゴールを入力してください。

  • 認証情報: Nexthinkデータのエクスポートを有効にするためにサードパーティツールの認証情報を定義します。 詳細はコネクタ認証情報ドキュメントを参照してください。

  • メソッド: データを送信するために公開APIがサポートしているメソッドを定義します。例: POST, PUT, PATCH。

  • リソース: プロトコルやインスタンスを含まない公開APIのエンドポイント名を以下の表に示すように入力してください:

完全なURL
リソースの値

https://ven00000.service-now.com/api/now/import/u\_infinity\_file/insertMultiple

api/now/import/u_infinity_file/insertMultiple

https://prd-p-00000.splunkcloud.com:8088/services/collector?index=main

services/collector?index=main

  • スケジューリング頻度: システムがNQLクエリを実行してデータをエクスポートする頻度を定義します。 利用可能なオプションは次の通りです:

    • 毎時: ドロップダウンメニューで選択した値に基づいてデータエクスポートデータをトリガーします。 たとえば、1時間ごと、2時間ごと、3時間ごと、4時間ごと、6時間ごと、12時間ごとです。

    • 毎日: Nexthinkクラウドインスタンスがあるタイムゾーンの0:00に毎日データエクスポートをトリガーします。

    • 毎週: 選択した曜日の0:00に、Nexthinkクラウドインスタンスがあるタイムゾーンにおいて毎週データエクスポートをトリガーします。

毎時および毎日のスケジューリング頻度の場合、システムはデータの完全性を確保するために、前のバケットが正しく閉じる時間を20分待ってからデータエクスポーターを実行します。

Recurrenceオプションの値を選択する必要があります。デフォルト値を生成せず、検証プロセスでインジケーター値が存在しないことは示されません。

データタブ

HTTPAPIExporter-DataTab-1.png
  • NQLクエリ: Nexthinkウェブインターフェイスから宛先へエクスポートされるデータをNQLクエリで定義します。

  • ペイロード構造: サードパーティツールAPIに送信されるペイロード構造を選択します。 狙っている公開APIがこのページで述べられるペイロード構造をサポートしていることを事前に確認してください。

  • ペイロード(JSON): サードパーティツールへの送信されるペイロード構造をJSON形式で書き込みます。 1つのオブジェクトに対してのみペイロードを指定します。

  • ペイロードコンテンツヘルパー: システムがペイロード内で使用できるNQLクエリの変数をリストします。

エクスポーターはNQLクエリにより生成された結果の数だけオブジェクト構造を複製します。

HTTPデータエクスポーターのテスト

データタブで構成されたクエリを実行するには、最大20件のレコードを読み込むテストボタンをクリックしてください。 システムは[一般]タブに設定された宛先に結果を送信します。

  • NQLクエリと接続が有効な場合、クエリ結果が正常に配送されたことを示すメッセージが表示されます。

  • NQLクエリまたは接続が無効である場合、エラーの詳細を教えてくれるメッセージが表示されます。

以下のデータタブのスクリーンショットには、さまざまな有効なクエリの例が示されています。

有効なクエリ( JSONオブジェクト )の例

JSON_example.png

有効なクエリ( 配列 )の例

有効なクエリ( 配列を含むJSONオブジェクト )の例

データエクスポーターの作成、編集、削除、無効化について学ぶには、データエクスポーターの管理ドキュメントを参照してください。

制限

詳細な最新の制限リストについては、Nexthink Infinityのしきい値と制限の概要を参照してください。

よくある質問 (F.A.Q.)

HTTP API Exporterがサポートしていないペイロードを追加することはできますか?

いいえ、ペイロード構造がNexthink上の3つのオプションのいずれにも一致しない場合、検証エラーが発生します。

ペイロードメッセージ内に挿入されるキーは、ServiceNowのインポートセットテーブルに対して検証されますか?

ServiceNowのインポートセットテーブルに存在しないカラムをペイロード内に挿入しようとすると、それは挿入されません。

使用可能なペイロード形式がない場合はどうすればいいですか?

新しいペイロード形式のサポートを提案するためにNexthinkの担当者にご連絡ください。

HTTPエクスポーターを通じてNexthinkは大規模なNQLクエリ結果をどのように管理していますか?

Nexthinkは大規模なデータセットを効率的に管理するためにHTTPエクスポーターを最適化しました。 NQLクエリが1000件を超える場合、Nexthinkはデータを1000件ずつの管理可能なバッチに分割し、最大で100万件の記録を生成します。 これらのバッチはシステム的に組織のエンドポイントに送信されます。 スケジューラーはさまざまな応答時間やデータボリュームに適応するように設計されており、データの完全な転送が達成されるまで、バッチごとに連続的かつシームレスにデータを配信します。

HTTPエクスポーターを通じてNexthinkは信頼性の高いデータ配送をどのように保証しますか?

特にシステム障害時に信頼性の高いデータ配送を保証するために、NexthinkはHTTPエクスポーターを通じた確保配送アルゴリズムを使用しています。 これは、リクエストされたデータの各バッチが最低でも一度は送信されることを意味し、システム障害時のデータ損失を防いで成功した配送を保証します。 データバッチが複数回配送されることはありますが、損失することはありません。

余分に配送されたバッチを検出するために、Nexthinkには以下のようにカスタムヘッダーが追加されています:

  • X-Nexthink-Execution-Id: スケジュールされたイベントのID(スケジュールドイベントが発生するたびに新しいIDが作成されます)

  • X-Nexthink-Records: ページごとのレコード数

  • X-Nexthink-Pages: スケジュールされたイベントごとのページ数

  • X-Nexthink-Current-Page: 実際のページ

  • X-Nexthink-Timestamp: 送信されたページのタイムスタンプ(エポック時間)

これらのヘッダーにより、同じX-Nexthink-Execution-IdでX-Nexthink-Current-Pageが任意の時間枠で繰り返される場合、配送されたデータが複数回行われたことを識別できます。

HTTPエクスポーターのスロットル機構はどのように機能しますか?

システムの安定性と途切れないサービスを確保するために、NexthinkはHTTPエクスポーターのスロットル機構を実装しています。 このメカニズムは1秒あたり最大3.33バッチを処理でき、Nexthinkユーザーのインフラストラクチャの応答速度やクエリ処理時間などさまざまな要因も考慮しています。 これにより、最適なシステム性能が維持されます。。

Last updated

Was this helpful?