References > Component Monitor Types > Oracle User Experience Monitor

Oracle User Experience monitor

This component monitor uses synthetic transactions to test the abilities of an Oracle database. The component monitor connects to the database, performs a query, and then retrieves the data. Oracle Net Services from the Oracle Client must be installed on the SolarWinds SAM server. You can monitor using the Orion agent for Linux.

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.

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.

Install the Oracle Client on the SolarWinds SAM server

This component monitor requires you to install the Oracle Net Services from the Oracle Client on your SolarWinds SAM server. You can download the Oracle Client from:

TCP Ports

This component monitor uses ports TCP/1521 and TCP/1526. The Oracle SQL*Net Listener allows Oracle client connections to the database over Oracle's SQL*Net protocol. You can configure it during installation. To reconfigure this port, use Net Configuration Assistant.

Prerequisites for Orion Agent for Linux

If using this component monitor with the Orion agent for Linux, you may need to install and configure ODBC. For full configuration details, see Linux configurations for component monitors.

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.

Port Number

This field allows you to specify the port number used to communicate with the Oracle database. The default value for this field is 1521.

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 4000 characters.

Destination Point Type

This option tells SolarWinds SAM whether you are accessing the database by its  Oracle System ID (SID) or by its service name.

SID: Select this to access the database by its System ID.

Service_Name: Select this to access the database by its service name. Though we call this option 'net service name', do not enter the net service name.

Destination Point Name

This field allows you to specify either the service name or the SID to access the Oracle database over a network. Do not enter the net service name. To determine the name or SID of the database, refer to the tnsnames.ora Oracle configuration file or ask your database administrator.

Example of a service name as a destination point name

Destination Point Name: sales.us.example.com
Destination Point Type: SERVICE_NAME

tnsnames.ora:

ORA11 = (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = 127.0.0.1)(PORT = 1521))) (CONNECT_DATA = (SERVICE_NAME = sales.us.example.com)))

Example of a SID as a destination point name

Destination Point Name: ORA11DATABASE
Destination Point Type: SID

tnsnames.ora:

ORA11 = (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = 127.0.0.1)(PORT = 1521)) (CONNECT_DATA = (SID = ORA11DATABASE)))

Oracle Driver Type

Allows you to select the driver from the drop down list.

Oracle Driver Type

Select the Oracle driver type of Microsoft .NET Data Provider or Oracle Data Provider for .NET.

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. See setting Conversion value for more information.

Response Time Warning 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, or 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}.

Scenario

SAM requires two additional components in order to monitor Oracle databases:

  • Oracle's Instant Client
  • SolarWinds Oracle Plug-in.

The steps below should result in a successfully tested and monitored database.

  1. The first item to install is the Oracle Instant Client Basic.  (In this scenario, we also install the Instant Client ODBC and SQLPlus packages).
  2. Create the directory where the products will be stored. For example: c:\Oracle
  3. Unzip the files into the created directory and preserve the path. For example: Instantclient_11_2
  4. Modify your path to reference the directory that the Instant Client files were extracted to:
    • Path: Add c:\oracle\instantclient_11_2
    • Tns_Admin: Create if necessary, c:\oracle\instantclient_11_2
  5. Log out to ensure Windows identifies the variables you defined.
  6. Create a TNSNAMES.ora file and save it in to c:\oracle\instantclient_11_2.

    An example of TNSNAMES.ora can be found at: http://www.orafaq.com/wiki/Tnsnames.ora)

  7. Install the SolarWinds Oracle Plug-in:
    1. Log in to the SolarWinds Customer Portal
    2. Click on Additional Components
    3. Click on Download Server & Application Monitor Components
    4. Click on the Oracle Client
    5. Run and install the OracleClientInstaller.exe file
  8. Log in to SolarWinds and browse to the SAM Monitor.
    • Each application item was set up using a SERVICE_NAME point type, with the database name as the Destination Port Name.
    • The User ID to be used for this test cannot be limited or restricted, otherwise it will return errors.
    • Test each component monitor.