- 8 minutes to read

Add or manage a Monitoring Agent Configuration

In this guide, you will learn how to configure Nodinite to connect with installed Monitoring Agents to synchronize the state of provided Resources

One Monitoring Agent Configuration is used to uniquely target/identify/configure one installed Monitoring Agent. This information is used by the Monitoring Service to synchronize state of provided Resources. Also Remote Actions needs to be channeled from user interaction.

graph RL subgraph "Host with Monitoring Agents" roMonitorAgent(fal:fa-heart-rate Monitoring Agent) ro(fal:fa-lightbulb-on Resources to Monitor) roMonitorAgent --> ro end subgraph "Windows Server" roMonitoringService(fal:fa-watch-fitness Monitoring Service) roMonitoringService --> |Monitoring Agent Configuration | roMonitorAgent end

Click on the 'Quick Add Monitor Agent' or the 'Add Monitor Agent' button to begin entering the configuration details required for one installed Monitoring Agent.


General tab

The General tab provides the basic connection details for the Monitoring Agent Configuration.
General Tab

Quick Add

The fastest way to add a new connection with a Monitoring Agent is to copy/paste the Quick Add JSON information from the README.txt file in the installation folder. QuickAdd

JSON Example

{"Name":"SQL on IBSSMIOLSRV01","Uri":"http://IBSSMIOLSRV01:8000/Nodinite/Monitor/Agent/SQL/","XApiKey":"71B32996-908E-1337-4

Example of JSON quick add string from the README.txt file

Click on the Apply button to get all fields populated after you have pasted the JSON content from the clipboard.

Add Monitoring Agent

Which ever 'Add button' you pressed, the following properties must be set:

  • Name is your user-friendly configuration name and is required
  • Description is optional. Enter a user-friendly Description about this configuration
  • Website is optional. Provides the ability for an external link

Add Monitoring Agent Configuration

From the Connection tab, you can configure some information that makes it possible for the Monitoring Service to communicate with the Monitoring Agent.


The following properties are available:

The Monitoring Agents can either use:

The Service URL is always available in the README.txt file located in the installation folder of the Monitoring Agent.

  • Polling Interval is required - Set how often the Monitoring Service polls for the actual state of the Resources. This value is set in Seconds using a positive Integer value. Default value is 60 seconds and is the recommended setting for production environments. You may decrease (bisect) this value in test and development environments.

TIP: Do not poll for status updates more often than really required by your business needs. A short poll interval will add pressure on valuable system resources.

Security Tab

From the Security tab, you can configure settings that governs security-related to the actual communication between the Monitoring Service to communicate with the Monitoring Agent.


An Authentication Key must be entered to get access to Remote Configuration of the Monitoring Agent. The Monitoring Service must have this security setting to authenticate calls sent to the Monitoring Agent.
The Authentication Key is available in the README.txt file located in the installation folder.

Check the 'Monitoring Agent Configuration is authenticated' if you the Monitoring Service should use the Authentication Key settings for the connection against the Monitoring.

To allow Remote Configuration of the Monitoring Agent, the connection with the Monitoring Agent Configuration must be secured using either an API key or Service Bus Relaying.

NOTE: If ServiceBus Relaying is being used to communicate with the Monitoring Agent a different security scheme is being used,

Shared Access Signature security Key. See the following Microsoft article for more information MDSN. The Monitoring Agent needs additional configuration for Service Bus Relaying.

Example of shared access key, use the Azure Portal to acquire real values.


Advanced Tab

From the Advanced tab, you can configure some additional connection related settings and also some that overrides Connection settings.


Check the Change default Timeout checkbox if the communication should be allowed to use a custom Timeout. The default timeout value is 120 seconds and 60 seconds in the general settings.

If you are tweaking these settings the Monitoring Agent is probably having a hard time. Review the diagnostics file to diagnose this situation thoroughly or contact our support before you change these values

Check the Change default Retry handling checkbox to allow the Monitoring Service additional chances to synchronize the state of the Resources. This setting should only be used if the connection between the Monitoring Service and the Monitoring is using an unreliable WAN link.

Common Problems

If the Monitoring Agent Configuration is invalid or the Monitoring Agent is unavailable (for example stopped/during reboot/update/...) and/or cannot be reached for whatever reason; it is displayed in the list of configured Monitoring Agents as being offline:

A warning message can also be seen when configuring the specific view. The information is refreshed in the background and will disappear if the service comes back online or connectivity is re-established. SourceNotAvailable

Resources Tab

From within the Resources tab all Resources provided by the Monitoring Agent are listed in a clickable and sortable list that you also can apply various filter on. The total number of Resource are displayed.

The list contains the following Resource properties:

  • State - The state reported from last synchronization
  • Name - The display name of the Resource
  • Description - The user-friendly Description for the Resource
  • Application - The Application the Resource belongs to
  • Category - The Categories the Resource belongs to
  • LogText - The output text information received from last synchronization
  • Error Code - The error code received from last synchronization
  • Included in Monitor Views - a counter with the number of Monitor Views containing the Resource

Available Resources

Configuration Backups tab

Nodinite automatically performs a backup of the configuration file for the Monitoring Agent. The Monitoring agent may be installed anywhere and it may be easy to loose configuration data if the server is lost. Also, you might make changes by mistake and want to rollback to some older configuration. This feature makes it easier to test and rollback new configurations.

he background task that checks if there is a change to the configuration runs every 4 hours

Configuration Backups tab
Example list of available backups for selected Monitoring Agent

This feature has been partially in production with older versions of Nodinite. The size column is properly updated AFTER you have migrated to Nodinite 5.2 or later


You can download the configuration file. Select the backup from the list and click on the Actions button and select the Download menu item.

The downloaded file may contain sensitive data like passwords. Make sure not to leave any copies behind on the file system.


You can restore the configuration. Select the backup from the list and click on the Actions button and select the Restore menu item.

You will then be prompted to confirm the restore operation:
Confirm restore operation modal

Click on the Yes button to perform operation, and No to abort.

The result is provided as an Alert in the top of the page:
Alert restore succeeded

Control buttons

From within the Control panel there are 3 buttons:

    1. Configuration
    1. Sync now
    1. Diagnostics


1. Configuration button

Click on the Configuration button to open a dialogue for Remote Configuration. This is where you configure the actual Monitoring Agent so it knows what to do.

2. Sync now button

The Sync now button instructs the Monitoring Service to perform a synchronization right now and not wait until its' next expired polling interval.

Example of successful synchronization

3. Diagnostics button

Click on the Diagnostics button to download a package with the diagnostic files as a one single ZIP. This ZIP file contains up to 6 log files as well as a text file with some basic information about the Monitoring Agent. This information is very often requested by our Support whenever you have a problem and is key to resolving problems. The log files are all in JSON format.

Example icon in browser of downloaded ZIP file with diagnostics information

Example content, do note the hefty compression, Nodinite is optimized to preserve disk space and network utilization

The info.txt file

Nodinite diagnostics files that could contain vital information that could help us solve problem, attach this file in case you need to contact our support at support@nodinite.com

Assembly Information
Name: Nodinite.MonitoringAgent.IBMMQ

This file was automatically generated 2019-05-17 13:37:00 +02:00

Example of content within the info.txt file

If the diagnostic files does not exist, please review the following troubleshooing guide.

Run-time Information

You can easily view the actual run-time values for the chosen Monitoring Agent.

  • Connection status - The connection to the Monitoring Agent Configuration is continuously and automatically checked. You can see the status for the last alive check as well as the time of the last check.
  • Agent Type - The type of Monitoring Agent (makes it possible to sort and filter in various lists within Nodinite)
  • Server - The Server hosting the Monitoring Agent
  • Environment - The reported/configured type of run-time environment for the Monitoring Agent.
  • Version - The currently running version of the Monitoring Agent

Monitoring Agent Configuration Information

Next Step

Learn how to configure Remote Configuration

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

View Monitor Views
Monitor Views