データレイク - REST API メトリック監視

データレイク のREST API メトリック監視オプションは、API の可用性とパフォーマンスを確認するために使用されます。
REST APIのメトリックの管理と分析を支援し、APIエンドポイントで利用可能なフィールド値の分析が可能です。この監視ツールを使用すると、即時アラートを受信し、データを明確に視覚化できるため、重要な変更の追跡と対応が容易になります。
この基本的な監視ツールは、REST APIで利用可能なすべてのフィールドに関するインサイトを提供し、APIのパフォーマンスを詳細に可視化します。

機能

1. REST APIエンドポイントURLとデータフィールドを指定
   • データを取得するREST APIエンドポイントのURLを定義します。
   • 監視するAPI応答から特定のデータフィールドを選択します。
2. REST APIを使用してデータレイクをデータソース監視として保存します。
   • 監視設定を保存します。
     このアクションにより、指定されたデータフィールドの継続的な監視が可能になります。
3. カスタム属性監視を作成
   • REST APIメトリック監視のカスタム属性監視を設定します。
   • データソースと親監視を指定します。
   • 監視のカスタム属性しきい値プロファイルを選択し、設定を保存します。
4. アラートを生成し、データを視覚化
   • しきい値を超えると、直ちにアラートがトリガーされ、ユーザーに通知します。
   • データはチャートやグラフの形式で可視化するため、ユーザーは傾向や偏差を迅速に分析できます。

ユースケース

生産性の低下、タスクの遅延、業務の非効率性といった課題に直面している企業のユースケースを考えてみましょう。この組織は、パフォーマンス向上のため、主要なメトリックを監視するシステムを導入することを決定しました。

組織はまず、設備、スタッフのパフォーマンス、ワークフロープロセスなど、運用上の様々な側面に関するデータを収集することから始めます。
毎月KPIを設定し、APIを介してこれらのデータを統合します。REST APIメトリックを使用することで、収集されたデータを継続的に監視し、メトリックが定義された範囲を超えたり下回ったりした場合にアラートをトリガーするしきい値を設定します。

マシンのパフォーマンス、生産性、従業員の効率といった主要なメトリックを可視化するために、カスタマイズダッシュボードが作成されます。これらのダッシュボードは、組織が異常や改善点を特定するのに役立ちます。このデータに基づいて、チームはオペレーションを最適化するための是正措置を講じることができ、生産性の向上、コスト削減、エラーの削減につながります。

重要なメトリックを表示するリアルタイムのダッシュボードにより、組織は業務の効率を一貫して監視および強化し、すべてを順調に進めることができます。

利点

• データの可視化：インタラクティブなダッシュボードに表示されるグラフやチャートなどのさまざまな可視化ツールを使用してデータを分析および探索し、ユーザーが特定のフィールドのデータを探索できるようにします。
• インスタントアラート：要件に応じてカスタムアラートを設定します。
• リアルタイムデータ更新：特定の間隔に基づいてデータを比較します。可視化はリアルタイムで更新され、メトリックのステータスを最新の状態で表示します。
• ドリルダウン機能：フィルターを適用してデータをドリルダウンし、特定の詳細を調べます。

REST APIメトリック監視を追加

1. Site24x7のWebクライアントにログインします。
2. ［メトリック］→［データレイク］→［データ送信元の追加］にいどうします。
   
   開いたウィンドウで、RESTAPIメトリックの横にある［今すぐ連携］ボタンをクリックして、REST APIメトリック監視を追加します。
   
   
   ［監視］→［監視の追加］→［REST APIメトリック］から監視を追加することも可能です。
3. REST APIメトリック監視のメトリックを構成するには、次の詳細を指定します。
   
   
   • 表示名：監視の名前となる適切な名前を入力します。
   • チェック頻度：必要なポーリング間隔を選択します。頻度は5分から1日の間で設定できます。
   • 監視ロケーション：ドロップダウンリストからグローバル監視ロケーションを選択し、これらのロケーションからWebサイトを監視します。監視には少なくとも1つのプライマリロケーションを設定する必要があります。
     IPv6/IPv4ロケーションを選択するか、オンプレミスポーラーを監視ステーションとして設定することができます。ロケーションプロファイルを追加または編集するには、ロケーションプロファイルを参照してください。
     

     REST API メトリック監視はプライマリロケーションでのみ使用できます。

