REST API監視

REST API監視はAPIの応答を定期的に確認し、応答で、指定した属性値が、所定のXPathや属性名に見つからない場合、アラートを発します。IPv4/IPv6のデュアルスタック インフラも、Site24x7で監視できます。

もくじ

• 一般設定
• HTTP設定
• コンテンツ チェック
• 設定プロパティ
• サードパーティ連携
• トラブルシュートのヒント

REST API監視の追加

1. Site24x7にログインしてください。
2. 管理 > インベントリ > 監視 > 監視の追加 とクリックします。
3. REST API監視を監視の追加で選択します。
4. Webサイト監視の追加には、次の情報を指定してください。
   • 表示名：監視するWebサイトを、適宜、命名します。
   • エンドポイントURL：監視するREST エンドポイントURLを、入力。
   • 確認頻度：ポーリング頻度を選択します。
     
   • 接続タイムアウト：ターゲット サーバーとの接続に必要な時間を指定します（％）。
   • IPv6設定：IPv6有効のWebサイトを監視するには、監視のフォームの作成・編集中にトグルボタンを「はい」へと動かしてください。
     
     Site24x7では要件に応じて、IPv4とIPv6に対応したインフラを監視します。デフォルトで有効となるプロトコルは、IPv4です。監視のフォームで選択すれば、IPv6インフラも監視できます。
     
     
     IPv6を監視フォームで有効にしても、IPv4互換とはなりません。IPv4とIPv6の双方に対応したサイトを監視する場合は、それぞれ別の監視の設定が必要です。
   • 監視ロケーション：Webサイトの監視元となるロケーションのプロファイルを、ドロップダウンで選択してください。
     詳細は、ロケーション プロファイルを参照ください。
     
   • 監視グループ：該当する監視グループをドロップダウンから選べば、監視を複数の監視グループに関連付け可能です。これにより、監視を論理グループにできます。
     監視群に対して、1つの監視グループを作成するには、監視グループを参照ください。
   • 監視への依存：監視をドロップダウンから選択し、依存リソースに指定します。依存リソースのステータスがダウンであれば、監視へのアラートは抑止されます。
     
     依存リソースを設定し、それにもとづくアラート抑止を行えば、誤報アラームの防止につながります。詳細は、監視レベルでのアラーム抑止を参照ください。
     
     
     依存リソース欄に「なし」を選択すると、通常設定の場合と同様、アラートが発生します。この場合、監視には依存リソースがないことになるため、アラート抑止は行われません。
     
     
     1つの監視を、ことなる監視グループにある複数の依存リソースに関連付けることも可能です。通常のステータス確認で、これら依存リソースが1つでもダウンと特定されると、その監視のアラートは自動的に抑止されます。ただし、監視レベルでの依存性設定は、常に、 監視グループ レベルでの依存性設定に優先します。
5. HTTP設定には、次の情報を指定してください。
   • HTTPメソッドサイト接続時のメソッドを、post、get、put、delete、patchから指定します。ラジオボタンでフォーム送信メソッドを選択してください。post、put、patchのメソッドについては、bodyタイプも設定してください。
     
     postメソッドでは、URLアクセス時にパラメーターを送出します。postメソッドでは、フォーム、テキスト、XML、JSON形式での送信をサポートしています。
   
   
   getメソッドでは、HTML応答全体を取得し、設定したキーワードの存在確認に利用できます。
   • リクエストタイプ：GraphQLクエリをエンドポイントに送信したい場合はGraphQLを選択します。
   • GraphQLクエリ：GraphQLクエリを入力し、APIサービスに基づくGraphQLからの応答として特定の項目を取得します。
   • GraphQL変数：JSON形式のGraphQLクエリで参照される変数の値を入力します。
     
     POSTメソッドを選択している場合、リクエストボディにGraphQLクエリおよびGraphQL変数を指定してください。GETメソッドの場合、GraphQLクエリとGraphQL変数はURLパラメーターを通して送信されます。
   • HTTP要求ヘッダー：デフォルトのHTTP要求ヘッダーを編集する場合は、ヘッダー名とヘッダー値を、ここで追加します。
   • ユーザー エージェント：ブラウザーのカスタム ユーザー エージェントを設定し、要求とHTTPヘッダーの送出に利用します。利用できるUAからの選択が可能です。
     
   • 認証方法：監視の認証方法を複数種類、管理します。
     • Basic/NTLM：Basic/NTLMベース認証を設定します。Windows NTLMは、Windows OS上のシステムで利用できる認証プロトコルです。
       認証情報：Basic/NTLM認証を要するURLの、ユーザー名とパスワードを指定。
       
     • OAuth：OAuthフレームワークによるセキュリティを施したリソースを監視する場合は、OAuthラジオボタンを選択してください。
       OAuthサービス プロバイダー名：OAuthサービス プロバイダー名を設定リストから選ぶか、新しくOAuthプロファイルを作成してください。by clicking +ボタン.
       
       手順はOAuthサービス プロバイダーの設定を参照ください。
     • クライアント 証明書：クライアント証明書認証を要するWebサイトでは、クライアント 証明書をアップロードしてください（PKCS#12ファイル）。
       
   • 権威DNSサーバーによるクエリ処理：トグルボタンで、ドメイン名解決に権威DNSサーバーを使うか指定します。
   • HTTPステータス コードのサポート形式：コンマ区切りのリストで、応答成功を表すHTTPステータス コードを表示します。ステータス コードをそれぞれ指定することも、コロン区切りで範囲指定することも可能です。
6. コンテンツ チェックの情報を指定してください。
   • 応答フォーマットにテキストを選んだ場合
     • あるはずの文字列：指定キーワードがWebサイトになければ、アラートします。チェックボックスでキーワードを指定し、スライダー ボタンで必要な種類のアラートを有効にしてください。
     • あってはならない文字列：指定キーワードがWebサイトにあれば、アラートします。チェックボックスでキーワードを指定し、スライダー ボタンで、必要な種類のアラートを有効にします。
       
       入力欄にキーワードを指定する際は、次の条件を守ってください。
       

       • 文字列やキーワードが1つであれば、ダブル・コーテーションで囲むか否かは任意です（例：HTML）。
       • 2つの文字列で1キーワードとなっている場合、空白をあけて、全体をダブル・コーテーションで囲みます（例："HTML response"）。
       • キーワードを複数指定する場合は、それぞれを空白で区切り、ダブル・コーテーションで囲ってください（"monitor" "HTML"）。
     • 大文字・小文字の区別：トグルボタンで、この項目を、有効にします。
     • 正規表現マッチ：Webコンテンツの特定パターンにマッチする際にアラートするという設定を行います。たとえば、^[a-z0-9_-]{3,15}$という表現にマッチする場合、Webコンテンツには、aからzまでのアルファベット、0から9までの数字、アンダースコア、ハイフンが含まれることとなります。たとえば、^[a-z0-9_-]{3,15}$という表現にマッチする場合、Webコンテンツには、aからzまでのアルファベット、0から9までの数字、アンダースコア、ハイフンが含まれることとなります。 このパターンにマッチしない場合、Webサイトは指定した正規表現「^[a-z0-9_-]{3,15}$」にあわないものとして、報告対象になります。
       
   • 選択する応答形式がXMLの場合
     • XPath表現：XPath表現を指定し、XPath表現のアサーション評価を可能とします。アサーションは、XPathをXMLで正しく解析できるようにしなくてはなりません。複数のXML表現アサーションを追加するには、（＋）キーをクリックしてください。
     • アラートの重要度：XPath表現のアサーション失敗時、アラートの重要度を「ダウンやトラブル」とするかの決定をします。
       
   • 選択する応答形式がJSONの場合
     • JSON Path表現：JSON Path表現を指定し、JSON Path表現のアサーション評価を可能とします。アサーションは、JSON PathをJSONで正しく解析できるようにしなくてはなりません。複数のJSON Path表現アサーションを追加するには、（＋）キー
     をクリックしてください。
     • アラートの重要度：JSON Path表現のアサーション失敗時、アラートの重要度を「ダウンやトラブル」とするかの決定をします。
       
7. 設定プロファイルの情報を指定してください。
   • しきい値・可用性：しきい値プロファイルをドロップダウンから選ぶか、デフォルトのしきい値設定を選択してください。リソースが設定値を超えると、通知が行われます。
     しきい値・可用性のカスタム プロファイルの作成には、しきい値・可用性を参照ください。
   • 通知プロファイル：通知プロファイルをドロップダウンから選ぶか、デフォルト プロファイルを選択してください。通知プロファイルにより、障害発生時は、いつ誰に通知するかを設定できます。
     通知プロファイルを参照し、カスタム通知プロファイルを作成してください。
   • ユーザー アラート グループ：障害時にアラートを届けるユーザー グループを選択します。
     1グループに複数ユーザーを追加する場合は、ユーザー グループを参照してください。
   • アクション：Webサイトで、ダウン・トラブル・アップのステータス変化や、属性の変化があった時に実行するアクションを選択します。ステータス変更の際は設定したアクションが実行され、対象ユーザー グループにアラートを発します。
     障害への是正措置を自動化するには、アクションを参照ください。
     を参照ください。
8. サードパーティ連携：サードパーティのサービスを設定し、監視を関連付けてください。監視アラームが関連サービスへ送信され、インシデント管理が促進・改善されます。
   
   連携設定がすんでいない場合、「管理 > サードパーティ連携」と移動し、作成してください。詳細情報はこちらです。
9. 保存をクリックしてください。
   
   監視の設定が終わると、Site24x7のディープ ディスカバリ ウィザードは、ドメインをスキャンし、あらゆるインターネット関連リソースを検出、契約アカウントの包括的インターネット サービス監視に追加します。詳細は、インターネット サービスのディープ ディスカバリを参照ください。

トラブルシュートのヒント：

• REST API監視でのpost形式
• REST API監視ポーリングの、出力・応答時間を確認する
• REST API監視に、postメソッドでJSON要求bodyを使う場合、JSON応答とのコンテンツ マッチに、1次レベル・2次レベル確認の併用は可能か
• 1つのREST API監視で、複数のAPIを設定する方法