- 11 minutes to read

Add or manage a Nodinite Monitoring Agent Instance

Nodinite Monitoring Agents connect your business-critical systems to a unified monitoring platform. This guide shows you how to add, configure, secure, and manage Monitoring Agents for resilient, self-service monitoring.

  • ✅ Rapidly connect and configure Monitoring Agents for any environment
  • ✅ Secure communication and remote actions with advanced authentication
  • ✅ Restore, backup, and troubleshoot with built-in diagnostics
  • ✅ Empower your team with self-service monitoring and auto healing
  • ✅ Manage resources discovered from the Monitoring Agent, including Applications and Categories values for a clear, logical overview of monitored systems

Animation: Add Monitoring Agent, paste the Quick Add JSON, Apply, Save, Sync Now, and the new agent's Resource on the Resources tab (7.12)
Register an agent in four clicks with Quick Add; the JSON carries the Authentication Key, so it is blurred here.

Discovery Model (Important)

In Nodinite, Resources, Categories, and Applications are created by the Monitoring Agent and synchronized by the Monitoring Service.

Important

Users do not manually create Resources, Categories, or Applications directly in Nodinite. Users manage configuration context, links, Expected State behavior, Auto Healing, and Custom Metadata for discovered entries.

Important

When do you need to manually add a Monitoring Agent?

Add every agent that the Monitoring Agents list doesn't show yet, whether the Portal package installed it with the CLI or you installed an MSI on another server. Use the Quick Add JSON from the generated README.txt (or the README.txt in the MSI installation folder).

Click Add Monitoring Agent on the Monitoring Agents page to open the Add Monitoring Agent page. There you fill in the new Monitoring Agent configuration in one of two ways:

  1. Quick Add: Paste the JSON string from the README.txt file in the installation folder into the Quick Add box at the top of the page and click Apply.
  2. Fill in the form: Enter the General fields, connection details, security settings, and advanced options yourself.

Monitoring Agents page with the Add Monitoring Agent button above the list (7.12)
The Monitoring Agents list has one Add Monitoring Agent button; Quick Add is part of the page it opens.

Each Monitoring Agent has a user-defined configuration entry. The User must be a member of the Nodinite Administrators' Role to manage these entries.

graph RL subgraph "Host with Monitoring Agents" roMonitorAgent(fal:fa-monitor-waveform Monitoring Agent) ro(fal:fa-lightbulb-on Resources to Monitor) roMonitorAgent --> ro end subgraph "Nodinite Core Services Server" roMonitoringService(fal:fa-watch-fitness Monitoring Service) roMonitoringService -->|"Monitoring Agent Configuration"| roMonitorAgent end style roMonitoringService fill:#E47528,color:#fff style roMonitorAgent fill:#3F827B,color:#fff style ro fill:#2678BD,color:#fff

Diagram: the Nodinite Monitoring Service (orange) uses the Monitoring Agent Configuration you create on this page to connect to a Monitoring Agent (teal), which reports the state of its Resources (blue).


Quick Add

Quickly add a new Monitoring Agent by pasting the Quick Add JSON from the README.txt file in the installation folder into the Quick Add box at the top of the Add Monitoring Agent page.

Add Monitoring Agent page with the Quick Add box (contents blurred) and Apply button above the General tab with Name, Description, Web Site, and Tags (7.12)
Quick Add sits at the top of the Add Monitoring Agent page; Apply fills in the form below it.

JSON Example

{"Name":"SQL on IBSSMIOLSRV01","Uri":"http://IBSSMIOLSRV01:8000/Nodinite/Monitor/Agent/Database/","XApiKey":"71B32996-908E-1337-417E-E5018FD4A3B4","Description":null,"PollingInterval":60}  

Example JSON quick add string from the README.txt file

Click Apply to populate the form fields from the pasted JSON. You can now continue to Manage and configure the Monitoring Agent.

Add and Manage Monitoring Agent

Below the Quick Add box, the General tab of the Add Monitoring Agent page holds these fields (see the screenshot above):

  • Name (required): User-friendly configuration name
  • Description (optional): Description of this configuration
  • Web Site (optional): External documentation link

General tab

The General tab provides essential connection details for your Monitoring Agent Configuration.
Monitoring Agent Configuration header with Mapify, Mermaid, Add Monitoring Agent and Save, above the General, Monitor Views, Resources, and Configuration Backups tabs (7.12)
General tab for Monitoring Agent Configuration.

Animation: the BizTalk agent's General tab with its Connection, Security and Advanced sub-tabs, then the Monitor Views, Resources and Configuration Backups tabs (7.12)
A tour of every tab of an agent's page; nothing is saved. The Authentication Key on the Security tab is blurred.

