UtilifyUtilify Platform Help
Troubleshooting

This section describes how to troubleshoot the Utilify platform and lists some common problems and solutions.

Turning on DEBUG mode

Before troubleshooting an issue, please make sure the DEBUG mode is turned on. This will ensure that a lot more information is logged to help when trying to determine the problem. Since all the Utilify components use the same logging infrastructure, the procedure for turning on DEBUG mode is the same for all of them.

In the config file for the executable of the component for which you want to turn on DEBUG mode, locate the <log4net> configuration section. Make sure the <level> value is set to DEBUG, for the logger named Utilify as shown below.

CopyXML
1...
2<logger name="Utilify" xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5"><level value="DEBUG" /><appender-ref ref="RollingFileAppender" /></logger>
3...

Finding the log files

All Utilify components use the log4net library for logging. By default it is set to log to a file located in the temporary directory of the user account that the component runs under.

For example, on Windows XP/2003, it is

C:\Documents and Settings\<username>\Localsettings\temp\Utilify
For Windows Vista/7, it is

C:\Users\<username>\LocalSettings\temp\Utilify for regular user accounts, OR

C:\Windows\ServiceProfiles\<username>\LocalSettings\temp\Utilify for service profiles

Use a simple setup to test

Begin troubleshooting by reducing the number of components and simplying the setup, to rule out network issues, firewalls, machine-specific issues, hardware problems etc.

  1. Try setting up the smallest system with a Manager, an Executor, and the Dashboard all on one machine
  2. Once that is working, try connecting to this 'one-node' platform, by running the Dashboard on another machine
  3. Next, try running the Executor from a different machine. (one that is not running the Manager / Dashboard)
  4. If all these steps work, you can start running more Executors on different machines and isolate the problem with a particular machine.

Common problems

IssueSolution / Things to verify
Management Dashboard cannot connect to the Manager

If the error message on the Dashboard is not clear or useful:

  • Verify that the Manager service is installed and is running
  • Verify that the Manager is able to connect to the database. Check the log file for error messages related to database connection.
  • Verify that the connection string in the Manager service configuration is correct
  • Verify that the SQL Server database the Manager is attempting to connect to, is running and available.
  • Verify that the authentication specified in the connection string works.
    Note:
    If using Windows Integrated Security, the service account running the Manager should have read/write permissions on the SQL Server, to the UtilifyPlatform database. The default installation sets this up correctly for you. If the account under which the Manager service runs, is then changed manually, you will have to give that account permissions on the SQL Server.
Manager is running and the log file shows no errors, but Dashboard still cannot connect to the Manager
  • Verify that any firewall on the machine running the Manager is configured to allow listening on ports the Manager uses. To find out the ports used by the Manager, check the Manager configuration file.
  • Verify that the Dashboard is connecting using the same ports the Manager is listening on.
  • Verify that the Dashboard is connecting using an authentication mode supported by the Manager. Check the Manager configuration file to confirm the authentication modes supported. (More info)
  • Verify that any firewall on the machine running the Dashboard is configured to allow outgoing connections.
  • Check the Dashboard log file for any errors.
Dashboard connects to the Manager but shows no Executors connected.
  • Verify that atleast one machine has the Executor installed and that it is running.
  • Verify that the Executor(s) is(are) connecting using the same ports the Manager is listening on.
  • Verify that the Executor(s) is(are) connecting using an authentication mode supported by the Manager. Check the Manager configuration file to confirm the authentication modes supported. (More info)
  • Verify that any firewall on the machine(s) running the Executor(s) is configured to allow outgoing connections.
  • Check the Executor(s) log file(s) for any errors.
Cannot submit job to the Manager

  • When developing a distributed application, subscribe to the Error event of the Application class to get notified of errors during submission, and monitoring of jobs in an application.

    Also subscribe to the MessageLogged event of the Logger.

    If a job cannot be submitted, first check the errors and log messages produced by these events.

  • Using the steps specified above in the section 'Management Dashboard cannot connect to the Manager', verify the same settings - for the client application that uses the Utilify Framework.

Job is successfully submitted to the Manager, and appears in the Dashboard but is not getting executed.
  • Verify that atleast one Executor is running and connected to the Manager, and shows up in the Dashboard.
  • Check the Manager logs to see if there are messages that show that the job has been scheduled.
  • Check the Executor logs for any errors.
  • If none of the logs show any reason, contact support with the log files and required information.