- 5 minutes to read

Installing the Microsoft BizTalk Server Monitoring Agent

In this section, you will learn how to install the Microsoft BizTalk Server Monitoring Agent.

You must be a local administrator to have the right to install Windows Services.

Before you begin

Make sure you comply with the Prerequisites for the BizTalk Server Monitoring agent.

Step 1: Start the installer

Double click on the MSI file to start the installation of the Microsoft BizTalk Server Monitoring Agent.
msi

Step 2: Accept End User License Agreement (EULA)

The Licensee is ultimately responsible for making sure Nodinite products are used according to the End User License Agreement. Make sure you have the assigned formal rights to install and perform modifications to the target environment before you continue installing any Nodinite products.

EULA
You must accept the terms in the License Agreement to continue

The EULA provided with the installer is the generic standard EULA. Your organization may have signed another version part of a formal agreement.

Step 3: Welcome screen

On successful execution of the MSI file a Welcome screen will be presented.
Welcome

Click on the 'Next' button to continue with the installation process or click on the 'Cancel' button to quit the installer.

Step 4: Custom setup

Select Components and Location of installation. Default settings are recommended.
CustomSetup

Click on the 'Next' button to continue with the installation process or click on the 'Cancel' button to quit the installer.

Step 5: Service Account Information

Enter the credentials for the Account to run Microsoft BizTalk Server Monitoring Agent. Depending on the connection string settings this account will be used to log on and query the databases being monitored.

Domain: The name of the Domain the Server belongs to. If a local account is being used, use the name of the server or . (dot) as Domain
User: The name of the account
Password: The password for the account.

Note: The account must have 'Log on as Service Right'

DomainUser

Click on the 'Next' button to continue with the installation process or click on the 'Cancel' button to quit the installer.

Insufficient Privileges

Error message when account information does not meet Prerequisites.
InsufficientPrivileges

If you get this message, the most common reason is that the account is not allowed to run as a service or is not local Administrator on the server. Follow the guide How to set Logon as a Service right and click retry. If the problem remains, click cancel and restart. Make sure that the credentials are typed correctly!

Tip: Check the local event log if there are errors (both System and Application)

Step 6 Completed setup

The last step of the installation gives either a success or a premature exit.
Successful installation example
Completed

Failed installation example: A failed installation will render a premature exit
PrematureExit

Click the 'Finish' button to Exit and quit the installer.

When the setup has finished the default text editor will open a text file named the 'README.txt'. The README.txt file holds additional information that you need to add the agent as a Monitoring Agent Configuration.
README.txt

Step 7: Add Agent as a new Monitoring Agent Configuration

The last installation step would be to install the Monitoring Agent as a new Monitoring Agent Configuration from within the Web Client with information as provided from the README.txt file in the previous step.


Support

Contact our Support for additional guidance if you fail to resolve the installation problem.

Note: There may be additional information written to the Windows Event logs.

Frequently asked questions

Common problems and FAQ for the Microsoft BizTalk Server Monitoring agent can be found in the troubleshooting page.

Cluster BizTalk Monitor Agent for High Availability

If you require High Availability monitoring of your BizTalk Server environment, the Nodinite Microsoft BizTalk Server Monitoring Agent can be clustered in a fail-over configuration.

Prerequisites

  • The Monitoring Database must have been installed. If you already have the database installed, make sure it is updated to the latest version
    • Support for SQL Server Always on exists but you must manually configure the initial synchronization
  • Your BizTalk Server environment must be installed in a Windows Server fail-over cluster configuration
  • DACFramework.msi (18.0 or later to match your version of SQL Server, higher versions are backwards compatible)
    • Download and install on all BizTalk Server processing nodes. Either from Microsoft or from here

Step by step guide

  1. Install the Nodinite Microsoft BizTalk Server Monitoring Agent on at least two BizTalk Nodes according to the general instructions on this page and then stop the Windows Service

  2. Change the following fields in the Settings.json file (Make the change on one node and copy/replace on the other nodes)

    • "HighAvailability": true,
    • "HighAvailabilityNodeName": "%BT-CLUSTERNAME%" - The BizTalk Server cluster name
    • "MonitorAgentConnectionString": "Server=%NODINITESQLSERVERNAME%;Database=Nodinite_MonitoringAgent_BizTalk;Integrated Security=SSPI;Connection Timeout=60" - The SQL Server instance with the BizTalk Server Monitoring Database
  3. If this is the first installation, make sure the Monitoring Database is installed

  4. Cluster the Microsoft BizTalk Server Monitoring Agent Windows Service as a generic service in a role with the cluster name provided by the HighAvailabilityNodeName property.

    NOTE: MAX 15 chars or you might get DNS related problems

  5. Bring the clustered service online from any of the BizTalk procecessing nodes where the agent was installed

  6. Open the file Readme.txt. The provided "URIs" should now use the BizTalk cluster name.

    NOTE: This cluster name MUST exist in your DNS

  7. Make sure the 'Service URI' in the Connection tab is updated
    Service URL


Next Step

Configuration of the agent
Update
Uninstall

Add or manage a Monitoring Agent Configuration
Monitoring Agents
Prerequisites for BizTalk Monitoring Agent
Web Client