Configure the Monitoring Service to communicate with the Monitoring Agent.
Connection tab with the Service URL field, the Service Bus Relay Hybrid Connection URL format, and the Polling Interval set to 60 (7.12)
The help text under Service URL shows the URL format to use with a Service Bus Relay Hybrid Connection.

Tip

Set the polling interval to match your business needs. Short intervals increase system load.


Security Tab

Configure security for communication between Monitoring Service and Monitoring Agent.
Security tab with Authenticate Connection checked, the Authentication Key (blurred), and the Service Bus Relay Hybrid Connection string format (7.12)
The Authentication Key field is available when Authenticate Connection is checked.

Service Bus Relay Hybrid Connection string with EntityPath (Nodinite 7 format, as shown on the Security tab):

Endpoint=sb://<relay-namespace>.servicebus.windows.net/;SharedAccessKeyName=<shared-access-key-name>;SharedAccessKey=<shared-access-key>;EntityPath=<relay-hybrid-connection>

Advanced Tab

Configure advanced connection settings.
Advanced tab with the Change the default Timeout and Change the default Retry handling checkboxes and the Timeout, Retry Count, and Retry Interval fields (7.12)
Each value field is available only when its checkbox is checked.

  • Change the default Timeout: Timeout in seconds for polling the state of Resources from the agent (1–600, default 120)
  • Change the default Retry handling: For unreliable WAN links. Retry Count is the maximum number of retries before the agent's Resources get the Connection Error state (0–30, default 3; 0 means no retries). Retry Interval is the number of seconds between retries (10–600, default 10). Before each retry, the Monitoring Service performs an IsAlive check on the agent; a failed check still counts as a retry.

If you need to tweak these settings, review diagnostics or contact support, read more in the Support Page.


Common Problems

If the Monitoring Agent Configuration is invalid or the Monitoring Agent is unavailable, it appears offline:
Monitoring Agents list row where a red plug icon marks the Contoso Azure agent as not available, with Connection Error in Log Text (7.12)
An unavailable Monitoring Agent shows a red plug icon in the list.

A warning appears during configuration if the agent is unreachable. The message disappears when connectivity is restored.
We've encountered an error communicating with the Monitoring Agent warning with a collapsed Details box (7.12)
Expand Details to see the connection error and the exception, for example a refused connection on the agent's port.


Monitor Views Tab

New 6.0
Manage Monitor Views using the current Monitoring Agent.
Monitor Views tab of a Monitoring Agent Configuration listing Monitor Views with Edit buttons
Example of the Monitor Views tab for a Monitoring Agent.

Click Edit to manage a specific Monitor View.
Click Add Monitor View to create a new Monitor View with the agent included.


Resources Tab

The Resources tab lists all Resources provided by the Monitoring Agent. Filter by Category, Application, Status Code, and Auto Healing state, sort, and view details for each resource.

Note

These entries are discovered from the source by the Monitoring Agent. They are not created manually in the Nodinite Web Client.

  • State: Last reported state
  • Name: Display name
  • Description: User-friendly description
  • Application: Application the resource belongs to
  • Category: Category the resource belongs to
  • LogText: Output from last sync
  • Error Code: Error code from last sync
  • Included in Monitor Views: Number of Monitor Views containing the resource

Resources tab with Category, Application, Status Code, and AutoHealing State filters and the Included in Monitor View column
List of available resources for Monitoring Agent.


Configuration Backups tab

Nodinite automatically backs up the configuration file for each Monitoring Agent.

If you lose a server or make a mistake, you can restore previous configurations. Document changes with Edit Pin & Comment.

Info

Configuration backup checks run every 4 hours.

New 7.12 Nodinite keeps every backup until a user deletes it (Delete backup). The Monitoring Service removes a backup on its own only when the configuration is older than the lowest supported Monitoring Agent version, or its version is unknown; pinned backups included. Up to 7.11, the Monitoring Service also removed backups older than DaysToKeepMonitorAgentBackups days, a System Parameter that 7.12 removes.

Configuration Backups tab with the Create backup button and the Backup Time, Size, Config Version, Pinned and Comment columns (7.12)
List of available backups for Monitoring Agent.

This feature is fully supported in Nodinite 6. Older versions may not update the 'Config version' column until migration.


Download backup

Download a configuration file by selecting a backup and choosing Download from the Actions menu.
Backup Action menu with the Download item
Download backup for Monitoring Agent.

New 7.5 In Nodinite 7.5.x and later, the downloaded backup is a ZIP archive containing the configuration file:

  • Settings.json — for .NET 4.8 Monitoring Agents
  • appSettings.json — for .NET 10 Monitoring Agents

Important

