Skip Headers

Oracle® Application Server Forms Services Deployment Guide 10g Release 2 (10.1.2) B14032-03 |
| Library | Product | Contents | Index

Previous | Next |

# 8.7 Servlet Logging Tools

Servlet logging tools enable site administrators to keep a record of all Oracle Forms sessions, monitor Oracle Forms-related network traffic, and debug site configuration problems.The features of servlet logging tools available with Oracle Application Server Forms Services include:

- Recording of all Oracle Forms sessions, including session start and end times, and the user's IP address and host name (session-level logging)

- Monitoring of Oracle Forms-related network traffic and performance (session-performance and request-performance-level logging)

- Generating debugging information for site configuration issues (debug-level logging)

These sections on the servlet logging tools contain the following:

- Section 8.7.1, "Enabling Logging"

- Section 8.7.2, "Location of Log Files"

- Section 8.7.3, "Example Output for Each Level of Servlet Logging"

## 8.7.1 Enabling Logging

You enable logging by:

- Appending one of the strings in Table 8–8, " Supported logging capabilities" to the serverURL parameter in the URL that starts the form.

- Appending one of the strings in Table 8–8, " Supported logging capabilities" to the serverURL client parameter in the Configuration page of Enterprise Manager Application Server Control Console.

When you turn on logging, the Listener Servlet writes log messages to the servlet log file. Examples of output for the various levels of logging are in Section 8.7.3, "Example Output for Each Level of Servlet Logging".

Table 8-8 Supported logging capabilities

String appended to serverURL client parameter | Description of logging
--- | ---
(none) | No log messages are produced. However, during Forms Servlet initialization, a message is written to the log file stating the name and path of the configuration file being used.
/session | Log messages are written whenever a Forms session starts or ends. These give the host name and IP address of the client (the computer on which the user's web browser is running), the runtime process id, and a unique internal session id number.
/sessionperf | Performance summary statistics are included with the session end message.
/perf | A performance message is written for every request from the client.
/debug | Full debug messages. Other debug messages are written in addition to the messages mentioned above. This logging level is very verbose and is intended mainly for debugging and support purposes.

### 8.7.1.1 Specifying Logging in the URL

As an example, to start a performance-level trace, you would start the Oracle Forms application using a URL as follows:

`http://yourserver/forms/frmservlet?serverURL=/forms/lservlet/perf`

### 8.7.1.2 Specifying Logging through Enterprise Manager

As an example, to start session-level logging for all users, you would change the serverURL entry in the default section in the Forms Web Configuration page to the following:

`serverURL=/forms/frmservlet/session`

### 8.7.1.3 Specifying Full Diagnostics in the URL that Invokes the Forms Servlet

As an example, to start full diagnostics, you would start the Oracle Forms application using a URL as follows. Note that if you append /debug to the URL used to invoke the Forms Servlet that servlet will output debug messages to the log file too.

`http://yourserver/forms/frmservlet/debug?serverURL=/forms /lservlet/debug`

## 8.7.2 Location of Log Files

The servlet log file is application.log. It is written to the `application-deployments/formsapp` directory of the OC4J instance to which Forms is deployed.

In Oracle Application Server Forms Services, the full path is:

`ORACLE_HOME/j2ee/OC4J_BI_FORMS/application-deployments/formsapp /OC4J_BI_Forms_default_island_1/application.log`

In Forms Developer, it is:

`ORACLE_HOME/j2ee/DevSuite/application-deployments /forms/application.log`

## 8.7.3 Example Output for Each Level of Servlet Logging

The following are examples of the type of output you will get when you use the following levels of logging:

- (none)

- /session

- /sessionperf

- /perf

- /debug

### 8.7.3.1 (none)

    FormsServlet init():
    configFileName:     d:\Oracle/forms/server/formsweb.cfg
    testMode:           false

### 8.7.3.2 /session

Session start messages (example):

    Forms session <10> started for test-pc.mycompany.com ( 138.56.98.72 )
    Forms session <10> runtime process id = 373

Session end message (example):

    Forms session <10> ended

### 8.7.3.3 /sessionperf

    Forms session <3> started for test-pc.mycompany.com ( 138.56.98.72 )
    Forms session <3> runtime process id = 460
    Forms session <3> ended
      Total duration of network exchanges: 1.041
      Total number of network exchanges: 2 (1 "long" ones over 1.000 sec)
      Average time for one network exchange (excluding long ones): 0.030
    Total bytes: sent 1,110, received 316

### 8.7.3.4 /perf

    Forms session <3> started for test-pc.mycompany.com ( 138.56.98.72 )
    Forms session <3> runtime process id = 460
    Forms session <3>: request processed in 1.011 sec. Received 8 bytes,returned 8 bytes.
    Forms session <3>: request processed in 0.030 sec. Received 308 bytes, returned 1,102 bytes.
    Forms session <3> ended
      Total duration of network exchanges: 1.041
      Total number of network exchanges: 2 (1 "long" ones over 1.000 sec)
      Average time for one network exchange (excluding long ones): 0.030
      Total bytes: sent 1,110, received 316

### 8.7.3.5 /debug

Here is an example run by going to a URL like `http://test-machine:8888/forms/frmservlet /debug&config=myapp&serverURL=/forms/lservlet/debug)`:

    =============== FormsServlet ===============
    GET request received, cmd=debug,
    qstring=config=myapp&serverURL=/forms/lservlet/debug
    No current servlet session
    File baseie.htm not found, looking in d:\Oracle/forms/server
    The SSO_USERID is: null
    =============== FormsServlet ===============
    GET request received, cmd=startsession, qstring=config=myapp&serverURL=
    /forms/lservlet/debug&ifcmd=startsession
    No current servlet session
    New servlet session started
    SSO_USERID in startSession: null
    SSO_AuthType in startSession: null
    User DN: null
    Subscriber DN: null
    EM mode in the config file: 0
    File default.env not found, looking in d:\Oracle/forms/server
    envFile = d:\Oracle\forms\server\default.env
    serverURL: /forms/lservlet/debug
    rewrittenURL: /forms/lservlet/debug;jsessionid=27f6412da05c
    426ab47db4ae77636113
    =============== ListenerServlet ===============
    GET request received, cmd=getinfo,
    qstring=ifcmd=getinfo&ifhost=test-pc.mycompany.com&ifip=130.35.96.71
    Existing servlet session, id = 27f6412da05c426ab47db4ae77636113, not from cookie
    Creating new Runtime Process using default executable
    Starting Forms Server in EM mode
    startProcess: executing frmweb server webfile=HTTP-0,0,1
    Getting stdin, stdout and stderr of child process
    Writing working directory to stdin: d:\Oracle\forms
    New server process created
    Forms session <4> started for test-pc.mycompany.com ( 138.56.98.72 )
    ***********************************************
    Got POST request, length = 8
    HTTP request headers:
          ACCEPT-LANGUAGE: en
          PRAGMA: 1
          CONTENT-TYPE: application/x-www-form-urlencoded
          ACCEPT: text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
          USER-AGENT: Mozilla/4.0 (compatible; MSIE 5.0; Win32)
          HOST:test-machine:8888
          CONTENT-LENGTH: 8
          CONNECTION: Keep-Alive
    Existing servlet session, id = 27f6412da05c426ab47db4ae77636113, not from cookie
    Forms session <4> runtime process id = 474
    Port number is 2791
    RunformProcess.connect(): connected after 1 attempts
    Connected to ifweb process at port 2791
    Forms session <4>: request processed in 1.032 sec. Received 8 bytes,
    returned 8 bytes.
    ***********************************************