Remote Diagnostic Agent (RDA) 4 - Getting Started [ID 314422.1] |
Modified 29-NOV-2011 Type DIAGNOSTIC TOOLS Status PUBLISHED |
OSS Support Tools - Version: 4.25 and later [Release: and later ]
Information in this document applies to any platform.
RDA Documentation Links | |||||
---|---|---|---|---|---|
Getting Started
You are here |
FAQ
|
Man Pages
|
Troubleshooting Guide
|
Training
|
RDA Documentation Index
|
|
|
Note: Please review installation and execution instructions below. If you experience difficulties or receive errors please follow the RDA Troubleshooting Guide and RDA FAQ for instructions on reporting problems. |
Remote Diagnostic Agent (RDA) is a command-line diagnostic tool that is executed by an engine written in the Perl programming language. RDA provides a unified package of support diagnostics tools and preventive solutions. The data captured provides Oracle Support with a comprehensive picture of the customer's environment which aids in problem diagnosis.
Oracle Support encourages the use of RDA because it greatly reduces service request resolution time by minimizing the number of requests from Oracle Support for more information. RDA is designed to be as unobtrusive as possible; it does not modify systems in any way. It collects useful data for Oracle Support only and a security filter is provided if required.
This guide provides users with an overview of RDA, the download instructions, and general steps about how to execute RDA within a UNIX, Windows, and Mac OS X environment.
See the RDA 4 Release Notes for information about new features. The next release in RDA 4.x series is scheduled for release in Mid-September.
At this time, RDA has been successfully tested to run on the following Supported platforms:
You can run RDA also on other platforms that support Perl 5.005 and later. However, Oracle Support recommends testing on a non-production server first because the performance is unpredictable. For example, you will receive errors when RDA attempts to run utilities and commands that are not supported on these platforms.
RDA collects information that is useful for diagnosing issues related to the following Supported Oracle products
Additional new Oracle products will be supported in future releases. We are constantly enhancing and refining RDA, so make sure you have the latest version! For more detailed information see the Knowledge 330760.1.
RDA supports most supported versions of the Oracle products listed in Products Supported. In most cases, it runs on desupported versions as well, although the collected information may not be as extensive.
Oracle strongly encourages the use of Remote Diagnostic Agent (RDA) diagnostics collections because it provides a comprehensive picture of the customer's environment. Providing RDA diagnostic output, especially when submitting a Service Request online, can minimize the requirement for follow up questions that may delay problem resolution. RDA collections are essential for the following types of service requests:
The Oracle Configuration Manager (OCM) is a data collector that collects key Oracle and system statistics of the system that it is running on. As a key component of Oracle Configuration Manager, the OCM collector (scheduler) optimizes the customer benefits of OCM by automating the configuration collections. OCM simplifies your ability to automate your configuration and diagnostics uploads to Oracle. Oracle Configuration Manager bundle provides the following benefits:
For troubleshooting information or to learn more about Oracle Configuration Manager see the following Oracle Knowledge 250434.1.
For your benefit, Oracle created an RDA/OCM bundle . This bundle contains both RDA and OCM software and it allows customers to install OCM as part of the RDA data collection process.
Each file contains all of the required files so choose only one to download.
Note:If your platform is certified for OCM, the RDA zip file below is conveniently bundled with OCM.
RDA bundle (Released MON, D YYYY) | |||||||
---|---|---|---|---|---|---|---|
Platform | Download File | ||||||
Apple Mac OS X |
Download Zip File
|
||||||
HP OpenVMS |
Download Zip File
|
||||||
HP Tru64 |
Download Zip File
|
||||||
HP-UX Itanium |
Download Zip File
|
||||||
HP-UX PA-RISC (32-bit) |
Download Zip File
|
||||||
HP-UX PA-RISC (64-bit) |
Download Zip File
|
||||||
IBM AIX on POWER Systems (32-bit) |
Download Zip File
|
||||||
IBM AIX on POWER Systems (64-bit) |
Download Zip File
|
||||||
IBM Dynix/Ptx |
Download Zip File
|
||||||
IBM Linux on POWER |
Download Zip File
|
||||||
IBM zSeries Based Linux |
Download Zip File
|
||||||
Linux Itanium |
Download Zip File
|
||||||
Linux x86 (32-bit) |
Download Zip File
|
||||||
Linux x86 (64-bit) |
Download Zip File
|
||||||
Microsoft Windows (32-bit) |
Download Zip File
|
||||||
Microsoft Windows (64-bit) |
Download Zip File
|
||||||
Sun Solaris Intel (32-bit) |
Download Zip File
|
||||||
Sun Solaris Intel (64-bit) |
Download Zip File
|
||||||
Sun Solaris SPARC (32-bit) |
Download Zip File
|
||||||
Sun Solaris SPARC (64-bit) |
Download Zip File
|
Note: RDA 4 is written in Perl and is a command-line script. Besides Perl and a few basic Perl libraries it is not necessary to install extra software. If for some reason Perl 5.005 or above is not available or is inaccessible on your environment, then a binary version is available for download on major platforms. For additional information please read the RDA FAQ - Knowledge Article 330363.1. |
Note: In this document <rda> represents the different RDA OS command to execute RDA. Therefore substitute rda.sh, rda.pl, or perl rda.pl on UNIX and rda.cmd on Windows in place of <rda>. |
Note: The rda.zip creates a directory named "rda" containing all the required files when you extract it. Do not extract the contents of the RDA archive on a Windows client first or 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. |
unzip rda.zip
chmod +x <rda>
./<rda> -cv #检查
Note: The rda.zip file creates a directory named " rda" containing all the required files when you extract it.
|
unzip rda.zip
<rda> -cv
Due to the special nature of HP OpenVMS environment, Oracle created a separate document. See the RDA 4 - OpenVMS Users Guide: Knowledge Article 171748.1.
Note: 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, and so on. 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 lsnrctl status command will stop if the listener is not responding.) It is not unusual for RDA to take 15 minutes or more on a busy server, especially if there are many Oracle listener processes active. |
Note: If you use su to connect to root or a privileged user, do not use "su -" as the minus resets the environment. |
rda.sh - Use this command if Perl is not available.
rda.pl - Use this command if Perl is available.
Use the following command to verify that Perl is installed and available in the path:
perl -V
Inspect the command output, checking that '.' (i.e. tells perl to look for libaries in current directory) is present in @INC section. Notice the last entry "." in the example below:
@INC: /usr/lib/perl5/5.8.0/i386-linux-thread-multi /usr/lib/perl5/5.8.0 /usr/lib/perl5/site_perl/5.8.0/i386-linux-thread-multi /usr/lib/perl5/site_perl/5.8.0 /usr/lib/perl5/site_perl /usr/lib/perl5/vendor_perl/5.8.0/i386-linux-thread-multi /usr/lib/perl5/vendor_perl/5.8.0 /usr/lib/perl5/vendor_perl /usr/lib/perl5/5.8.0/i386-linux-thread-multi /usr/lib/perl5/5.8.0 . |
./<rda> -S #配置,会出现一堆提问
Including the dot ensures that RDA is executed from the local directory.
After setup completes, you can review the setup file setup.cfg by opening it a text editor such as vi.
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.
./<rda> [-v] #收集诊断信息
The -v option is optional; it allows you to view the collection progression. Additionally, if you want to re-run the RDA collection, you can use the "-fv" option, for example, ./<rda> -fv. For additional information read the RDA FAQ.
<output_directory>/<report_group>__start.htm
Note: Do not submit any health, payment card or other sensitive production data that requires protections greater than those specified in the Oracle GCS Security Practices (http://www.oracle.com/us/support/library/customer-support-security-practices-069170.pdf). Information on how to remove data from your submission is available at https://support.oracle.com/oip/faces/secure/km/DocumentDisplay.jspx?id=1227943.1 |
Note: The final output directory may not contain an archive file (.zip, .tar, .tar.gz, or .tar.Z). If the archive is missing, please archive all of the files in the <output_directory> manually and send them to Oracle Support. You can use a packaging/archive utility program such as http://www.info-zip.org/Zip.html to perform this task. |
For more information or clarification please review the demonstration viewlets located in the Training document or please read the RDA FAQ. If you still have problems please follow Troubleshooting Steps.
rda.cmd Use this command if Perl is not available.
rda.pl Use this command if Perl is available in the path. To verify if Perl is available, enter the following command:
perl -V
In the command output, verify that '.' (i.e. the current directory) is present in @INC section.
The RDA command rda.cmd or rda.pl you choose is represented as <rda> in the rest of this procedure.
<rda> -S
After setup completes, you can review the setup file setup.cfg by opening it a text editor like wordpad.
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.
<rda> [-v]
The -v option is optional. It allows you to view the collection progression. Additionally, if you want to rerun RDA collection again, you can use the "-fv" option like <rda> -fv . For additional information, read the RDA FAQ.
<output_directory>/RDA__start.htm
Note: Do not submit any health, payment card or other sensitive production data that requires protections greater than those specified in the Oracle GCS Security Practices (http://www.oracle.com/us/support/library/customer-support-security-practices-069170.pdf). Information on how to remove data from your submission is available at https://support.oracle.com/oip/faces/secure/km/DocumentDisplay.jspx?id=1227943.1 |
The final output directory may not contain an archive file (.zip, .tar, .tar.gz, or .tar.Z). If the archive is missing, please archive all the files in the <output_directory> manually and send them to Oracle Support. You can use a packaging/archive utility program such as http://www.info-zip.org/Zip.html
For more information or clarification please review the demonstration viewlets located in the Training document or read the RDA FAQ. If you still have problems please follow Troubleshooting Steps.
Due to the special nature of Oracle RAC Cluster environment a separate document was created. Please refer to RDA 4 - RAC Cluster/Multi-Node Users Guide - 359395.1
Due to the special nature of HP OpenVMS environment a separate document was created. Please refer to RDA 4 - OpenVMS Users Guide - Knowledge 171748.1
Remember that the directory structure in the archive is important; don't move any RDA files.
As of March 28, 2011, RDA is automatically upgraded in the following scenario:
OCM is installed and configured in "Connect" mode. OCM auto-update will now
upgrade RDA as part of its normal deployment procedure.
For finer control of the RDA upgrade see
README_upgrade.txt
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 cron, passwords can be encoded inside the setup file. For instance, to encode the system password, use the following command:
<rda> -A system
The password will be requested interactively.
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.
RDA output is not encrypted and can be viewed by anyone. You can view the RDA report files using almost any web browser by opening the <rda_directory>/<output_directory>/RDA<report_group>__start.htm.
We recommend using Mozilla 1.x ( or Higher), Netscape 4.x (or higher), or Internet Explorer 4.x (or higher).
The following table is a snapshot of the 'System Settings' section of the end report to demonstrate exactly what Filtering does. The result below is dependent on the system configuration.
Machine and Version | SunOS 5.6 Generic 105181-29 sun4u |
Fully qualified host name | <host><domain> |
Platform | 32 - bit Sun O/S Version 2.6 |
Logged in as | <user> |
Last run as | uid=52279 (<user>)gid=101(dba) groups=101(dba) |
Executed as Oracle home owner? | Yes |
Sensitive information removed? | Yes |
Output file prefix | RDA |
Output file directory | /emea/oracle/ <user> /home/rda2/security/output |
RDA install directory | /emea/oracle/<user>/home/rda2 |
The host names (machine names), are substituted by '<host>'. Similarly, user names are substituted by '<user>' instead of 'oracle'. The group of the software owner is 'dba', which is not substituted by the default filter.
Note that the above report was run as the owner of the Oracle home directory, which was different from 'oracle'. This is the reason why we see '<host>' instead of 'oracle'. The group of the Oracle software owner is 'dba', which is not substituted by the default filter.
The RDA filter substitutes sensitive information (such as user names) using something like <user> in the reports. As shown later in this document, you can customize what information RDA filters out and how RDA substitutes this information.
RDA provides you with a default filter, which currently filters out the information in the list below.
RDA allows you to remove sensitive data from RDA reports. The security profile can be used to turn on filtering and can be combined with other profiles. For example:
<rda> -S -p DB10g-Security
This will do the RDA setup for the DB10g profile and turn on filtering through the Security profile. If you want to enable the filtering for an existing setup:
<rda> -X Filter enable
When the filter is not yet defined, this command will also generate the default filter configuration, based on the system configuration.
If you have issues with the Remote Diagnostic Agent (RDA), you can file an Non-Technical SR in My Oracle Support. Subject line "Remote Diagnostic Agent (RDA) Issue" and complete the SR.
Note: Do not let an RDA issue prevent you from progressing on your technical issue that you are running RDA for. Please inform the engineer that owns your technical issue that you are having trouble with RDA and request that he give you instructions on collecting necessary data manually to resolve the issue. RDA is designed to speed up the resolution time of technical issues and we do not want it to interfere with resolution. However, it is important that we get the RDA issue resolved so that it can be used to help speed up resolution for future technical issues |
By downloading and using RDA you agree to the following: Warranties And Disclaimers.
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.
Related
Products
|