Executing Internal Web Checks using Groovy Scripts

You can also execute your Internal Web Check using a Groovy script to collect and process HTTP data. Internal Web Checks with at least a single step that runs using Groovy script consist of a Step Request script and a Step Response processor. Step Request can send a GET request to collect a site’s authenticating token and share the token while the Step Response authenticates into the site.

The following are some of the benefits of executing Internal Web Checks using Groovy scripts:

• More flexible and particularly useful for sites that use form-based authentication with dynamic tokens.
• Unique due to their ability to share contexts (dynamic tokens for authentication) between steps. 

You can use the Groovy script while adding or editing your Internal Web Check. The following details the steps to create an Internal Web Check using Groovy script:

1. In LogicMonitor, navigate to Websites > (Add) +> select Internal Web Check.
   
2. At the Basic step of the wizard, enter the required details.
3. Select Next:Settings.
4. At the Setting step of the wizard, do the following:
   1. In the Default root URL section, select http:// or https:// protocol depending on your web server settings, and enter the website domain to which your Web Check request will be sent.
   2. In the Step One URL Path field, enter the first path that should be tested for your website. Enter the path relative to the website domain (For example, /folder/page.htm).
   3. Select the Script tab under the Request section.
   4. Toggle on the Use Groovy Script for Request switch.
   5. Select Generate Script from Settings to have LogicMonitor auto-generate request scripts based on those settings.
   6. Select the Script tab under the Response section.
   7. Toggle on the Use Groovy Script for Response switch.
   8. Select Generate Script from Settings to have LogicMonitor auto-generate response scripts based on those settings.
      
5. Select Next:Checkpoints.
6. At the Checkpoints step of the wizard, specify the Collectors that will send the checks.
   The Use Default Website Settings toggle is selected by default.
   Note: Your user account must have Collector view permissions to view and select Collectors from this area of the dialog. For more information, see Roles.
   
7. Select Next: Alert Triggering.
8. At the Alert Triggering step of the wizard, enter the required details.
9. Select Finish. 

Writing a Request Script

The request script uses the Groovy API to get an HTTP response.

API Commands for a Request Groovy Script

The following table lists the API commands you may use in your request Groovy script.

Example Request Script Commands

• The following Groovy syntax would be used in the first step of an Internal Web Check for a site using basic authentication.
  

  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);

• Example setContext() response:

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

• Example getContext() response:

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

• Example post(PostDataType, String PostData) response:

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

• Example request(LMRequest) response:

  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);
  

Writing a Response Script

The response script will parse the HTTP response from your request script and apply any post-processing methods (For example, check status, check the HTTP response body, and so on).

The following table lists the API calls you may use in your request Groovy script.

Example Response Script

In the event that you wanted to verify a response status of “302” for a site, use the following request:

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

You would write your response script as follows:

return LMResponse.statusMatch(302);

Status Codes

Full Example Script

Below is a full two-step script used for verifying the availability of a messaging service. This particular script uses a dynamic token shared between steps one and two of the Internal Web Check through the setContext and getContext commands in order to authenticate into the site. The post-processing method looks for the presence of “Welcome” in the HTTP response to verify the site’s availability.