Monday, August 24, 2015

E-Business Suite Clone Log Parser Utility (Rapid Clone 11i,12.0, 12.1

Skip to content



Download the Latest Version of the Clone Log Parser (v2.3.1)

Click Here To Download

In this Document

General Information
Benefits
Installation
Basic Usage
Command Line Options
Log Parser Output
Troubleshooting and Reporting Problems
Related Resources
ERs and Bugs

Communicate with the creator of the Clone Log Parser, post feedback, troubleshoot problems and much more in Oracle Communities:

    Click Here To Access the Log Parser Thread

General Information 

There are 2 videos for the Clone Log Parser:
 Video (1 of 2) Download / Install / Run / Locate Report (8 min) 

 Video (2 of 2) Report Features (7 min) 
The Clone Log Parser Utility is provided by the E-Business Suite Proactive Services Team. The purpose of the utility is to consolidate error information from clone log files from various locations into an HTML report. A single cloning session may generate up to a dozen separate log files, the Log Parser allows you to view relevant snippets of each log at one time. Additionally the Log Parser will do some basic configuration and health checks of the environment and also may provide leads to solving problems.
Log Parser works on 11i (11.5.9+) and R12.0.x, R12.1.x. (12.2.x is not currently supported). Log Parser will report on all cloning, oraInventory and relinking logs in the following list. (To add additional logs, please leave a comment on this document or in the Oracle Communities thread):
  • StageDBTier.log
  • StageAppsTier_.log
  • ApplyDBTier.log
  • ApplyDatabase.log
  • ApplyDBTechStack.log
  • ApplyAppsTechStack.log
  • ApplyAppsTier.log
  • CloneContext.log
  • make_.log, make.log
  • adconfig.log
  • ohclone.log
  • adcrdb_.txt
  • NetServiceHandler.log
  • setup_stubs.log
  • Central/Global oraInventory/logs directory and all sub-directories,
    for any files with a .err, .log or .txt extension

Benefits


  • Zero configuration! Just unzip, run, view report
  • Save time validating clone logs - Consolidates over 12 cloning log file types in a single HTML report!
  • Fix errors - Parses log file; exposes log snippets showing errors & warnings
  • Links solutions to key error messages in My Oracle Support content, for instant error-fix recommendations

NOTE: The Log Parser is not currently supported on Windows platforms.

Installation

The utility is installed simply by unzipping the LogParser.zip file into the appropriate directory. A separate Log Parser installation is required for the dbTier and appsTier. The reports are also separate for each tier type.  The LogParser can be downloaded, installed, run and generate a report in under 10 minutes total time.
11i / R12 - Database Tier Install (any/all RDBMS versions)

Copy and unzip LogParser.zip, into $ORACLE_HOME/appsutil/clone thereby creating $ORACLE_HOME/appsutil/clone/LogParser/.
Example:
$ cp LogParser.zip $ORACLE_HOME/appsutil/clone
$ cd $ORACLE_HOME/appsutil/clone
$ unzip LogParser.zip

11i / R12 - Application Tier Install

Copy and unzip LogParser.zip, into /clone/ thereby creating /clone/LogParser/.

Example:
$ cp LogParser.zip /clone/
$ cd /clone/
$ unzip LogParser.zip

NOTE: To search and find logs properly, the Log Parser MUST BE installed into the proper directory noted above for the corresponding tier type. 

Optionally the Log Parser may be used to parse log files which do not currently reside on an EBS file system (such as those logs provided to Oracle Support or otherwise transferred from the original system). To accomplish this the Log Parser may be unzipped into virutally any directory on a UNIX/LINUX system. When used in this manner the command line argument searchDir= must be utilized to tell the Log Parser where to look for the clone logs and to bypass the usual search patterns. Log Parser uses $PWD to determine the tier type and which EBS release it's being run on and therefore which directories to look at for logs. The option searchDir= overrides the default search behavior. 

PERL Environment: The applications Perl environment is not required. $PERL5LIB should not be set. Perl 5.8 or higher is required.

Basic Usage

By default (without using any command line arguments) the Log Parser will look for all the latest logs for each log type. If there are 2 (or more) log files of the same type, for example, ApplyDBTier_07020904.log andApplyDBTier_07031024.log, the Log Parser will determine which file was created most recently and disregard the older file. 
 
The basic usage is as follows:
$ cd LogParser
$ perl LogParser.pl 

Command Line Options

Most users will not need to use any command line arguments. In most cases it is expected that the Log Parser will be run within a few days of encountering a cloning issue and in that case, no arguments should be required to see what happened during the clone. It is recommended that for the first few runs of LogParser.pl, you simply run it with no command line arguments and review the output. If the Log Parser is not outputting information in the HTML report that you are expecting or if you are having trouble with Log Parser automatically picking up certain directories (ie, INST_TOP on R12) then using the options below may help yield better results.

searchDir=
  • Specifies a single directory to search (along with all sub-directories) for Clone related logs. (No other directories are searched) 
  • Logs to be analyzed would need to be manually placed into the directory being specified by the searchDir= argument. 
  • Will report on all logs in the given directory - does not filter down to the latest log file. (The default bahavior outside this option is to filter logs to the latest one for each type.)  
  • Not valid with any other arguments. 
  • When using searchDir= LogParser can be installed or unzipped in nearly any directory- it does not self-detect the install directory when this option is used. 
  • Example:
    $ perl LogParser.pl searchDir=/tmp/logs
history=
  • Valid parameter is a number 1-90 (days).
  • Overrides the default search behavior for Log Parser. Log Parser, by default, searches for the most recent log for each type. (There are nearly a dozen different types of logs created by a full clone.) Therefore, by default, it does not matter how old the log file is, the most recent log is always the only one shown in the HTML report. By using the history= option, Log Parser shows any files newer than the history= days. 
  • Example:
    $ perl LogParser.pl history=30
instTop=
  • Only valid on an R12 Application Tier
  • Specifies the INST_TOP, typically only needed when Log Parser cannot determine the value for INST_TOP 
  • Example:
    $ cd /clone/LogParser
    $ perl LogParser.pl instTop=/u02/oracle/R121TEST/inst/apps/R121TEST_atg0014-sun
adconfigOnly=
  • Parses only the latest Autoconfig log found (adconfig.log) 
  • Valid on 11i or R12 appsTier
    • For 11i: Requires APPL_TOP environment variable set properly (script will prompt for a value if APPL_TOP is not set) 
    • For R12: Requires INST_TOP environment variable set properly (script will prompt for a value if INST_TOP is not set) 
  • Example:
  • $ cd /clone/LogParser
    $ perl LogParser.pl adconfigonly=r12

NOTE: The following 3 options are for 11i Application Tier only and must be used together without any other command line options. 

applTop=
  • Only valid on an 11i Application Tier
  • Specifies an 11i $APPL_TOP directory, typically only required in cases where Log Parser cannot determine the $APPL_TOP directory on a previous run
  • Must be used in conjunction with oh806= & ias= (order is not important)
  • Example:
    $ perl LogParser.pl oh806=/oracle/115102/TESTora/8.0.6 ias=/oracle/115102/TESTora/iAS applTop=/oracle/115102/TESTappl
oh806=
  • Only valid on an 11i Application Tier
  • Specifies the 8.0.6 $ORACLE_HOME directory, typically only required in cases where Log Parser cannot determine the $APPL_TOP/admin directory on a previous run
  • Must be used in conjunction with applTop= & ias= (order is not important)
  • Example:
    $ perl LogParser.pl oh806=/oracle/115102/TESTora/8.0.6 ias=/oracle/115102/TESTora/iAS applTop=/oracle/115102/TESTappl
ias=
  • Only valid on an 11i Application Tier
  • Specifies the $iAS base directory, typically only required in cases where Log Parser cannot determine the $IAS directory on a previous run
  • Must be used in conjuction with 806= & applTop= (order is not important)
  • Example:
    $ cd /clone/LogParser
    $ perl LogParser.pl ias=/oracle/115102/TESTora/iAS oh806=/oracle/115102/TESTora/8.0.6 applTop=/oracle/115102/TESTappl


Log Parser Output

Splash
HTML Report File
The Log Parser creates a single HTML output file each time it is run. The HTML report file is located under the "LogParser" base directory, in the "reports" sub-directory and is named either "CloneReport.html" or Adconfig. 
View the sample report: Apps Tier DB Tier
View the sample terminal output: Terminal Output Example  (can be viewed in a browser)

Reading the HTML Report
The basic function of the Log Parser is to look for specific error strings in any log file created by cloning. When a matching error is found, that error is written in colored text (orange, red or purple) to the HTML report along with 5 lines before and after the error. When an error line is found, a hyperlink is provided on the left side for the Line #: text. Rolling over the link or clicking on it will provide some general information about the error message and in some cases, provides a My Oracle Support Doc ID.
The log files reported upon in the HTML report are listed (top to bottom) from the most recently updated file, to the earliest updated. Generally, when a clone fails - the last log updated will have the best clues or errors about why the clone failed.

Troubleshooting and Reporting Problems

Communities Clone Log Parser Thread -Communicate with the creator of the Clone Log Parser, post feedback, troubleshoot problems and much more in Oracle Communities
The Log Parser creates only a single HTML report file and does not create it's own log. Any available information about what is being done is either input into the HTML report or output to the terminal screen (STDOUT). If required, all the information output to the terminal STDOUT can be "tee'd" into a log file with the following command:
$ perl LogParser.pl 2>&1 | tee myParserLog.log 
 A few of the common failures or problems which may be encountered are:
1) Complex or non-standard directory structure.
  •  In the event that there is a directory structure being used, especially on the Apps Tier, that Log Parser cannot seem to handle, use the command line arguments to provide the required directories. If nothing seems to help, please leave a comment on this document including details about the file system. 