4. エンドポイントURLで次の詳細を指定します。
   • HTTPメソッド：ドロップダウンメニューからエンドポイントURLへの接続方法を選択します。ドロップダウンメニューから「カスタム」を選択することで、リストにないメソッドを指定することもできます。
     

     POST：URLにアクセスするためのパラメーターを送信します。FORM、テキスト、XML、またはJSON形式でリクエストを送信できます。
     HEAD：URLの可用性を確認する。
     GET：HTMLレスポンス全体を取得し、設定したキーワードが存在するかを確認します。

   • 監視する必要があるREST APIエンドポイントのURLを入力します。
     

     ［APIレスポンスの取得］」ボタンフィールドをクリックすると、受信したレスポンスが入力されます。

5. 下向きの矢印アイコン (^) をクリックして、HTTP設定の詳細を指定します。:
   
   
   • パラメータータイプ：NoneまたはGraphQLを選択します。
     GraphQLを選択した場合は、以下のパラメータを指定します。
     • GraphQL Query：GraphQLベースのAPIサービスからの応答で特定のフィールドを取得するためのGraphQLクエリを提供します。
     • GraphQL Variables：GraphQLクエリで参照される変数の値をJSON形式で指定します。
   • HTTPリクエストヘッダー：デフォルトのHTTPリクエストヘッダー情報をカスタマイズしたい場合は、ここで追加のヘッダー名とヘッダー値を追加できます。これにより、デフォルトのヘッダーが上書きされます。
   • ユーザーエージェント：リクエストとHTTPヘッダーを送信するためのカスタマイズされたユーザーエージェント（メトリック監視）を設定します。利用可能なユーザーエージェントから選択できます。
   • 認証方法：「なし」またはいずれかの認証方法を選択し、それに応じて資格情報を更新します。
     • Basic/NTLM 認証情報：Basic/NTLM認証で保護されたリソースを監視する場合は、Basic/NTLM認証を選択してください。Windows NTLMは、Windows OSで実行されるシステムで使用される認証プロトコルです。
       
       • Web認証情報：ドロップダウンメニューから、Basic/NTLMベースの認証を必要とする URLのWeb資格情報を選択できます。
         

         詳細は認証情報の追加/編集をご参照ください。

     • Kerberos/Negotiation：Kerberos認証によって保護されたリソースを監視する場合は、Kerberos/Negotiationのラジオボタンを選択します。
       
       • Kerberos認証：事前に設定したリストからKerberos認証情報プロファイルを選択するか、(+)ボタンをクリックして新しいKerberos認証プロファイルを作成します。
         
         • Kerberos認証は、オンプレミスポーラーでのみサポートされます。
         • 詳細はKerberos認証プロファイルをご参照ください。
     • OAuth：OAuthフレームワークによって保護されたリソースを監視する場合は、OAuthを選択します。
       • プロバイダー名：事前に設定したリストからOAuthプロバイダー名を選択するか、(+)ボタンをクリックして新規OAuthプロファイルを作成します。
     • Webトークン：認証にWebトークンを使用するリソースを監視する場合は、Webトークンを選択します。
       • Webトークン名：事前に設定したリストからWebトークン名を選択するか、(+)ボタンをクリックして新規Webトークンを作成します。
     • AWS Signature：ドロップダウンから、Site24x7に連携済みのAmazonアカウントを選択します。これは、AWS API GatewayでホストされているAPIを認証するために、HMACを使用してAPIリクエストに署名する際に役立ちます。
       
       • AWSアカウント：事前に設定したリストからAWSアカウントを選択するか、(+)ボタンをクリックして新しいAWSアカウントを作成できます。
         
         • Amazonアカウント連携をご参照ください。
         • AWS署名認証をご参照ください。
