Configuring and Integrating Oracle

Transcription

1 Configuring and Integrating Oracle The Basics of Oracle 3 Configuring SAM to Monitor an Oracle Database Server 4 This document includes basic information about Oracle and its role with SolarWinds SAM Adding an Oracle Database Server to SAM 13 Monitoring an Oracle Database on an Existing Node 18 Troubleshooting 26

2 2 Configuring and Integrating Oracle Copyright SolarWinds. All rights reserved worldwide. No part of this document may be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the written consent of SolarWinds. All right, title and interest in and to the software and documentation are and shall remain the exclusive property of SolarWinds and its licensors. SolarWinds Orion, SolarWinds Cirrus, and SolarWinds Toolset are trademarks of SolarWinds and SolarWinds.net and the SolarWinds logo are registered trademarks of SolarWinds All other trademarks contained in this document and in the Software are the property of their respective owners. SOLARWINDS DISCLAIMS ALL WARRANTIES, CONDITIONS OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON SOFTWARE AND DOCUMENTATION FURNISHED HEREUNDER INCLUDING WITHOUT LIMITATION THE WARRANTIES OF DESIGN, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL SOLARWINDS, ITS SUPPLIERS OR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY EVEN IF SOLARWINDS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Microsoft and Windows 2000 are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Graph Layout Toolkit and Graph Editor Toolkit Tom Sawyer Software, Oakland, California. All Rights Reserved. Portions Copyright ComponentOne, LLC All Rights Reserved. Document Revised 3/29/2012- DJR

