The versaSRSServiceMonitor is a Service that once installed will monitor the status of the other versaSRS Services: versaSRSMailIn, versaSRSMailOut, versaSRSScheduler, versaCRMMailIn and versaCRMMailOut
The Service Monitor will check if the log file datetime stamp is out of sync with the current server time and if it passes a threshold (default set to 10 minutes) an alert notification will be sent to the recipient(s) set in the email template. The email template is located by default at C:\Program Files (x86)\VersaDev\versaSRS\versaSRSServiceMonitor\EmailTemplates.xml.
Upon sending the alert, the Service Monitor will also attempt to restart the stopped service. If the service cannot be restarted or starts and stops again within the threshold (10 minutes), the Service Monitor will try again for 3 consecutive attempts. If those attempts fail it means there is likely a problem that needs to be addressed and the Service Monitor will no longer attempt the restart. It will also send a Success alert if the Service can be restarted successfully.
The Service Monitor can be installed with the default configuration by following the below steps:
NOTE: If you wish to install a secondary version of these services please refer to this article.
1. On the server hosting versaSRS, access the Service Monitor folder, default location C:\Program Files (x86)\VersaDev\versaSRS\versaSRSServiceMonitor
2. Right click the install.cmd file and select 'Run as administrator', this will install the Service Monitor as a Service
3. Check the Services application and ensure that the versaSRSServiceMonitor is listed. Startup Type should be set to 'Automatic' so that if there is a server reboot it will start automatically and be able to start the other versaSRS Services.
4. From the Service Monitor folder, edit the VersaSRSServiceMonitor.exe.config file. The default settings will be fine for most values but you will need to ensure that the MailFrom address (pictured below) that is set here has permission to send email via the main SMTP account that is configured within the versaSRS Global Settings. This is needed so that any failure and success notifications can be sent.
5. In the Service Monitor folder edit the EmailTemplates.xml file - In the MailTo field for each of the Email Templates set the main recipient(s) that will receive the failure and success notifications. You can include others in the CC or BCC fields as needed. To include more than one email address separate each email with a semi-colon as shown in the image below.
6. Start the versaSRSServiceMonitor Service, and check the versaSRSServiceMonitor log file, default location C:\Temp, to ensure that it has been created and is processing (this may take a minute or two to start logging entries). The storage location of the log files can be changed by setting a new path for the Global Settings Application Property TempFolder. The Services need to be restarted for this change to take effect.
7. Test the Service Monitor by stopping one of the other versaSRS Services (versaSRSScheduler for example) and ensuring that the Service Monitor successfully restarts it, and also sends out the failure and success notifications to the intended recipients.