How to monitor the Nodinite Product Key

This guide teaches how to configure the Nodinite Web Service Monitoring Agent to validate the Nodinite product key (License).

The Nodinite Web Service Monitoring Agent can be used to monitor if the product key for Nodinite (Trial or Rental) is about to expire by evaluating the body from the HTTP/HTTPS response from a call to the Nodinite Web API.

The Web Service configuration from this user guide will eventually end up as a Resource in one or more Monitor Views where the currently evaluated state is presented:

Product Key is valid and has not yet expired or is not about to expire any time soon

Product Key is about to expire.

In this case, You are required to update the ProductKey system parameter in order to be able to continue to use the Web Client.

You can get an updated product key by:

1. Contact your partner/reseller if applicable
2. Get a new key from the Nodinite portal
3. Contact our technical support support

Step 1: Add a new Application

Monitored Resources should logically be identified and can be grouped using the Applications feature. These are managed in the Applications tab for selected instance of the Nodinite Web Service Monitoring Agent.

1. click the Add button
   

2. Enter Name and a unique id. In this example, we use Nodinite as Name, and 1337 as the unique Id. You can exchange these values as you feel fit as long as the entry is unique in the list.
   +

Step 2: Add a new Web Service Monitoring Configuration

Next, you will configure what to Monitor. In this case, it will be the Nodinite Web API.

1. click the Add button
   

2. Expand the empty entry by clicking on the accordion
   

Step 3: Basic tab

Next, you will name the configuration by editing the following fields from within the Basic tab:

1. Make sure the configuration is enabled (checked)
2. Set the Display name to some logically good name, for example, Evaluate Nodinite Product Key
3. Set the Description and provide some basic information that makes it easy for someone else to understand the purpose of your configuration, for example Use the Nodinite Web Service Monitoring agent to get an alert when the Nodinite product key is about to expire or has already expired
4. Select the Application you created in Step 1

Step 4: Advanced tab

Next, you will manage your time related thresholds, editing the following fields from within the Advanced tab:

1. Set the Polling Interval to some value, for example, 3600 (This type of check does not need to be performed very often)
2. Set the Request Timeout to some value, for example, 120. An update of Nodinite usually takes less time.
3. Check the Allow Retries checkbox
4. Set the Number of retires to some value, for example, 3. A single missed call should not give you an alert for this type of check
5. Set the Retry Status Code to OK, meaning that we ignore any errors during the retry period

Step 5: Request tab

Next, you will manage items related to the actual Request. This information is managed from within the Request tab:

1. Enter the URI to the Web API, for example, http://localhost/Nodinite/Dev/WebAPI/api/status (replace DEV as appropriate). Use localhost if the Web Service agent is installed on the same server as the Web API.
2. The method to use is Get

Leave the rest of the fields empty. The Web API is not SOAP and there is a need for additional HTTP headers.

Step 6: Response tab

Next, you will manage some technical details about the response. This information is managed from within the Response tab:

1. Set the Status Code to 200 which means OK

You should normally not need to add configuration on the performance for this type of check. Leave the checkboxes unchecked.

Step 7: Evaluate response body tab

Next, you will configure the evaluation of the HTTP response body part. This configuration is performed from within the Evaluate response body tab:

1. Select the Expression Type RegEx Match
2. Enter the following Expression:

^(?>(?:[^k]+|k+(?!ey expires))*)$

match if the word 'key expires' is part of the response

Leave the rest of the fields to their default as pictured.

Step 8: Certificate tab

If you have performed the recommended Hardening of your Nodinite installation, you might want to make sure you also as a bonus get an alert if there is a problem detected with the certificate used for HTTPS. The configuration for this evaluation is managed from within the Certificate tab:

1. If you use a certificate, then check the Evaluate certificate checkbox, otherwise leave it unchecked and consider Hardening your Nodinite installation
2. Set the number of days before the certificate expires to get a Warning alert
3. Set the number of days before the certificate expires to get an Error alert
4. If you have a certificate, then you might want to enforce that it is always being used. Check Force the use of certificate checkbox if this is the case
5. The main purpose of this check is to evaluate the Nodinite product key, leave the Allow connection for invalid certificates checkbox unchecked

Step 9: Authentication tab

Next, IF the Web API application pool account is NOT the same as the Windows Service account running the Nodinite Web Service Monitoring Agent, then you must provide alternate credentials. This configuration is performed from within the Authentication tab:

1. Check the Use Windows Authentication checkbox
2. Enter the Domain User: DOMAIN\user (User MUST have access to the Nodinite Web Client)
3. Password: ******** (Password for the user)

Step 10: Save configuration

Next, you must Save the configuration. Click the Save button and then you should see a message that the operation succeeded:

Step 11: Create a Monitor View and Configure alerts

Next, you should configure a Monitor View and select an appropriate Alarm Plugin to get the alert in the way you prefer. These steps are documented in the Add or manage Monitor View user guide.

Make sure to select the Resource that you named in step 3.

Next Step

Add or manage Monitor View
Add or manage a Monitoring Agent Configuration

Related

Monitoring Agents
Monitor Views
Administration