3 Configuring and Integrating Oracle 3 The Basics of Oracle This document is designed to give you a basic introduction to the Oracle database model and its use with SolarWinds SAM. For more detailed information on Oracle, seek resources outside of this guide. Physical and Logical Structures An Oracle database system is made up of at least one instance of the application, along with data storage. An instance, identified by an instantiation number (or activation id: SYS.V_$DATABASE.ACTIVATION#), is made up of a set of operating system processes and memorystructures that work with the storage. If an Oracle database administrator has employed Oracle RAC (Real Application Clusters), then multiple instances attach to a storage array. This implementation offers advantages such as better performance, scalability, and redundancy. The Oracle DBMS can store and execute procedures and functions within itself. PL/SQL or the objectoriented language, Java, can use such code objects and/or provide the programming structures for writing them. Storage The Oracle RDBMS stores data in the form of tablespaces and physically in the form of ("datafiles"). Tablespaces can contain various types of memory segments, such as Data Segments, Index Segments, etc. Segments are made up of one or more extents. Extents make up groups of continuous data blocks. Data blocks are the basic units of data storage. Newer versions of the database include a partitioning feature, which allows tables to be partitioned based on different sets of keys. Oracle tracks its data storage using the information stored in the System tablespace. The System tablespace contains the data dictionary, indexes and clusters. A data dictionary consists of a collection of tables that has information about all user objects. Beginning with version 8i, the Oracle RDBMS also supports locally managed tablespaces which can store space management information in their own headers rather than in the System tablespace. Disk files Disk files primarily consist of the following types: Data and index files: These files are necessary for the physical storage, which can be made up of the data dictionary, user data, or index data. These files may be managed manually or by Oracle itself, Note: A datafile has to belong to exactly one tablespace, whereas a tablespace can consist of multiple datafiles. Redo log files: These consist of all changes to the database used to recover from an instance failure. Note: These files are stored multiple times for security in case of a catastrophic failure. The identical redo log files are part of the same group. Undo files: These are datafiles which contain undo information and are used for recovery. Archive log files: These files are copies of the redo log files and stored at different locations. These files are necessary. Tempfiles: These datafiles are used for temporary storage data.

4 4 Configuring and Integrating Oracle Control file: This file is necessary for database startup. This file records the physical structure of a database and holds the names and locations of redo log files, the time stamp of the database creation, the current log sequence number, checkpoint information, and so forth. Configuring SAM to Monitor an Oracle Database Server SAM provides an application template for monitoring Oracle databases. This is called the Oracle Database Template. However, unlike most applications, this requires additional drivers to be downloaded and installed on the computers where SAM and any additional pollers are running. Prerequisites for Oracle Server Monitoring There are two Oracle data providers which can be used with SAM: Oracle Data Provider for.net (ODP.Net) Installer package Basic Lite Oracle Client Note: Some required settings information will be needed. See Getting the Required Settings, on page 22. Installing ODP.Net The following instructions describe the recommended method for monitoring Oracle databases using ODP. Net. Uninstall any other version of the Oracle Client before proceeding. Ensure that SolarWinds Basic Lite Oracle Client is not installed. Verify that the following directory does not exisit or is empty: C:\Program Files (x86)\solarwinds\orion\apm\oracleclient\. If it is not empty, stop all Orion services and remove this directory before you continue with your installation. Note: ODP. Net is not part of SolarWinds SAM and may need to be downloaded from the Oracle website, which requires free registration. Download the 32-bit version of ODP.Net, even if SAM is installed on a 64-bit version of Windows. 1. You can use the following link to download ODP.Net: If you do not want to register with Oracle, you can use the Basic Lite Client which can be downloaded by logging in to your SolarWinds customer portal. Location and installation instructions can be found on page 9.

5 Configuring and Integrating Oracle 5 Following is a screenshot of Oracle's website with the both the 32 and 64-bit versions highlighted. Download the 32-bit version. Note: You can download the 64-bit version. Installing this version will require you to poll jobs using the 64-bit option within SAM. 2. Next, download ODAC with Oracle Developer Tools for Visual Studio, as shown below. This installation package comes with its own installer:

6 6 Configuring and Integrating Oracle 3. Accept the License Agreement and then select the latest version when prompted. You will be asked for your Oracle username and password. If you have not already done so, register for free with Oracle to obtain these needed credentials. 4. Login to SAM using an administrator account. 5. Copy the downloaded file to the SAM computer then extract the contents and run setup.exe. 6. When setup.exe runs, go to the next step and select the first option as shown below. (This option contains what is necessary for SAM to be able to monitor an Oracle database server.) Note: If the Oracle server is being polled from an additional poller, then this software needs to be installed on that additional poller as well.

7 Configuring and Integrating Oracle 7 7. Enter the path where the files should be installed. 8. Either install everything or select the following two components: Oracle Data Provider for.net Oracle Instant Client

8 8 Configuring and Integrating Oracle 9. Start the installation. 10. When the installation finishes successfully, click Exit. Restart all Orion services by navigating to: Start > SolarWinds Orion > Orion Service Manager. Note: Restarting of the services is necessary because the Oracle installer added its installation directory (c:\app\administrator\... by default) to the Path variable. 11. From the Service Manager, click Shutdown Everything. 12. When all services have stopped, click Start Everything and wait for the services to begin.

9 Configuring and Integrating Oracle 9

10 10 Configuring and Integrating Oracle Installing the Basic Lite Oracle Client Follow these steps only if you cannot use the full Oracle Data Provider. Note: The Basic Lite Oracle Client may not support the latest versions of Oracle database servers. Therefore, this version may not support all data types used in monitoring your queries. 1. Ensure that the SolarWinds Basic Lite Oracle Client is not currently installed. If it is installed, the following is the default path and must be deleted before proceeding: c:\program Files (x86)\solarwinds\orion\apm\oracleclient\. If this folder is not empty, stop all Orion services and remove this directory before continuing with the Oracle Client installation. 2. Log in to your customer portal. Once logged in, navigate to SolarWinds customer portal > Additional Components > Oracle Client. From here you can download the needed files. 3. Use the Oracle Client link to download the installation package. 4. Copy the downloaded file to the SAM computer and extract OracleClientInstaller.exe from the zip archive. 5. Run the installer under an administrator account.

11 Configuring and Integrating Oracle The installer window is automatically closed after a few seconds, which is expected. 7. After the installer window closes, navigate to the SAM installation directory, typically: C:\Program Files\SolarWinds\Orion, and ensure that the subfolder, APM\OracleClient was created successfully and contains the five files as shown below:

12 12 Configuring and Integrating Oracle 8. Check the file properties of each.dll file to ensure that the account under which the SolarWinds JobEngine v2 service runs has high enough privileges to load these libraries. 9. Restart all Orion services by navigating to Start > SolarWinds Orion > Orion Service Manager. Note: Restarting of the services is necessary because the Oracle installer added its installation directory (c:\app\administrator\... by default) to the Path variable. 10. From the Service Manager, click Shutdown Everything. 11. When all services are stopped, click Start Everything and wait for the services to begin.

13 Configuring and Integrating Oracle 13 Adding an Oracle Database Server to SAM 1. Navigate to Start > SolarWinds Orion > Orion Web Console to open the SAM website. 2. Log in to the SAM web console. 3. If the node you want to monitor is not currently monitored by SAM, navigate to Settings > Add Node and follow the wizard to start monitoring the Oracle computer as a node in SAM. Note: The Oracle server can be added as any type of node (ICMP, SNMP, WMI).

14 14 Configuring and Integrating Oracle 4. At the Add Application Monitors step, select the Oracle Database Template. Do not test it. At this stage the application template requires further configuration which cannot be done from this page. Testing at this point will result in a failure. 5. Go to the last step of the wizard and click OK, ADD NODE. 6. You will be redirected to the Manage Nodes page. Search for the newly added Oracle server and click on it to go to its Node Details view.

15 Configuring and Integrating Oracle Search for the Applications resource on this view and click on the Oracle Application to go to its Application Details View. 8. On the Application Details View, notice the Oracle Database is in an Unknown state. This is because it is not properly configured. Click on Edit Application Monitor to begin configuring these settings.

16 16 Configuring and Integrating Oracle 9. Expand each monitor by clicking the [+] icon to the left of each component monitor in the list.

17 Configuring and Integrating Oracle The correct settings for the fields, Destination Point Type and Destionation Point Name (highlighted above) should be provided by the administrator of the Oracle server. This example is testing against the Oracle 10g Express Edition, which is configured to have the name "XE." 11. Repeat steps 9-10 for each monitor in this template. The Oracle driver type must correspond with the installed Oracle Client software (as described earlier in the Prerequisites for Oracle Server Monitoring section on page 4). The following table shows which combinations work together. Oracle Driver Type setting in Web UI Oracle Client package Full Oracle Data Provider for.net (ODP.NET Basic Lite Oracle Client (from SolarWinds Customer Portal) Microsoft.NET Data Provider (MS_ORACLECLIENT) Works Works Oracle Data Provider for.net (ODP.NET) Works Does not work

18 18 Configuring and Integrating Oracle Monitoring an Oracle Database on an Existing Node If an Oracle database server is already being monitored by SAM as a node, perform the following steps to configure the node: 1. In the SAM web console, navigate to Settings > SAM Settings > Manage Templates 2. Search for the Oracle Database Template, select it by checking the box next to the name. 3. Click Assign to Node.

19 Configuring and Integrating Oracle Next, search for Oracle. 5. Once found, check the nodes you want to add. 6. Click the green arrow to add it to the Selected Nodes column.. 8. The Oracle node will be moved to the Selected Nodes column. 9. Click Next.

20 20 Configuring and Integrating Oracle 10. Select the credentials to be used and then click Assign Application Monitors. Note: Do not test the application now. This application is not properly configured. There are settings specific to the Oracle server which will be set later. 11. Click Edit to go to the Edit Application page.

21 Configuring and Integrating Oracle Expand each monitor by clicking the [+] icon to the left of each component monitor in the list.

22 22 Configuring and Integrating Oracle 13. The correct settings for the fields Destination Point Type and Destionation Point Name (highlighted above) should be provided by the administrator of the Oracle server. This example is testing against the Oracle 10g Express Edition, which is configured to have the name "XE." 14. Repeat steps for each monitor in this template. Use the following table for reference: Oracle Driver Type setting in Web UI Oracle Client package Full Oracle Data Provider for.net (ODP.Net Basic Lite Oracle Client (from SolarWinds Customer Portal) Microsoft.NET Data Provider (MS_ORACLECLIENT) Works Works Oracle Data Provider for.net (ODP.NET) Works Does not work

23 Configuring and Integrating Oracle 23 Getting the Required Settings The Oracle User Experience Monitor s settings must match the settings on the Oracle Server. Database Administrators usually provide a file with connection details (tnsnames.ora) to database users and users add this file to their Oracle Client directory. SAM does not use the tnsnames.ora file directly. The user needs to input all of the settings to the Oracle User Experience Monitor in the SAM web interface. If you were not given tnsnames.ora file by your database administrator, but have access to Oracle Server system, follow these steps to locate the tnsnames.ora file: 1. Log in to the Oracle Server using an administrator account. 2. The Tnsnames.ora file should be located at $ORACLE_HOME/network/admin/tnsnames.ora, where $ORACLE_HOME is the directory where the Oracle Server was installed. 3. Once you have located this file, open the file and follow these steps to extract the required information. a. Locate the section in the file that describes the options for the database instance you want to monitor. For the most part, this section will contain the settings for Protocol, Host, and Port as shown in the examples bulleted below. b. Once you locate this section, extract the following settings and use them in the Oracle User Experience Monitor: Protocol Must be TCP. This how SAM connects to the remote Oracle Server. Host Must match the IP address (or hostname, which resolves to that IP) of the Oracle server node in SAM. Port Use this setting for the Port Number field of Oracle User Experience Monitor. Service_Name If this is present in the tnsnames.ora configuration section, then select the value for the Service_Name for the Destination Point Type field of the Oracle User Experience Monitor. SID If this is present in the tnsnames.ora configuration section, then select the SID value for for the the Destination Point Type field of the Oracle User Experience Monitor. Service_Name or SID settings in tnsnames.ora also defines a connection point name (after the "=" character), which needs to be used for the Destination Point Name field of the Oracle User Experience Monitor.

24 24 Configuring and Integrating Oracle Example 1: Below is a sample tnsnames.ora file from the Oracle Server 10g Express Edition. Highlighted are the settings mentioned previously. Example 2:

25 Configuring and Integrating Oracle 25 Here is what the configuration of the Oracle User Experience Monitor should look like when completed correctly using Example 1: Here is what the configuration of the Oracle User Experience Monitor should look like when completed correctly using Example 2:

26 26 Configuring and Integrating Oracle Troubleshooting If the Oracle User Experience Monitor does not work properly, explore the following troubleshooting sections. Oracle Client Driver and Server Compatibility SAM is Unable to Load the Oracle Client Driver Using Process Explorer to Determine if SAM is Loading the Correct Oracle Client Library Using Process Monitor to Determine Why the Oracle Client fails Oracle User Experience Monitor is Unable to Connect to the Oracle Server Using the Oracle SQL*Plus Tool to Troubleshoot Connectivity Issues: Note: Many of these troubleshooting procedures are used by SolarWinds support technicians. Oracle Client Driver and Server Compatibility Notes: Oracle Client drivers are not forward and backwards compatible with all Oracle database servers. Oracle Data Provider for.net (ODP.NET) is compatible only with Oracle Server 9.2 and higher. Monitoring two different versions of Oracle Server might not be possible if there is no appropriate driver which would be able to connect to both server versions. If this is the case, have the second version of the Oracle Client on an additional poller and assign the nodes there. SAM is Unable to Load the Oracle Client Driver Following is a screenshot of this error:

27 Configuring and Integrating Oracle 27 Troubleshooting: Make sure that the Oracle Client was installed on the SAM computer or on the appropriate additional poller. Do not deploy two different Oracle Client Driver versions on the SAM computer. If the above was unsuccessful, follow these troubleshooting steps: 1. Download Process Explorer and install it on the SAM computer. 2. Run Process Explorer and look for the JobEngineWorker2.exe processes, (which belongs to SAM). This can be identified by the command line argument, "SolarWinds.APM.Probes." 3. Display the JobEngineWorker2.exe properties to ensure that the environment variable ORACLE_HOME exists and points to the correct location where the Oracle Client is installed. The example below shows ORACLE_HOME set to the APM\OracleClient directory. This computer has the Basic Light Oracle Client installed (not the full ODP.NET version).

28 28 Configuring and Integrating Oracle Using Process Explorer to Determine if SAM is Loading the Correct Oracle Client Library To determine if SAM is loading the correct Oracle Client Library, follow these steps: 1. In Process Explorer, navigate to View > Show Lower Pane. Then, navigate to View > Lower Pane View > DLLs. 2. Locate the JobEngineWorker2.exe (which belongs to SAM) and see if the oci.dll file is displayed in the DLL list in the lower pane.

29 Configuring and Integrating Oracle Verify that the path is set to the correct directory. This step needs to be done for each JobEngineWorker2.exe instance that belongs to SAM. This can be identified by the command line argument, "SolarWinds.APM.Probes."

30 30 Configuring and Integrating Oracle Using Process Monitor to Determine Why the Oracle Client fails If the Oracle Client is not visible in Process Explorer, perform the following steps to determine from which directory SAM is trying to load the Oracle Client: 1. Download Process Monitor from the following link: 2. Start Process Monitor and define Filter.

31 Configuring and Integrating Oracle Add the following conditions: Process Name equals SWJobEngineWorker2.exe. Path contains oci.dll. 2. Click OK. 3. Restart the JobEngine v2 service and wait for it to fully restart. 4. Go to the Oracle Database Edit page and test one of the components. 5. Wait until the test is finished and then stop the trace (File > Capture Events). 6. Analyze the results. There will be information about SWJobEngineWorker2.exe trying to find the oci.dll file, (which is part of the Oracle Client), revealing a list of directories it was searching for and whether or not it was successful. The Load Image event indicates whether or not SAM was able to load that library successfully. This may fail if the architecture of this library does not match the architecture of the polling job (as defined on the Application Edit page in SAM).

32 32 Configuring and Integrating Oracle 7. See the following illustration: Below is sample output when the Oracle Client is not installed and therefore not found: Here you can see which directories are being searched to locate the file. Below you can see that the full Oracle Client was installed:

33 Configuring and Integrating Oracle 33 Here you can see SAM was not able to load the Oracle Client because it does not match the platform of the polling job. In this case, the Oracle Database application is set to run as 64-bit, but the 32-bit version of the Oracle Client was installed. You can also see that SAM finds the oci.dll and opens it to read from it, but it detects that this is the wrong platform. Consequently, there is no Image Load operation:

34 34 Configuring and Integrating Oracle Oracle User Experience Monitor is Unable to Connect to the Oracle Server Below is a screenshot of this error:

35 Configuring and Integrating Oracle 35 Troubleshooting steps: 1. Make sure a firewall is not blocking communication between SAM and Oracle computers. 2. Verify the configuration of the Oracle User Experience Monitor. Use a third party tool, SQL*Plus, to try and connect to the Oracle Server using the same settings that SAM is using. Refer to the section, "Using the Oracle SQL*Plus Tool to Troubleshoot Connectivity Issues." Using the Oracle SQL*Plus Tool to Troubleshoot Connectivity Issues: The following steps demonstrate how to use SQL*Plus to check the following: Connectivity issues to the Oracle Server from the SAM computer. You are using the correct and valid Oracle endpoint, ( i.e. Service_Name or SID). You are using correct and valid Oracle credentials. You have credentials with enough permission to query Oracle system views. Note: This is required for troubleshooting the Oracle Database default template. The Oracle SQL*Plus tool is included in the Oracle Data Provider for.net (ODP.NET) package. This package should be installed first as described in the, Installing ODP.N, section. Once installed, navigate to the installation directory and ensure that the sqlplus.exe file exists.

36 36 Configuring and Integrating Oracle Connecting to an Oracle Server Using Simple Syntax 1. Run cmd.exe and navigate to the directory where sqlplus.exe is located. 2. Run the following command to test simple syntax: sqlplus where <UserName> is the username of the account used by the Oracle User Experience Monitor in SAM. <Password> is the valid password for this account as defined in the SAM Credential Library. <OracleServerNameOrIP> is the Oracle Server hostname or IP address. <ServiceNameOrSid> is the Oracle endpoint Service_Name or SID value as defined in the Oracle User Experience Monitor settings. For example: sqlplus This is used to connect to the XE instance on the Oracle Server running on under the System account using Password1 as the password. SqlPlus will show information on whether or not the connection was successful. If the connection was unsuccessful, the error message should contain the reason why it failed. If the connection was successfully established, then the prompt, SQL>, is shown.

37 Configuring and Integrating Oracle 37 Connecting to the Oracle Server Using Full Oracle Connection Syntax To more accurately simulate how SAM is connecting to the Oracle Server, run SQL*Plus using the full Oracle connection syntax, which is the equivalent of using the tnsnames.ora syntax: sqlplus OracleServerNameOrIP>)(PORT=<PortNumber>)))(CONNECT_DATA=(<EndPointType>=<ServiceNameOrSid>))) where <UserName> is the username of the account used by the Oracle User Experience Monitor in SAM. <Password> is the valid password for this account as defined in the SAM Credential Library. <OracleServerNameOrIP> is the Oracle Server hostname or IP address. <PortNumber> is the specified TCP port where the Oracle endpoint listens. <EndPointType> specifies the type of Oracle endpoint. This value must be either Service_Name or SID. This should match the Oracle User Experience Monitor settings in SAM. <ServiceNameOrSid> is the Oracle endpoint Service_Name or SID value as defined in the Oracle User Experience Monitor settings. For Example: sqlplus ))(CONNECT_DATA=(SERVICE_NAME=XE))) Note: This example is used without specifying the password on the command line (Sqlplus will prompt for a password.) sqlplus (SERVICE_NAME=XE))) See the following illustration:

38 38 Configuring and Integrating Oracle Using SQL*Plus to connect using this method must be tried if SAM is unable to connect to the Oracle Server. If the connection does not work from SQL*Plus, then it will not work from SAM. Executing queries using SQL*Plus 1. Connect to the Oracle Server as described in previous sections. Ensure SQL*Plus shows the SQL> prompt.

39 Configuring and Integrating Oracle Verify that it is possible to execute simple queries by typing, Select 1 from dual; Note the semicolon at the end. If this query is successful, the next step is to try the same query as used in the Oracle User Experience Monitor in SAM. 3. Type the SQL query used by the Oracle User Experience Monitor and put a semicolon at the end. Note: Semicolons are required in SQL*Plus. 4. Press Enter to run the query. This query may fail if you do not have privileges to access these SQL tables or views. If this is the case, you should connect to the Oracle Server using the Oracle administrator account (System) and execute the query under this account. If this works, then the issue is permissions related and needs to be changed or a different account should be used in SAM for monitoring.