Performance Monitoring with modPLSQL in Oracle9iAS Portal
Portal Performance Monitoring in Oracle Application Server
Portal
An OracleAS Portal Technical
Note
Version: Sept 3rd, 2003, for Oracle Portal middle tier versions 3.0.9.8.3 and
higher, and 9.0.2.3.0 and higher.
Overview
The ability to judge the performance of a web site is an important feature
of any Internet server. With the 3.0.9.8.3 patch release, Oracle introduced a
performance logging service for Portal. One line of output is emitted per web
request, in a summary format.
The statistics collected indicate how long the overall request took, how
much of that time was spent in the user's procedure, what user made the
request, whether a database connection was obtained from the connection pool,
what type of caching was used, etc.
An Oracle9i (or greater) database in which to store the
performance data and run the reports (9i is the minimum version
required because the reports use PERCENTILE_CONT, which was
not available in prior releases). A separate database is strongly
recommended, as running these reports can significantly degrade the
performance of your Portal installation. Database version 9.2.0.3
is recommended if you wish to use direct-path loading of the performance
data (again, strongly recommended), and allow maximum possible fast
refresh of the materialized views. There are known issues with direct-path
loading with DB versions prior to 9.2.0.3; if you experience SQL*Loader
issues with the scripts, then either turn off the direct-path load option,
or upgrade the database.
A UNIX, Linux, or Win32 system with a SQL*Loader of the same version
as the database used to store the performance data, and Perl,
on which to run the loader script. This may or may not be the same system
used for the database. If you are getting errors when you load the data,
check the version of SQL*Loader in $ORACLE_HOME.
rcp, scp, or ftp automatic
login access to the physical hosts on which the log files are located. See
your OS documentation for more information.
The settings different somewhat from version to version, so make sure you
are looking at the correct section.
After the following settings are changed, you must restart Oracle
Application Server 10g in order for performance logging to start.
3.0.9.8.X
mod_plsql
In $ORACLE_HOME/Apache/Apache/conf/httpd.conf, set
LogLevel to info:
LogLevel info
In $ORACLE_HOME/Apache/modplsql/cfg/wdbsvr.app, set
debugModules to info:
debugModules=info
Note: info is the recommended setting for performance
logging. The infoDebug setting will log all the same
information as the info setting, with the addition of extra
debugging information which is not necessary for performance reporting
(the text of the browser cookie, its length, and the mod_plsql trace
cookie). This information is quite lengthy, so this setting should not be
used unless this data is necessary for debugging a specific problem.
Jserv can be configured in one of two ways. Either all properties are
contained in a single jserv.properties file and a single zone.properties
file, or these files can be broken up into per-zone files. The locations of
these files are defined in $ORACLE_HOME/Apache/Jserv/etc/jserv.conf
(note that the location of this file can also change, and is defined in your
top-level httpd.conf file).
In each Jserv properties file, the following settings are required:
Warning: The log.dateFormat setting must be exactly as
specified, or the loader will not be able to parse the log files.
In the appropriate zone properties file for the PPE servlet, usually
located under $ORACLE_HOME/Apache/Jserv/etc, set
servlet.page.initArgs to logmode=perf:
servlet.page.initArgs=logmode=perf
In the appropriate zone properties file for each JPDK servlet, usually
located under $ORACLE_HOME/Apache/Jserv/etc, add
debuglevel=0 to the initArgs property for the servlet:
Note: if you are running Portal 9.0.2.3.0, and you have installed a
separate infrastructure mid-tier, then mod_plsql performance logging should
be enabled on the infrastructure mid-tier as well as the Portal mid-tier.
In $ORACLE_HOME/Apache/Apache/conf/httpd.conf, set
LogLevel to info:
LogLevel info
Note that Oracle Diagnostic Logging (ODL) logging format is not
currently supported. If you have a line like
OraLogMode oracle
in your httpd.conf file, it must be changed back to
OraLogMode apache
for these scripts to work.
OC4J
In the web.xml file for Portal, usually located under
$ORACLE_HOME/j2ee/OC4J_Portal/applications/portal/portal/WEB-INF,
uncomment the lines containing the initialization parameter logmode.
Set logmode for the page servlet to perf:
For each JPDK provider which uses JNDI configuration parameters:
In the web.xml file for each JPDK provider, usually
located under $ORACLE_HOME/j2ee/OC4J_Portal/applications/<dir1>/<dir2>/WEB-INF
(where the <dir1> and <dir2> directory names
are specific to your provider), a definition should appear for the
parameter oracle/portal/log/logLevel. If the definition
exists, proceed to the next bullet. If the provider web.xml
file does not include this parameter, you will have to add it (note that
if the provider is redeployed for some reason, this file will be
overwritten, and you will have to add the parameter again. The provider
author should be notified that they should include this parameter
definition in future releases). Example:
4 is a good value to use, as this will be overridden
anyway by the orion-web.xml setting in the next step.
In the orion-web.xml file for each JPDK provider,
usually located under $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/<dir1>/<dir2>
(where the <dir1> and <dir2> directory names
are specific to your provider), set the parameter
oracle/portal/log/logLevel to 5. Example:
For each JPDK provider which uses context initialization parameters:
In the web.xml file for each JPDK provider, usually
located under $ORACLE_HOME/j2ee/OC4J_Portal/applications/<dir1>/<dir2>/WEB-INF
(where the <dir1> and <dir2> directory names
are specific to your provider), a definition should appear for the
parameter oracle.portal.log.LogLevel. If the definition
exists, proceed to the next bullet. If the provider web.xml
file does not include this parameter, you will have to add it (note that
if the provider is redeployed for some reason, this file will be
overwritten, and you will have to add the parameter again. The provider
author should be notified that they should include this parameter
definition in future releases). Example:
4 is a good value to use, as this will be overridden
anyway by the orion-web.xml setting in the next step.
In the orion-web.xml file for each JPDK provider,
usually located under $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/<dir1>/<dir2>
(where the <dir1> and <dir2> directory names
are specific to your provider), set the parameter
oracle.portal.log.LogLevel to 5. Example:
In the web.xml file for Portal, usually located under
$ORACLE_HOME/j2ee/OC4J_Portal/applications/portal/portal/WEB-INF,
uncomment the lines containing the initialization parameter logmode.
Set logmode for the page servlet to perf:
For each JPDK provider which uses JNDI configuration parameters:
In the web.xml file for each JPDK provider, usually
located under $ORACLE_HOME/j2ee/OC4J_Portal/applications/<dir1>/<dir2>/WEB-INF
(where the <dir1> and <dir2> directory names
are specific to your provider), a definition should appear for the
parameter oracle/portal/provider/global/log/logLevel. If
the provider web.xml file does not include this parameter,
you will have to add it (note that if the provider is redeployed for
some reason, this file will be overwritten, and you will have to add the
parameter again. The provider author should be notified that they should
include this parameter definition in future releases). Example:
4 is a good value to use, as this will be overridden
anyway by the orion-web.xml setting in the next step.
In the orion-web.xml file for each JPDK provider,
usually located under $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/<dir1>/<dir2>
(where the <dir1> and <dir2> directory names
are specific to your provider), set the parameter
oracle/portal/provider/global/log/logLevel to 5.
Example:
For each JPDK provider which uses context initialization parameters:
In the web.xml file for each JPDK provider, usually
located under $ORACLE_HOME/j2ee/OC4J_Portal/applications/<dir1>/<dir2>/WEB-INF
(where the <dir1> and <dir2> directory names
are specific to your provider), a definition should appear for the
parameter oracle.portal.log.LogLevel. If the provider
web.xml file does not include this parameter, you will have to
add it (note that if the provider is redeployed for some reason, this
file will be overwritten, and you will have to add the parameter again.
The provider author should be notified that they should include this
parameter definition in future releases). Example:
4 is a good value to use, as this will be overridden
anyway by the orion-web.xml setting in the next step.
In the orion-web.xml file for each JPDK provider,
usually located under $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/<dir1>/<dir2>
(where the <dir1> and <dir2> directory names
are specific to your provider), set the parameter
oracle.portal.log.LogLevel to 5. Example:
In the navigator pane, select "Logging and Diagnostics" > "Access
Logs".
The Access Log page appears in the right pane.
In the Access Log page, under "Site-Specific Access Log
Configuration", verify that the access_log is using the WCALF format
style.
If not, select it and hit the "Edit Selected" button.
Select "Yes" for "Enabled".
Select the WCALF format style.
Choose "Submit".
In the Web Cache Manager main window, choose "Apply Changes".
Restart Web Cache.
Setting up the reporting database
The collected performance data must be loaded into an Oracle database for
report generation. To prepare for this, execute the following steps:
Create a database schema of your choice. Example, using SQL*Plus:
CONNECT SYS/<passwd> AS SYSDBA;
CREATE USER owa_perf IDENTIFIED BY owa_perf;
GRANT RESOURCE, CREATE SESSION, CREATE MATERIALIZED VIEW, CREATE SYNONYM TO owa_perf;
During the installation process, you will be asked for three
tablespace destinations for:
the log tables
the log indices
the log materialized views
It is recommended, though not mandatory, that you create and specify
individual tablespaces for the storage of these elements. You cannot use
DEFAULT as a valid tablespace for these responses.
Load the script install/install.sql (for a
non-partitioned table) or install/install_part.sql (for a
partitioned table) into it. This will create the table OWA_LOGGER
in your schema. You must specify an argument of either parallel
or noparallel, to indicate whether or not parallel access
should be allowed to the tables, indexes, etc.
If you are using an Oracle Enterprise Edition database, and you have a
large amount of data (more than a million rows), you may wish to partition
the OWA_LOGGER table and its associated views and indexes. The
following scripts are supplied to assist with this:
install/install_part.sql parallel
Use this script to install the performance logging tables if you have
not previously installed them.
install/convert_part.sql parallel
Use this script to convert your non-partitioned performance logging
tables to partitioned ones.
You must have run the install/update.sql script before
running install/install_part.sql.
You must specify an argument of either parallel or
noparallel, to indicate whether or not parallel access should be
allowed to the tables, indexes, etc. Parallel access is recommended unless
your system is I/O-bound.
Note that you must execute loader/loadlogs.pl with the
-pre_load option prior to loading all logs in a session, and with the
-post_load option afterwards. This takes care of adding new
partitions as necessary, and swapping partitions in and out of the main
OWA_LOGGER table to increase its availability. You can refer to
the sample csh script loader/sample_load_script.csh to see an
example of how this would be done.
From time to time, changes may be made to this software which require
changes to the schema. If you have downloaded a new version, you may need to
load install/update.sql to accomplish this. Example:
You may see errors indicating that the changes have already been made,
and these may be disregarded. Please also check the section on schema
privileges BEFORE executing install/update.sql, as new
privileges may need to be granted first.
Once you have turned on performance logging and collected some data, it
needs to be loaded into the database so that reports can be generated from
it.
Locating the data
The data will be written into the Oracle HTTP Server error log (for
mod_plsql), either the Jserv log or the OC4J application log (for PPE and
JPDK), and the Web Cache access log for Web Cache. These are normally
located in $ORACLE_HOME/Apache/Apache/error_log, $ORACLE_HOME/Apache/Jserv/jserv.log,
$ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/portal/OC4J_Portal_default_island_1/application.log,
and $ORACLE_HOME/webcache/logs/access_log, respectively, on the
physical hosts where the Oracle HTTP Server is installed. However, your
system may have been configured differently.
Loading data directly from these files is not recommended. If you should
wish to load more data later, all the data that you loaded the first time
will still be in the log files, and will be duplicated in the database,
unless you delete all your old data first. It is better to set up a
rotation system, and load the archived log files
instead.
Loading data into the database
A Perl script (loader/loadlogs.pl) is provided that will use
either rcp, scp, or ftp (see your OS
documentation for more information) to collect the log files from the
physical hosts, and load them (using SQL*Loader) into the
database schema specified by the connection. Running the script with no
arguments will print out usage information:
Usage: perl loadlogs.pl
-logical_host host The logical host name, e.g. www.oracle.com.
Required.
-physical_hosts hosts The physical host names of the machines
where the logs are located. To specify a
list of hosts, double-quote and separate by
spaces, e.g. "host1 host2". Optional.
Default is local host.
-remote_user userid The userid on the physical hosts. Optional.
Defaults to the current userid on the local
host.
-http_logfile filename Filename of the Oracle HTTP Server error log
file to be loaded. Optional.
-jserv_logfile filename Filename of the Jserv log file to be loaded.
Optional.
-oc4j_logfile filename Filename of the OC4J log file to be loaded.
Optional.
-webcache_logfile filename Filename of the Web Cache log file to be
loaded. Optional.
-connection cxn Connection information for the database where
the data is to be loaded.
-[no]copy_logs Copy new log files from physical hosts.
Specifying -nocopy_logs can be useful with
-delete_old_logs or -purge_old_logs.
Optional. Defaults to -copy_logs.
-[no]load_logs Load new log information from files into
database. Specifying -noload_logs can be
useful with -delete_old_logs or
-purge_old_logs. Optional. Defaults to
-load_logs.
-temp_dir directory Directory in which to store log files while
loading. Optional. Defaults to value
returned by File::Spec->tmpdir().
-[no]delete_old_logs Delete log information for specified hosts
before loading new data. If logical_host is
not specified, then delete logs for all
hosts. Optional.
-purge_old_logs N Purge log information for specified hosts
older than N days. If logical_host is not
specified, then purge logs for all hosts.
Optional.
-transport_type <rcp/scp/ftp> The method for retrieving the log files.
Defaults to rcp on UNIX/Linux, ftp on Win32.
Optional.
-[no]direct Use direct-path loading of the log files.
Defaults to -direct.
-[no]parallel Enable parallel loading of the log files.
Defaults to -noparallel.
-version V1.V2.V3 The version of the mid-tier to be loaded
from, for example, 3.0.9. Defaults to 9.0.4.
-[no]pre_load Execute pre-load tasks for a staged load.
Optional.
-[no]post_load Execute post-load tasks for a staged load.
Optional.
-[no]pre_load Execute pre-load tasks for a staged load.
Optional.
-[no]post_load Execute post-load tasks for a staged load.
Optional.
-[no]maintain_indexes Enable/disable index maintenance by
SQL*Loader. Optional. On by default.
Recommended to turn this off if loading
multiple files.
Example 1: Mid-Tier running on Single Host
You have a Portal middle tier (say, www.yourcompany.com) installed on a
single physical host (host1.yourcompany.com). Your performance database is
installed on dbhost.yourcompany.com, and this is where you are running
loadlogs.pl.
If the logging data files are located on another system, then
loader/loadlogs.pl will copy them to the directory specified by
-temp_dir on the local machine. You should make sure there is enough
disk space available to hold them before running loader/loadlogs.pl.
Win32 FTP tips:
When using the -transport_type ftp option to copy files
between Win32 and either Unix or Linux, use Unix syntax to specify the
filename. When copying files between two Win32 systems, Windows syntax can
be used.
Compatibility notes:
If you are upgrading from a previous version of these scripts, note that
loader/loadlogs.csh has been replaced by loader/loadlogs.pl.
loader/loadlogs.csh will no longer be supported. The following
changes have been made to the options:
The -root_logpath option is no longer supported. Absolute
file paths should be specified to -http_logfile,
-oc4j_logfile, -jserv_logfile, and -webcache_logfile.
The -direct, -delete_old_logs, -copy_logs,
and -load_logs options no longer accept the values true
and false. Instead, for example, supply -copy_logs
instead of -copy_logs true, and -nocopy_logs
instead of -copy_logs false.
Troubleshooting
loader/loadlogs.pl will create log files in the directory
specified by the -temp_dir option.
Check the version of SQL*Loader on the machine where you are running
loadlogs.pl. It should exactly match the database version, and be at least
9.2.0.3.
Rejected records
Records in the logfiles which do not match the correct format will be
rejected and copied to the .dis file. See the Appendix for the
required format.
There should be no records in the discard (extension .dis)
or bad (extension .bad) files which contain the string "[perf]".
If there are, check the .log files for error messages.
Known issues
loader/loadlogs.pl: There are known problems with
direct-path loading of large files with SQL*Loader, and with direct-path
loading files of any size on DB versions prior to 9.2.0.3. If you are
having problems, either upgrade your database, or use the -nodirect
option to loadlogs.pl. The -nodirect option will severely
degrade the performance of the loader scripts.
PPE: request time will occasionally be logged as a large-magnitude
negative number. These records will be rejected by the loader, and copied
into a file with the extension .bad in the temporary
directory specified to loader/loadlogs.pl.
PPE: HTTP user will sometimes erroneously be logged as (null).
Automation
If you wish to automate this step, you can install the previous command
as a cron job. See the UNIX man page for cron for
more information.
SQL scripts (reports.sql, reports_weekly.sql)
are supplied which will run all of the currently available reports. Those in
reports.sql would typically be required on a daily basis, whereas those in
reports_weekly.sql should not change much, and can be run less often.
Example:
The log files will quickly grow quite large because of the performance
logging data. You may wish to set up a rotation system, so that periodically
the logs are archived, preferably to another filesystem. Note that on UNIX,
the logs are kept open by the running process, so simple doing a 'mv' will
not be effective. Examples:
csh
set date = `date +%Y.%m.%d_%H:%M`
setenv LOG_ARCHIVE /otherdisk/logging/archive
cd $ORACLE_HOME/Apache/Apache/logs
cp error_log $LOG_ARCHIVE/apache/error_log.$date && cat /dev/null > error_log
cd $ORACLE_HOME/Apache/Jserv/logs
cp jserv.log $LOG_ARCHIVE/jserv/jserv.log.$date && cat /dev/null > jserv.log
cd $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/portal/OC4J_Portal_default_island_1
cp application.log $LOG_ARCHIVE/oc4j/application.log.$date && cat /dev/null > application.log
cd $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/jpdk/OC4J_Portal_default_island_1
cp application.log $LOG_ARCHIVE/jpdk/application.log.$date && cat /dev/null > application.log
cd $ORACLE_HOME/webcache/logs
cp access_log $LOG_ARCHIVE/webcache/access_log.$date && cat /dev/null > access_log
It is suggested that you load the archived log files rather than the
current ones, to eliminate the need to delete old data first. If you collect
and load the current log files, then be sure to specify -delete_old_logs,
otherwise, reloading these files will cause duplicate data to be loaded.
Automation
You can install the previous script as a cron job. See the
UNIX man page for cron for more information.
Purging/deleting old data
The amount of data in the OWA_LOGGER table can grow quite
large. You should purge or delete old data periodically. If you have only a
few physical hosts, this can be combined with loading new data:
date and time of the request. Must be exactly in the following
Oracle date format: "Mon DD HH24:MI:SS YYYY".
NEXT
" mod_plsql: "
CHARACTER
unused
unused
NEXT
WHITESPACE
CHARACTER
unused
if equal to "[perf]", indicates that this line contains performance
statistics.
NEXT
WHITESPACE
CHARACTER
ip_address
IP address of the client requesting the operation. In most cases
this is the IP address of the client browser, or HTTP proxy, being used.
The Portal page assembly process will use loopback calls, where the IP
address represents the Midtier itself, in order to assemble a page.
NEXT
<=4000
" status="
CHARACTER
url
URL of the operation being requested.
NEXT
WHITESPACE
CHARACTER
http_status
HTTP status code. Typically, status codes less than 400 denote a
successful response.
NEXT
"user=" and " reqTime="
CHARACTER
http_user
user who requested the action.
NEXT
"ms "
INTEGER
request_time
overall time spent processing the request, as recorded inside
mod_plsql. Note that this does not include the costs of the Oracle HTTP
Server, and of reaching it via HTTP.
NEXT
"connSU=" and ","
CHARACTER
su_conn_pool_status
status of getting a connection from the database connection pool.
The connection status is either "NEW" or "HIT". If the connection is new
then the time represents how long was spent connecting to the database.
For Portal, this represents the connection to the Portal main schema
(e.g., PORTAL30).
NEXT
"ms "
INTEGER
su_conn_pool_time
time needed for above.
NEXT
"connRO=" and ","
CHARACTER
pub_conn_pool_status
see the description of su_conn_pool_status. For Portal,
this represents the connection to the Portal public schema (e.g.,
PORTAL30_PUBLIC).
NEXT
"ms "
INTEGER
pub_conn_pool_time
time needed for above.
NEXT
"connNSSO=" and ","
CHARACTER
conn_pool_status
see su_conn_pool_status. This type of database
connection is used only for non-SSO based DADs and is not used by
Portal.
NEXT
"ms "
INTEGER
conn_pool_time
time needed for above.
NEXT
"procTime=" and "ms "
INTEGER
proc_time
time spent in executing the target PL/SQL procedure as recorded from
mod_plsql.
NEXT
"sessionTidyTime=" and "ms "
INTEGER
tidy_time
time that mod_plsql spent cleaning up the session, after the
requested operation was performed, in order to reset/reinitialize the
state of the database connection for the next consumer.
NEXT
"cache=" and " "
CHARACTER
content_cache_status
status/type of content caching that this operation requested. A
value of "(null)" indicates no caching. Other values are "HIT,PING", "HIT,EXPIRES",
"MISS,STALE", "MISS,NEW".
NEXT
"cookie=" and ","
CHARACTER
cookie_cache_status
status of session caching. mod_plsql uses the session cache to avoid
hitting the database to decode the cookie value. If the cache is
configured correctly, most values here will be "HIT,0ms". This option
only applies to SSO-style DADs.
NEXT
"ms "
INTEGER
cookie_cache_time
time needed for above.
NEXT
"pageCalls=" and ","
INTEGER
page_call_count
number of times that mod_plsql was required to call the database to
retrieve the content that the operation produced, and time spent doing
so. The first chunk of output is bundled along with the initial
response, so this value is typically 0 for small-sized content. As the
content grows in size, this value will increase as the number of round
trips needed to get the content from the database increases.
NEXT
"ms "
INTEGER
page_call_time
time needed for above.
NEXT
"bytes=" and " "
INTEGER
bytes
number of bytes of output that the operation produced.
NEXT
"describe=" and ","
CHARACTER
describe_status
certain operations require that mod_plsql use a database describe
call before they can be run. This property indicates if a describe was
performed, and how long was spent performing it.
NEXT
"ms "
INTEGER
describe_time
time needed for above.
NEXT
"streamTime=" and "ms"
INTEGER
stream_time
not currently used. This is a placeholder for future usage.
NEXT
"pid=" and " sessFile="
CHARACTER
pid
process id.
NEXT
" userFile="
CHARACTER
session_file
session cache file name.
NEXT
" sysFile="
CHARACTER
user_file
user cache file name.
NEXT
" cacheLevel="
CHARACTER
sys_file
system cache file name.
NEXT
WHITESPACE
CHARACTER
cache_level
possible values are "user", "system", "unknown", or NULL.
NEXT
"cacheTime=" and "ms"
INTEGER
content_cache_time
time spent in the mod_plsql File System Caching subsystem.
NEXT
"dbProcTime=" and "ms"
INTEGER
db_proc_time
time spent in executing the complete anonymous PL/SQL block, as seen
from the database. Note that procTime will be higher than
this time, and will include the network time and any database time spent
due to latch contentions.
NEXT
"id=" and "spid="
CHARACTER
unused
request id, followed by an optional comma and a sequence number.
This is parsed into the request_id and seq
columns (see below).
EXPRESSION
request_id
string used for correlating requests between the PPE, JPDK,
mod_plsql, and Web Cache components. It is parsed from the previous
field, minus any sequence number.
EXPRESSION
seq
sequence number, as parsed from the field before the previous one.
The sequence number is incremented each time the request is passed to
another component.
NEXT
WHITESPACE
CHARACTER
s_pid
shadow process id for the current session. This can be used to
correlate to the trace file created on the server side (set only if
mod_plsql log level is "infoDebug").
NEXT
"qs=" and " requestTrace="
CHARACTER
qs
reserved for future use.
NEXT
" cookieLen="
CHARACTER
request_trace
unique identifier logged for all requests coming from the same
browser. This information can be used to trace all mod_plsql operations
done by a single user (set only if mod_plsql log level is "infoDebug").
NEXT
" cookieValue="
INTEGER
cookie_length
total size of the cookie submitted by the user (set only if
mod_plsql log level is "infoDebug").
NEXT
WHITESPACE
CHARACTER
cookie
"Portal Cookie" used for processing the request (set only if
mod_plsql log level is "infoDebug").
Jserv Log
This file is normally located in $ORACLE_HOME/Apache/Jserv/logs/jserv.log,
and contains, among other things, the logging output of the PPE and JPDK.
date and time of the request. Must be exactly in the following
Oracle date format: "DD/MM/YYYY HH24:MI:SS".
NEXT
" page/"
CHARACTER
unused
unused
NEXT
WHITESPACE
CHARACTER
unused
if equal to "[perf]", indicates that this line contains performance
statistics.
NEXT
WHITESPACE
CHARACTER
ip_address
IP address of the client requesting the operation. In most cases
this is the IP address of the client browser, or HTTP proxy, being used.
The Portal page assembly process will use loopback calls, where the IP
address represents the Midtier itself, in order to assemble a page.
NEXT
<=4000
" id="
CHARACTER
url
URL of the operation being requested.
NEXT
" type="
CHARACTER
unused
request id, followed by an optional comma and a sequence number.
This is parsed into the request_id and seq
columns (see below).
EXPRESSION
request_id
string used for correlating requests between the PPE, JPDK,
mod_plsql, and Web Cache components. It is parsed from the previous
field, minus any sequence number.
EXPRESSION
seq
sequence number, as parsed from the field before the previous one.
The sequence number is incremented each time the request is passed to
another component.
HTTP status code. Typically, status codes less than 400 denote a
successful response.
NEXT
"user=" and " subscriberID="
CHARACTER
http_user
user who requested the action.
NEXT
" reqTime="
CHARACTER
unused
subscriber ID.
NEXT
"ms waitTime="
INTEGER
request_time
overall time spent processing the request, as recorded inside the
PPE. Note that this does not include the costs of the Oracle HTTP
Server, and of reaching it via HTTP.
NEXT
"ms "
INTEGER
wait_time
time spent waiting in the request queue.
NEXT
"cache=" and " timeout="
CHARACTER
content_cache_status
status/type of content caching that this operation requested. A
value of "(null)" indicates no caching. Other values are "HIT,PING", "HIT,EXPIRES",
"MISS,STALE", "MISS,NEW".
NEXT
WHITESPACE
CHARACTER
timeout
whether the request timed out.
NEXT+10
" bytes="
INTEGER
redirects
number of redirects made.
NEXT
WHITESPACE
INTEGER
bytes
number of bytes of output that the operation produced. This field
may not be present in older versions of the PPE.
date and time of the request. Must be exactly in the following
Oracle date format: "DD/MM/YYYY HH24:MI:SS".
NEXT
"<" and ">"
CHARACTER
unused
optional log channel name, controlled by log.channel
property in Jserv properties file; unused
NEXT
<=1000
"/"
CHARACTER
provider
provider name.
NEXT
WHITESPACE
CHARACTER
unused
if equal to "[perf-provider]", indicates that this line contains
performance statistics.
NEXT
"id=" and " providerId="
CHARACTER
unused
request id, followed by an optional comma and a sequence number.
This is parsed into the request_id and seq
columns (see below).
EXPRESSION
request_id
string used for correlating requests between the PPE, JPDK,
mod_plsql, and Web Cache components. It is parsed from the previous
field, minus any sequence number.
EXPRESSION
seq
sequence number, as parsed from the field before the previous one.
The sequence number is incremented each time the request is passed to
another component.
NEXT
" portletId="
CHARACTER
provider_id
provider id.
NEXT
" portletName="
CHARACTER
portlet_id
portlet id.
NEXT
<=1000
" portletInstance="
CHARACTER
name
portlet name.
NEXT
" user="
CHARACTER
portlet_instance
portlet instance name.
NEXT
<=1000
" operation="
CHARACTER
http_user
user who requested the action.
NEXT
<=1000
" requestTime="
CHARACTER
operation
operation requested.
NEXT
WHITESPACE
INTEGER
request_time
overall time spent processing the request, as recorded inside the
JPDK.
NEXT
"processingTime="
CHARACTER
unused
unused
NEXT
WHITESPACE
INTEGER
proc_time
time spent in provider code servicing the request.
NEXT
"frameworkTime="
CHARACTER
unused
unused
NEXT
WHITESPACE
INTEGER
framework_time
time spent in provider framework, calculated by requestTime
- processTime.
NEXT
"headerRenderTime="
CHARACTER
unused
unused
NEXT
WHITESPACE
INTEGER
header_render_time
time to render portlet header.
NEXT
"footerRenderTime="
CHARACTER
unused
unused
NEXT
WHITESPACE
INTEGER
footer_render_time
time to render portlet footer.
NEXT
"readCustTime="
CHARACTER
unused
unused
NEXT
WHITESPACE
INTEGER
read_cust_time
time to read customization objects.
NEXT
"writeCustTime="
CHARACTER
unused
unused
NEXT
WHITESPACE
INTEGER
write_cust_time
time to write to customization objects.
NEXT
"cache="
CHARACTER
unused
unused
NEXT
" cacheLevel="
CHARACTER
content_cache_status
status/type of content caching that this operation requested. A
value of "(null)" indicates no caching. Other values are "HIT,PING", "HIT,EXPIRES",
"MISS,STALE", "MISS,NEW".
NEXT
" expiryTime="
CHARACTER
cache_level
possible values are "user", "system", "unknown", or NULL.
NEXT
WHITESPACE
INTEGER
expiry_time
length of time that content is cached for, in minutes.
NEXT
"cacheRequestKey="
CHARACTER
unused
unused
NEXT
"cacheResponseKey="
CHARACTER
cache_request_key
the cache version header value in request.
NEXT
WHITESPACE
CHARACTER
cache_response_key
the cache version header value set by the portlet.
OC4J Log
PPE
This file is normally located in $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/portal/OC4J_Portal_default_island_1,
and contains, among other things, the logging output of the PPE.
date and time of the request. Must be exactly in the following
Oracle date format: "MM/DD/YY HH:MI PM".
NEXT
WHITESPACE
CHARACTER
unused
if equal to "[perf]", indicates that this line contains performance
statistics.
NEXT
WHITESPACE
CHARACTER
ip_address
IP address of the client requesting the operation. In most cases
this is the IP address of the client browser, or HTTP proxy, being used.
The Portal page assembly process will use loopback calls, where the IP
address represents the Midtier itself, in order to assemble a page.
NEXT
<=4000
" id="
CHARACTER
url
URL of the operation being requested.
NEXT
" type="
CHARACTER
unused
request id, followed by an optional comma and a sequence number.
This is parsed into the request_id and seq
columns (see below).
EXPRESSION
request_id
string used for correlating requests between the PPE, JPDK,
mod_plsql, and Web Cache components. It is parsed from the previous
field, minus any sequence number.
EXPRESSION
seq
sequence number, as parsed from the field before the previous one.
The sequence number is incremented each time the request is passed to
another component.
HTTP status code. Typically, status codes less than 400 denote a
successful response.
NEXT
"user=" and " subscriberID="
CHARACTER
http_user
user who requested the action.
NEXT
" reqTime="
CHARACTER
unused
subscriber ID.
NEXT
"ms waitTime="
INTEGER
request_time
overall time spent processing the request, as recorded inside the
PPE. Note that this does not include the costs of the Oracle HTTP
Server, and of reaching it via HTTP.
NEXT
"ms "
INTEGER
wait_time
time spent waiting in the request queue.
NEXT
"cache=" and " timeout="
CHARACTER
content_cache_status
status/type of content caching that this operation requested. A
value of "(null)" indicates no caching. Other values are "HIT,PING", "HIT,EXPIRES",
"MISS,STALE", "MISS,NEW".
NEXT
WHITESPACE
CHARACTER
timeout
whether the request timed out.
NEXT+10
" bytes="
INTEGER
redirects
number of redirects made.
NEXT
" authLevel="
INTEGER
bytes
number of bytes of output that the operation produced. This field
may not be present in older versions of the PPE.
NEXT
" webCacheStatus="
INTEGER
auth_level
authorization level of the request. This field may not be present in
older versions of the PPE.
NEXT
" webCacheExpires="
CHARACTER
wc_status
Web Cache status. This field may not be present in older versions of
the PPE.
NEXT
" webCacheAge="
INTEGER
wc_expires
number of seconds after which the cache will expire. This field may
not be present in older versions of the PPE.
NEXT
WHITESPACE
INTEGER
wc_age
age in seconds of the cache. This field may not be present in older
versions of the PPE.
NEXT
WHITESPACE
CHARACTER
cs_conv
whether a character set conversion was performed. This field may not
be present in older versions of the PPE.
JPDK
This file is normally located in $ORACLE_HOME/j2ee/OC4J_Portal/application-deployments/jpdk/OC4J_Portal_default_island_1,
and contains, among other things, the logging output of the JPDK.
Bookmark