Adding and editing a SQL Query performance monitor

This monitor allows you to check for certain conditions in a Microsoft SQL, MySQL, or ORACLE database, based on a database query.

Note: This feature is available with WhatsUp Gold Premium, ProView, TotalView, and TotalView Plus Editions only. To update your license, visit the WhatsUp Customer Portal.

Important: To monitor a MySQL database, download and install the MySQL .NET Connector on the WhatsUp Gold machine. Please note, only MySQL .NET Connector version 5.2.5 is supported due to potential compatibility issues. The MySQL .NET Connector can be downloaded here.

If you would like to begin monitoring MySQL 5.6/5.7 using this version of WhatsUp Gold, you’ll first need to download the v5.2.5 connector in .zip archive format here. After accessing the MySQL Product Archives URL, select 5.2.5 as the Product Version and .NET & Mono as the Operating System from the applicable drop-down menus, then click Download. Extract the MySql.data.dll file from the downloaded .zip package, then copy it into the following two locations inside the WhatsUp Gold installation folder:
C:\Program Files (x86)\Ipswitch\WhatsUp\
C:\Program Files (x86)\Ipswitch\WhatsUp\html\NM.UI\bin\extensions\WUG\
Please note, the file paths displayed here represent the default locations used by the installation program. If you have WhatsUp Gold installed in a different location, copy the .dll file into the corresponding folders on your server.

Note: The SQL Query monitor supports Windows and ADO authentication. Make sure that credentials are setup in the Credentials Library for the database for which you want to query. The Credentials system stores Windows and ADO database credential information in your WhatsUp Gold database to be used when a database connection is required. For more information, see Using Credentials.

Note: When connecting to a remote SQL instance, WhatsUp Gold only supports the TCP/IP network library.

To add a new SQL Query performance monitor:

From the WhatsUp Gold web interface, go to Admin > Monitors. The Monitor Library dialog appears.
Click the Performance tab. The Performance Monitor list appears.
Click New. The Select Performance Monitor Type dialog appears.
Select SQL Query Performance Monitor, then click OK. The New SQL Query Monitor dialog appears.
Enter the appropriate information:
- Name. Enter a unique name for the performance monitor. This name displays in the Performance Monitor Library.
- Description. (Optional) Enter additional information about the monitor. This description displays next to the monitor in the Performance Monitor Library.
Enter or select the appropriate information for the Server Properties section:
- Server Type. Select Microsoft SQL Server, MySQL, or ORACLE as the database server type.
Note: MySQL database is supported and listed as a server type option only if the MySQL 5.2.5 Connector is installed.
- Connection Timeout (sec). Used by the SQL Query monitor to determine how long to wait for the server to respond before terminating the connection and returning the timeout error. Minimum allowed value is 1 second whereas maximum allowed value is 120. The default value is 15 seconds.
Note: The connection timeout setting configured by the user is used for polling only; the query builder does not use it. Instead, the query builder assumes a default of 15 seconds for the connection timeout.
- Server Address. ServerName\Instance format for Microsoft SQL Server (for example, WUGServer\SQLEXPRESS), ServerName for MySQL (for example, WUGServer), or ServerName/ServiceName for Oracle (for example, WUGServer/Oracle).
Note: When using an Oracle server type, the SQL query monitor does not make use of the tsnnames.ora file on the client (i.e. WhatsUp Gold system).
- Port (optional). The database server port number if other than the standard database port number.
- SQL Query to Run. A query you want to run against a database to monitor and check for certain database conditions. Only select queries are allowed.
  Important: Make sure that you include the full database name in your query. For query help, click Build. The SQL Query Builder will assist you in developing proper query syntax.
  
  Important: The SQL query you enter must return a single numeric value. Specifically, a single record that has just one column. If the query returns more than one record, the monitor will fail to store the data. If the query returns a single records but there are multiple columns in the record returned, then the monitor will pick the first column as the value to store and this first column has to be numeric, otherwise the monitor will fail to store the data.
- Build. Click to open the SQL Query Builder dialog for assistance building queries.
- Verify. Click to check that the query is valid. If there is a syntax error with the SQL query, a message appears with tips about the syntax issue.
Click OK to save changes.
After the monitor has been added to the library, you can enable the monitor through Device Properties > Performance Monitors. For more information, see Enabling performance monitors.

To edit an existing SQL Query performance monitor:

From the WhatsUp Gold web interface, go to Admin > Monitors. The Monitor Library dialog appears.
Click the Performance tab. The Performance Monitor list appears.
Select the performance monitor you would like to edit from the list of current monitors, then click Edit. The Edit SQL Query Performance Monitor dialog appears.
Enter the appropriate information:
- Name. Enter a unique name for the performance monitor. This name displays in the Performance Monitor Library.
- Description. (Optional) Enter additional information about the monitor. This description displays next to the monitor in the Performance Monitor Library.
Enter or select the appropriate information for the Server Properties section:
- Server Type. Select Microsoft SQL Server, MySQL, or ORACLE as the database server type.
Note: MySQL database is supported and listed as a server type option only if the MySQL 5.2.5 Connector is installed.
- Connection Timeout (sec). Used by the SQL Query monitor to determine how long to wait for the server to respond before terminating the connection and returning the timeout error. Minimum allowed value is 1 second whereas maximum allowed value is 120. The default value is 15 seconds.
Note: The connection timeout setting configured by the user is used for polling only; the query builder does not use it. Instead, the query builder assumes a default of 15 seconds for the connection timeout.
- Server Address. ServerName\Instance format for Microsoft SQL Server (for example, WUGServer\SQLEXPRESS), ServerName for MySQL (for example, WUGServer), or ServerName/ServiceName for Oracle (for example, WUGServer/Oracle).
Note: SQL query monitors do not make use of tsnnames.ora file on the client (i.e. WhatsUp Gold system).
- Port (optional). The database server port number if other than the standard database port number.
- SQL Query to Run. A query you want to run against a database to monitor and check for certain database conditions. Only select queries are allowed.
  Important: Ensure that you include the full database name in your query.
- Build. Click to open the SQL Query Builder dialog for assistance building queries.
- Verify. Click to check that the query is valid. If there is a syntax error with the SQL query, a message appears with tips about the syntax issue.
Click OK to save changes.