RDA - Oracle Remote Diagnostic Agent (RDA) PURPOSE ======= RDA is a set of command line diagnostic scripts that are executed by an engine written in the Perl programming language. RDA is used to gather detailed information about an Oracle environment; the data gathered is in turn used to aid in problem diagnosis. The output is also useful for seeing the overall system configuration. Oracle Support encourages the use of RDA because it provides a comprehensive picture of the customer's environment. This can greatly reduce service request resolution time by minimizing the number of requests from Oracle Customer Support for more information. RDA is designed to be as unobtrusive as possible; it does not modify systems in any way, it only collects useful data for Oracle Customer Support. CHECKS TO BE DONE BEFORE INSTALLATION ===================================== Before installing RDA, please ensure that the following criteria are met for ease of use: 1) UNZIP and ZIP utilities must be installed and available on the system. Therefore, they should be defined as a symbols for the user running RDA. For example: UNZIP == "$sys$login:UNZIP_ALPHA.EXE" ZIP == "$disk$tools:zip" If you don't have UNZIP installed in the system, you can download and install it for free from: http://h71000.www7.hp.com/opensource/opensource.html 2) PERL (versions 5.005 - 5.8.x) utility has be installed and should be available for the user running RDA 4.x. The required PERL symbols should be defined in the user environment. Therefore, please ensure that only the following PERL symbols are defined: "PERLSHR" = mostly ("PERL_ROOT:[000000]PERLSHR.EXE") "PERL_ROOT" = depends on your environment. If you don't have PERL installed in your system, you can download and install it for free from: http://h71000.www7.hp.com/opensource/opensource.html 3) Once you are sure that both PERL and ZIP/UNZIP are installed and working, please ensure that you run orauser.com for the respective database on which you wish to run RDA 4.x against. This will set all the database related logicals such as ORACLE_HOME. Even if you do not run orauser.com, RDA 4.x will still be able to collect the information related to operating system such as its version, products installed, and so on. 4) RDA will only be able to collect the Network related information only when standard TCP/IP Services are in use. INSTALLATION INSTRUCTIONS ========================= To install RDA, extract the zip archive contents into a new directory, preserving the directory structure of the archive. Do not extract into a directory that contains an older RDA version. Example: unzip rda.zip Important: Do not extract the contents of the RDA archive (rda.zip) on a Windows client first. If you do, you will have to remove the ^M characters from the end of each line in all of the shell scripts in order for them to run. This is very tedious job. Therefore, please unzip only in the VMS system. You can verify the RDA installation using the following command: @RDA "-cv" You can validate if your environment is ready to use RDA by running following command: @RDA -T vms RUNNING RDA =========== Before you begin: Log on as the VMS user that owns the Oracle installation. In most cases, this user will not have the necessary privileges to run all of the commands and utilities called by RDA (e.g. SYSPRV, CMKRNL etc.). If you are running RDA to assist in resolving a tar, the analyst will most likely need the information pertaining to the Oracle owner. The exception to this rule is when RDA is used to assist in a performance related issue. In this case, Oracle support recommends that you run RDA as the VMS user who owns the Oracle software. 1) Choose the RDA command that you will be using depending on your enviroment: -- rda.com Use this command to execute RDA with some environment adaptations to avoid known potential issues. -- rda.pl Use the following command to verify Perl is installed and available in the path: PERL "-V" Inspect the command output, checking that '.' (i.e. the current directory) is present in @INC section. RDA options are case sensitive and must be quoted as appropriate. NOTE: The RDA command you selected above is represented as in the rest of this procedure. Therefore substitute @RDA, or PERL rda.pl in place of . 2) The data collection requires an initial setup to determine which information it should be collected. Enter the following command to initiate the setup: @RDA -S After setup completes, review the setup file setup.cfg. You can also choose to collect only specific data. For more details, view the command usage help by specifying the "-h" option, or complete manual page with the "-M" option. 3) At this point, you can collect diagnostic information. Ensure that sqlplus is able to connect to the database with the userid that you specified during the setup. Start the data collection using the following command: @RDA "-v" The "-v" option is optional. It allows you to view the collection progress. 4) The output is a set of HTML files that are located in the RDA output directory which you specified at setup. You can review the data collected, starting with: []__start.htm 5) The output is also packaged in an archive (RDA$...zip). If the data collection was generated to assist in resolving a Service Request, send the report archive to Oracle Support by uploading the file via MetaLink. If ftp'ing the file, please be sure to ftp in BINARY format. Do not rename the file, as the file name helps Oracle Support quickly identify that RDA output is attached to the service request. It is impossible to tell how long RDA will take to execute, as it depends on many variables, such as system activity, the options chosen, network settings, etc. On an average system, RDA takes just a few minutes to run. Most scripts are designed to stop if for some reason they cannot complete within 30 seconds, (for example, the a lsnrctl status command will stop if the listener is hung). It is not unusual for RDA to take 15 minutes or more on a very busy server, especially if there are many Oracle listener processes active. PLATFORMS SUPPORTED =================== At this time, the scripts are supported on the following VMS platforms: -- HP OpenVMS Alpha 7.3-2 and above -- HP Itanium RDA can also be executed on other platforms. However, if you want to do this, Oracle Support recommends to test it on a non-production server first, as its execution performance is unpredictable. For example, you will receive errors when RDA attempts to run utilities and commands that are not supported on those platforms. PRODUCTS SUPPORTED ================== RDA collects information that is useful for troubleshooting issues in the following areas: -- Installation/configuration issues -- Performance issues -- ORA-600, ORA-7445, and ORA-3113 errors -- Upgrade, migration, and linking issues -- Developer issues -- Oracle Application Server/Fusion Middleware issues -- Other corrective issues SPECIAL NOTES ON USERIDS AND PASSWORDS ====================================== As a means of providing higher security when using RDA, passwords are no longer stored in plain text in the setup.txt file. As result, RDA prompts for the required passwords when collecting the data. If the Perl implementation installed on your operating system supports it, RDA will suppress the character echo during password requests. When the character echo is suppressed, the password is requested twice for verification. If both entered passwords do not match after three attempts, the request is cancelled. RDA can perform OS authentication, which eliminates having to enter a password for database information gathering. It also accepts "/" as a username to avoid entering a password when RDA is gathering database information. For executing RDA at regularly scheduled intervals via batch jobs, passwords can be encoded inside the setup file. For instance, to encode the system password, use the following command: "-A" system The password will be requested interactively. SPECIAL NOTES ON OUTPUT DIRECTORY ================================= To limit security vulnerabilities, the permissions of the RDA output directory should be set as restrictive as possible. The output directory could contain sensitive configuration information and, when no other mechanism is available, temporary data collection files. TROUBLESHOOTING STEPS ===================== If RDA is unable to connect to the database, and the user is declared as a SYSDBA user when running the setup, ensure that connections are possible with that user using AS SYSDBA. For example, if SYSTEM is specified as the username, make sure that you can connect using the following command in sqlplus: connect system AS SYSDBA If you cannot connect, run the setup again and answer N to that question, or edit the setup file and set SYSDBA_USER=0. You can also use the "TSTdb" test module to obtain more elements on the connection problem. If you run RDA for an issue that involves multiple tiers (for example, Application Server, Database Server, OLAP/Express Drive, OID, etc.) and the tiers are on separate servers, then you must run RDA on each server associated with the issue that you are troubleshooting. Data for these tiers will not be collected unless RDA is run on the server that the product resides on. If you are running RDA for an issue that involves products under different ORACLE_HOME directories but the same server, you must run RDA multiple times, once for each ORACLE_HOME that is involved in the issue that you are troubleshooting. It is possible to have multiple setup files (cf. option "-s"). RDA has RDA_TIMEOUT and SQL_TIMEOUT settings, which allows to limit the execution time of operating system commands and SQL scripts respectively. This is done to avoid situations in which RDA could hang because the execution of a query would never complete. However, this feature depends on the operating system capability to interrupt any tasks and should not always be operational. If RDA was not able to execute a specific script, it might be a timeout issue. You can try to increase these parameters in the setup file. There could be situations in which some queries would take longer than 30 seconds to complete execution. In these cases, do the following to increase the RDA_TIMEOUT or SQL_TIMEOUT parameter: 1) Change directory to the directory where RDA is installed (or the directory containing the setup file if an alternate setup is specified with an "-s" option). 2) Use an editor to edit the setup file (setup.cfg by default). 3) Change the value of RDA_TIMEOUT or SQL_TIMEOUT to a value greater than 30. 4) Re-run RDA (possibly limited to impacted modules). 5) It may be necessary to increase this value several times in order for the query to complete in the allotted time. The setting can also be changed at execution time by using an "-e" option. As setting names and values are case sensitive, please quote such arguments. When you run orauser.com against 10g databases, it automatically sets Perl logicals (e.g. PERL_ENV_TABLES). Once you execute orauser.com in such an environment, you have two PERL_ROOT, and so on: one for process level and other system wide. Perl could have difficulties to collect environment information if PERL_ENV_TABLES is present but typically does not contain CRTL_ENV on top of value list. A possible workaround is to deassign PERL_ENV_TABLES. Perl 5.6 could have a problem of executing operating system commands when outputs are flushed automatically. When the occurs, it can be disabled by editing the setup file and by setting RDA_FLUSH=0 When executing rda.pl directly, always define the following logical for best results: DECC$FILE_SHARING = ENABLE Options requiring forking (e.g. background collections) are not available on VMS. HOW TO REPORT PROBLEMS ====================== If problems running RDA cannot be fixed with the troubleshooting steps described above, you can file a Service Request in Metalink by selecting "OSS Support Tools" from the product list of values on the "Create a SR" screen. Click on "Expand the Product List" button to see the full set of products. Select the "Remote Diagnostic Agent (RDA) Issue" type and complete the Service Request. Please include: -- The description of the error, including the error number and messages. -- The output of: @RDA "-c" @RDA -V show cpu show proc/all sh log * sh sym */tables=all When possible, re-run the RDA program with debug and trace mode enabled and upload the output in the Service Request. For instance: @RDA "-vdt" (for whole data collection) @RDA "-vd" T/ (for a single module) For database connection problems, include the output of @RDA -T T/TSTdb COPYRIGHT NOTICE ================ Copyright 2002-2008, Oracle. All rights reserved. TRADEMARK NOTICE ================ Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. LEGAL NOTICES AND TERMS OF USE ============================== http://metalink.oracle.com/metalink/plsql/ml2_documents.showDocument?p_database_id=NOT&p_id=225559.1 DOCUMENTATION ACCESSIBILITY =========================== Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle is actively engaged with other market- leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/ Accessibility of Code Examples in Documentation JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace. Accessibility of Links to External Web Sites in Documentation. This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.