6. 詳細設定を指定：
   
   
   • 接続タイムアウト：対象サーバーとの接続を確立するのに必要な時間を秒単位で指定します。指定時間内に接続が確立されない場合、Webサイトは「接続を確立できませんでした」という理由でダウンしていると報告されます。
   • IPv6を優先：IPv6対応のロケーションを介してエンドポイントURLを監視する場合は、監視の作成または編集時にこのオプションを［はい］にします。
     
     • Site24x7では、ニーズに合わせてデュアルスタックのIPv4/IPv6ベースのインフラストラクチャを監視できます。IPv4はデフォルトのプロトコルとして有効化されます。トグルボタンをIPv6に切り替えれば、IPv6インフラストラクチャを監視できるようになります。IPv6経由の接続が失敗しても、自動的にIPv4にフォールバックすることはありません。 monitoring IPv4 and IPv6 enabled internet facing resources（本社ナレッジベース）をご参照ください。
     • 監視作成時にIPv6を有効にしても、デフォルトではIPv4監視と互換性がありません。IPv4とIPv6の両方に対応するリソースを監視する場合は、2つの別々の監視チェックを設定する必要があります。
   • 権威ネームサーバーのクエリ：権威ネームサーバーを使用してドメイン名を解決する場合は、［はい］に切り替えます。
   • 承認済みHTTPステータスコード：成功を示すHTTPステータスコードをカンマ区切りのリストで指定します。個々のステータスコードを指定することも、コロンで区切って範囲を指定することもできます。
     詳細は、Accepted HTTP Status Codesをご参照ください。
   • SSLプロトコル：適切なSSLハンドシェイクを検証するために、TLS/SSLプロトコルのバージョン番号（TLSv1.3、TLSv1.2、TLSv1.1、TLSv1、SSLv3）を指定します。ドロップダウンメニューから「自動」モードを選択すると、自動検出とネゴシエーションが有効になります。
     

     SSLプロトコル検証はHTTPSドメインにのみ適用されます。実際のSSLプロトコルバージョンとは異なるバージョンを指定した場合、ポーリング中に監視ステータスが失敗します。

   • HTTPプロトコル：ネゴシエーションに使用するアプリケーション層プロトコルの優先バージョン (HTTP/1.1 または HTTP/2) を選択します。
   • ALPNを有効化：
     • TLSハンドシェイクの一部として送信されるプロトコルを送信しない場合は、このオプションを「いいえ」に設定します。
     • このオプションを「はい」に設定すると、TLSハンドシェイクでサポートされているアプリケーションプロトコルのみが送信されるようになり、ラウンドトリップ時間が短縮されます。
       デフォルトでは「はい」に設定されています。
       ALPN を有効にするオプションは、オンプレミス ポーラーと互換性がありません。
7. パラメータ転送：この機能を使用すると、連鎖リクエスト間でデータの受け渡しと検証を行うことができます。XPath、JSONPath、正規表現などのメソッドを使用してレスポンスから個々の値を抽出し、カスタムパラメータとして保存できます。さらに、正規表現を使用してヘッダーから値を抽出することもできます。
   
   これらのパラメータは、レスポンスのカスタムクエリ文字列またはPOSTデータを作成するために使用できます。レスポンスフォーマットドロップダウンで選択したテキスト、XML、またはJSONに基づいて、カスタム正規表現式、XPath式、またはJSON Path式を作成できます。
   後続のステップのHTTPリクエストで${Parameter}を呼び出すと、呼び出された式アサーションの出力値が、これらのステップでさまざまなステップ検証ユースケースに使用されます。
   
   
   • レスポンス形式：選択した形式に応じて、正規表現、JSONPath式、またはXPath式を使用して値を抽出できます。詳細はレスポンス形式をご参照ください。
   • レスポンスヘッダー/Cookie形式：正規表現を使用してヘッダー/Cookieから抽出できる値を指定します。
8. 可用性の確認：関連する必須の詳細をすべて入力したら、このオプションを使用して、作成した設定をテストできます。
9. メトリック設定を指定してください。
   • 受信したレスポンス：受信したレスポンスは、上記のステップ5で指定したREST APIエンドポイントURLから取得したJSON値のセットです。
     「APIレスポンスを取得」をクリックすると、レスポンスがJSONレスポンスとして入力されます。JSONレスポンスを選択すると、以下のメトリック設定のフィールドが自動的に入力されます。手動で更新することもできます。
     
     • フィールド名：変更可能なメトリック/フィールドの名前です。JSONレスポンス内のメトリックとは、JSONレスポンスから抽出された測定可能な値またはデータポイントを指します。
     • JSONパス：JSONパスは、JSON応答から特定のデータを選択または抽出できるクエリ言語です。
     • 単位：単位はメトリックのデータ型です。数値または文字列のデータ型を指定できます。
     • フィールド値：メトリックの値です。
       
       • メトリック構成には最大50個のフィールドを含めることができます。
       • REST APIメトリック監視には、少なくとも1つの数値フィールドが含まれている必要があります。
       • ユーザーは最大5つの数値フィールドを追加できます。
10. ［確認して保存］をクリックしてREST APIメトリックを検証して保存するか、［保存］をクリックしてREST APIメトリック監視を保存します。
    

    メトリックに関するアラートを受信するには、カスタム属性を設定します。 カスタム属性の追加をご参照ください。

次のステップ

1. REST APIメトリック監視を正常に追加すると、データレイクダッシュボードに移動します。
2. 監視をクリックすると、REST APIメトリック監視パフォーマンスメトリックが表示されます。

関連記事

• カスタム属性監視を追加
• データレイク監視を追加