Old backups may contain sensitive data. Do not leave copies on the file system.


Restore backup

Restore a configuration with the same version as the current one. Select the backup and choose Restore from the Actions menu.
Backup Action menu with the Restore item highlighted
Restore backup for Monitoring Agent.

You will be prompted to confirm the restore:
Confirm intent to Restore dialog that names the backup time and warns that overwriting the current configuration is potentially dangerous (7.12)
The dialog names the backup's creation time and warns that the old configuration may alter the monitoring targets and thresholds, so review the Monitor Views that use this agent afterwards.

Click Yes to restore, No to abort.

A success alert appears at the top of the page:
Success alert after restoring a configuration backup
Restore succeeded alert.

Important

Restoring an old configuration can drastically change monitoring. Only proceed if you are certain.

To restore an older version, stop the agent, replace the Settings.json file (appSettings.json for .NET 10 agents), and restart the Monitoring Agent. Contact support if you need help.


Edit Pin & Comment

Pin or annotate any backup. Select the backup and choose Edit Pin & Comment from the Actions menu.
Backup Action menu with the Edit Pin and Comment item
Pin or comment on backup for Monitoring Agent.

Tip

Pin the backups you must find again, and add a comment to explain why you kept them.


Delete backup

Permanently delete any backup. Select the backup and choose Delete from the Actions menu.
Backup Action menu with the Delete item
Delete backup for Monitoring Agent.


Control buttons

The Control panel provides three buttons:

  1. Configuration: Open Remote Configuration to change what the agent monitors, its Debug flag, and, for .NET 10 agents, AI Diagnostics.
  2. Sync now: Force Monitoring Service to synchronize immediately.
    Success alert after a forced synchronization with the Monitoring Agent
    Successful synchronization example.
  3. Diagnostics: Download Nodinite.diagnostic.log.json.zip with the agent's diagnostic.log.json (one or more files) and info.txt. The download fails with an error page after 120 seconds, or when the agent is down or too old.
    Animation: the Azure agent's Control card, Diagnostics, and the downloaded Nodinite.diagnostic.log.json.zip (7.12)
    Click Diagnostics on the Control card to download the agent's log files.
    Browser download bar with the Nodinite diagnostics ZIP file
    Downloaded ZIP with diagnostics.
    ZIP archive with a diagnostic.log.json file and info.txt
    Example ZIP content. A current agent writes one diagnostic.log.json; older agents may roll several files.

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 page][SupportPage]  

Assembly Information  
Name: Nodinite.MonitoringAgent.IBMMQ  
Version: 5.0.0.0  

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

Example content in the info.txt file part of the ZIP package.

If diagnostic files are missing, see the Monitoring Agents Troubleshooting and the Install and Update troubleshooting guides.


Run-time Information

The Information panel displays:

  • Connection status: Last alive check and time
  • Agent Type: Type of Monitoring Agent
  • Server: Hosting server
  • Environment: Run-time environment
  • Version: Current version
  • Config Version: Current configuration version

Information panel with connection status, agent type, server, environment, version, and config version
Monitoring Agent information panel.


Delete Monitoring Agent

Remove a Nodinite Monitoring Agent from the system if uninstalled. You can restore it later; see Show deleted records. Delete and Restore are on the row's Action menu in the Monitoring Agents list; the agent's own page has no Delete or Restore button.

Note

Deleting a Monitoring Agent removes it from synchronization. All Resources are marked as deleted and disappear from Monitor View.

Open the row's Action menu in the list and click Delete. Confirm intent in the modal.
Confirm intent to Delete dialog: The Monitoring Agent is no longer monitored and all resources are deleted (7.12)
Confirm intent to remove Monitoring Agent.

A success message appears:
Success message after deleting a Monitoring Agent
Example of a successful delete operation for a Monitoring Agent.

If you navigate to a deleted agent, you see:
Banner stating the Monitoring Agent is in the deleted state and is not operational
The agent is no longer synchronized and all resources are marked as deleted. The banner says to click the Restore button; use Restore on the row's Action menu in the list instead.


Restore Monitoring Agent

Restore a deleted Monitoring Agent if it still exists in the system.

Note

Restoring a Monitoring Agent reactivates synchronization and restores Resources.

In the list, check Include deleted, open the row's Action menu and click Restore. Confirm intent in the modal.
Confirm intent modal for restoring the Monitoring Agent
Example of the confirm intent modal for restoring a Monitoring Agent.

A success message appears:
Success message after restoring a Monitoring Agent
Example of a successful restore operation for a Monitoring Agent.


About Port 8000

If you have connection problems, see the Port 8000 user guide, and for agents in other networks, Service Bus Relaying.


Next Steps

Learn how to configure Remote Configuration.