2) Obscure PERL version being used. Perl 5.8.0 or higher is required.
  • Most EBS systems should have 2 or 3 different PERL installations to choose from. If there is a PERL-type error message being encountered, please try a different version of PERL and unset the $PERL5LIB variable if it's set.
  • Make sure that Log Parser was installed properly into either $ORACLE_HOME/appsutil/LogParser/LogParser.pl (dbTier) or /clone/LogParser/LogParser.pl (AppsTier).
3) Unexpected results in the HTML file or no results in the HTML file.
  • If there's a specific log file which is not being shown in the HTML report, check the log for the last update date. Especially if another log file of the same type is being shown.
  • Use the history= parameter to gather all logs (multiple logs for each type, vs. default behavior of 1 log of each type). If this works, then the problem is that the Log Parser is determining the dates incorrectly or the users perception of which log should be shown is incorrect. Please leave a comment on this document for any persistent issues.
 4) $PER5LIB environment variable should not be set when using the Log Parser.
Additional Assistance: Please do not log an SR for problems with Log Parser. You may either leave a comment on this document or preferably, post in the Log Parser Community Thread.

Related Resources

Oracle Communities Log Parser Thread 

   Click Here To Access the Log Parser Thread

Knowledge Other Diagnostic Scripts Created by the Proactive Services Team
  • Document 1411723.1 Concurrent Processing - CP Analyzer for E-Business Suite
  • Document 1369938.1 Workflow Analyzer script for E-Business Suite Workflow Monitoring and Maintenance

Enhancements and Bugs

DateDescriptionStatus
14-MAR-2014Revisit/revamp PER5LIB and environment setup in LogParser.plWIP
14-MAR-2014If a Sanity check fails, we should not "die".. simply log a message that the check failed.
Example is if CONTEXT_FILE cannot be opened in check_s_db_file_utl_dir.
WIP

Get the Log Parser

Click Here To Download
Didn't find what you are looking for?

2 comments: