Groovyスクリプトを介した内部Webチェックの実行

概要

内部Webチェックの設定フィールド構成に加えて、Groovyスクリプトを使用してチェックを実行し、HTTPデータを収集して処理することもできます。 スクリプト化されたWebチェックはより柔軟になる傾向があり、動的トークンを使用したフォームベース認証を使用するサイトで特に役立ちます。

Groovyスクリプトを介して実行されるWebチェックには、少なくともXNUMXつのステップがあり、これには ステップリクエスト スクリプトと ステップ応答 プロセッサ。 スクリプト化されたチェックをユニークにするのは、ステップ間でコンテキスト（つまり、認証用の動的トークン）を共有する機能です。 このようにして、ステップXNUMXはGETリクエストを送信して、サイトの認証トークンを収集し、ステップXNUMXでトークンを共有します。これにより、サイトが認証されます。

内部Webチェックを作成または編集すると、[要求]セクションと[応答]セクションの両方で[スクリプト]というタイトルの追加のタブを使用できることがわかります。 リクエストとレスポンスのGroovyスクリプトを、これらの両方の[スクリプト]タブにあるテキストボックスに直接手動で追加するか、次に示すように、[設定]タブのフィールドに最初に入力することを選択できます（例： HTTPバージョン, 方法, リダイレクトに従う, 認証が必要です, ヘッダ, HTTP応答形式など）をクリックしてから、 設定からスクリプトを生成する ボタンをクリックすると、LogicMonitorは、これらの設定に基づいて要求および応答スクリプトを自動生成します。 後者のオプションは、Groovyスクリプトの基本的なテンプレートを生成します。 （HTTP要求と応答の両方について、[設定]タブにあるフィールドに入力する方法の詳細については、を参照してください。 Webチェックの追加).

リクエストスクリプトの作成

リクエストスクリプトはGroovyAPIを使用してHTTPレスポンスを取得します。

リクエストGroovyスクリプトのAPIコマンド

次の表に、リクエストGroovyスクリプトで使用できるAPIコマンドを示します。

リクエストスクリプトコマンドの例

• 次のGroovy構文は、基本認証を使用するサイトの内部Webチェックの最初のステップで使用されます。

  import com.logicmonitor.service.groovyapi.AuthType;
  import com.logicmonitor.service.groovyapi.LMRequest;
  LMRequest request = new LMRequest();
  request.setAuthType(AuthType.BASIC)
          .setUsername("username")
          .setPassword("password")
          .followRedirect(false)
          .useHttp1_0()
          .needFullpageLoad(true);
  String jsonData = "{\"name\": \"value\"}"
  return LMHttpClient.request(request)
                      .post(JSON, jsonData);

• 例 setContext（） 応答：

  StatusCode status = LMResponse.statusMatch(200);
  LMResponse.setContext("body", Response.getBody());
  return status;

• 例 getContext（） 応答：

  return LMResponse.plainTextmatch(Response.getContext("exampletext"))

• 例 post（PostDataType、String PostData）応答：

  import static com.logicmonitor.service.groovyapi.StatusCode.*;
  import static com.logicmonitor.service.groovyapi.PostDataType.*;
  String jsonData = "{\"name\": \"value\"}";
  return LMHttpClient.post(JSON, jsonData);

• 例 request（LMRequest） 応答：

  import com.logicmonitor.service.groovyapi.AuthType;
  import com.logicmonitor.service.groovyapi.LMRequest;
  LMRequest request = new LMRequest();
  request.setAuthType(AuthType.BASIC)
          .setUsername("username")
          .setPassword("password")
          .followRedirect(false)
          .useHttp1_0()
          .needLoadFullPage(false);
  String jsonData = "{\"name\": \"value\"}"
  return LMHttpClient.request(request)
                      .post(JSON, jsonData);
  

応答スクリプトの作成

応答スクリプトは、要求スクリプトからのHTTP応答を解析し、後処理メソッドを適用します（たとえば、ステータスの確認、HTTP応答本文の確認など）。

次の表に、リクエストGroovyスクリプトで使用できるAPI呼び出しを示します。

応答スクリプトの例

サイトの応答ステータスが「302」であることを確認する場合は、次のリクエストを使用してください。

import com.logicmonitor.service.groovyapi.LMRequest;
LMRequest request = new LMRequest();
return LMHttpClient.request(request.followRedirect(false)
                        .get());

応答スクリプトは次のように記述します。

return LMResponse.statusMatch(302);

ステータスコード

完全なサンプルスクリプト

以下は、メッセージングサービスの可用性を確認するために使用される完全なXNUMXステップのスクリプトです。 この特定のスクリプトは、内部WebチェックのステップXNUMXとXNUMXの間で共有される動的トークンを使用します。 セットコンテキスト • getContext サイトへの認証のためのコマンド。 後処理メソッドは、サイトの可用性を確認する手段として、HTTP応答内の「ようこそ」の存在を探します。