References > Component Monitor Types > ODBC User Experience Monitor

ODBC User Experience monitor

This component monitor uses synthetic transactions to test the abilities of an ODBC-accessible database such as MySQL. The component monitor connects to the database, performs a query, and then retrieves the data. ODBC drivers for your database type must be installed on the SolarWinds SAM server.

The SQL statement you use for this query must return a numerical value, not a varchar.

This monitor has the ability to capture message text in the first row, second column of SQL query results. This string value is shown in the Messages field of the component monitor.

For instructions configuring ODBC when polling with Orion Agent for Linux, see Linux system configurations for component monitors.

Statistic

The statistic for this component monitor is the first row and column of the data retrieved by the query. It must be a numerical value.

Message (optional)

Value of the second column first cell of the query result. This is not required.

Install ODBC Drivers on the SolarWinds SAM Server.

You must install on the SolarWinds SAM server the ODBC drivers for your database. For more information on acquiring or installing the ODBC drivers, consult your database documentation.

In some situations, monitors derived from this ODBC component can fail because the bit mode setting (x32/x64) is set incorrectly. This can happen to database servers that only install x64 drivers on a x64, making this monitor inaccessible in x32 mode.

TCP Ports

This component monitor uses port TCP/1630. Oracle Connection Manager provides the listening port for Oracle client connections to Oracle Connection Manager. You can configure Oracle Connection Manager either through a custom installation, or configure it after installation using Net Configuration Assistant.

Field Descriptions

Description

This field provides a default description of the monitor. You have the ability to override the default description by adding to or replacing the text, which is automatically saved. The variable to access this field is ${UserDescription}.

Enable Component

Determines whether the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SolarWinds SAM application availability or status.

Credential for Monitoring

Select a database credential that can access the database. If the credential you need is not already present in the credentials list, use the Quick Credentials section to add a new credential.

Connection String

This field allows you to specify the ODBC connection string for the database. If you do not know the connection string to your ODBC-accessible database, you can look it up on http://www.connectionstrings.com. The connection string may include the variables ${IP}, ${USER}, and ${PASSWORD}, which are replaced respectively by the IP address of the database server, the credential user name, and the credential password.

If you are using the ODBC User Experience Monitor instead of the SQL Server User Experience monitor for a SQL Server database that is not using the default port 1433, perform the following to create a connection string.

To create the SQL Server connection string:

  1. Using notepad, create an empty .udl file.
  2. Double-click the .udl file to open the Data Link Properties dialog. Click Next to navigate from tab to tab and configure and test your ODBC connection.

    Remember to select the desired database provider on the Provider tab, in this case the provider for SQL Server.

  3. If the option is present for the provider, check the “allow saving password” option, as this will ensure that the connection string contains the password when you next retrieve it.
  4. When you are finished, and have tested that the connection works, click OK.
  5. Open the .udl file again in Notepad, and retrieve the connection string.

    For additional information about creating and configuring Universal Data Link (.udl) Files, refer to the MSDN article.

Sql Query

This field allows you to specify the SQL query used to test the database. The retrieved data is then used as the component monitor statistic. You may enter up to 4,000 characters.

Query Timeout

The amount of time, in seconds, until the SQL query will timeout.

Count Statistic as Difference

Changes the statistic to be the difference in query values between polling cycles.

Convert Value

Checking the Convert Value check box opens the Formula box. From here, you have the ability to manipulate the returned value with a variety of mathematical possibilities. You can choose common functions from the drop down lists to manipulate the returned value, or you can select the Custom Conversion option.

Response Time Threshold

This field allows you to set the warning or critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SolarWinds SAM to determine that a component is not Down and to retrieve any statistical data. See setting Application Monitor Thresholds for more information.

Statistic Threshold

This field allows you to specify when a threshold that indicates a warning or critical level has been breached. Logical operators are in the drop down followed by a blank field for you to enter the value of this threshold. For example: Less than 15 for warning, Less than 5 for critical. See setting Application Monitor Thresholds for more information.

User Notes

This field allows you to add notes for easy reference. You can access this field by using the variable, ${UserNotes}.