2019031419PM-Enable ADF Logging

た入场券 2022-01-30 01:35 155阅读 0赞

## Description ##

This page will provide guideline to turn on ADF Request Logging/ enable loggers to generate logs that can be used to diagnose and troubleshoot issues.

## Find out what is the Logger Named you want to Change? ##

FMW is a complex stack. Ask your developer the following info

1.  What is the logger name to be enabled e.g. oracle.adfdiagnostics or oracle.adf.model
2.  What is the log level for that logger e.g. CONFIG or FINEST

Once you have the above info, you can use the following mechanism to apply the Logger Name to your AppServer (typically WLS) env. If you need this info for non-WLS platforms - like WAS, Glassfish or Tomcat, contact dipankar.bajpai.

### Typical ADF Functional Areas and Logger Mappings ###

<table> 
 <thead> 
  <tr> 
   <th> <p>ADF</p> </th> 
   <th> <p>Symptom</p> </th> 
   <th> <p>Logger Name</p> </th> 
   <th> <p>Level</p> </th> 
   <th> <p>Owner</p> </th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td> <p>ADF Diagnostics</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>oracle.adfdiagnostics</p> </td> 
   <td> <p>CONFIG</p> </td> 
   <td> <p>Trina.Dsouza</p> </td> 
  </tr> 
  <tr> 
   <td> <p>Model</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>oracle.adf.model, oracle.jbo</p> </td> 
   <td> <p>FINEST</p> </td> 
   <td> <p>Sekhar.Korupolu</p> </td> 
  </tr> 
  <tr> 
   <td> <p>Jedi</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>oracle.adf.model.businesseditor</p> </td> 
   <td> <p>FINE</p> </td> 
   <td> <p>Juan.Oropeza</p> </td> 
  </tr> 
  <tr> 
   <td> <p>Controller</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>oracle.adf.controller, oracle.adfinternal.controller</p> </td> 
   <td> <p>FINEST</p> </td> 
   <td> <p>Peter.Pressley</p> </td> 
  </tr> 
  <tr> 
   <td> <p>ADF Faces</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>oracle.adf.view, oracle.adfinternal.view</p> </td> 
   <td> <p>FINE</p> </td> 
   <td> <p>Michael.Mcgrath</p> </td> 
  </tr> 
  <tr> 
   <td> <p>ADFShare</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>oracle.adf.share</p> </td> 
   <td> <p>FINEST</p> </td> 
   <td> <p>Dipankar.Bajpai</p> </td> 
  </tr> 
  <tr> 
   <td> <p>ADFShare</p> </td> 
   <td> <p>Default or wrong adf-config.xml - Sometimes characterized by read-only MDS</p> </td> 
   <td> <p>oracle.adf.share.config.ADFConfigFactory, oracle.adf.share.config.FallbackConfigImpl</p> </td> 
   <td> <p>FINEST</p> </td> 
   <td> <p>Dipankar.Bajpai</p> </td> 
  </tr> 
  <tr> 
   <td colspan="1">User Interface Text (aka string editor)</td> 
   <td colspan="1">Searched strings aren't being found or being replaced after preview changes commit</td> 
   <td colspan="1"> <p>oracle.adf.stringeditor,</p> <p>oracle.adf.resourcebundle.stringeditor</p> </td> 
   <td colspan="1">FINEST</td> 
   <td colspan="1">Dipankar.Bajpai</td> 
  </tr> 
  <tr> 
   <td> <p>ADFSecurity</p> </td> 
   <td> <p><a href="http://aseng-wiki.us.oracle.com/asengwiki/display/ASDevJDeveloper/How+to+diagnose+ADF+issues#HowtodiagnoseADFissues-Usecase6HowtodiagnoseADFauthorizationerrors" rel="nofollow">ADF authorization errors</a></p> </td> 
   <td> <p>oracle.adf.share.security</p> </td> 
   <td> <p>FINEST</p> </td> 
   <td> <p>yvonne.chua</p> </td> 
  </tr> 
  <tr> 
   <td> <p>ADFDi</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>oracle.adf.desktopintegration</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>alex.davis</p> </td> 
  </tr> 
  <tr> 
   <td> <p>MDS</p> </td> 
   <td> <p><a href="http://aseng-wiki.us.oracle.com/asengwiki/display/ASDevMDS/MDS+Information+For+Support#MDSInformationForSupport-DiagnosticLogging" rel="nofollow">See Diagnostic Logging section of MDS Information for Support wiki</a></p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>&nbsp;</p> </td> 
   <td> <p>denny.mckinney</p> </td> 
  </tr> 
 </tbody> 
</table>

## Configuring Settings for Log Files ##

*  [Changing Log File Locations][]
 *  [Configuring Log File Rotation][]
 *  [Setting the Level of Information Written to Log Files][]
 *  [Specifying the Log File Format][]

## Modifying Logging.xml ##

### On Standalone WeblogicServer ###

*  Stop the Server.
 *  Modify <DOMAIN\_ROOT>/fmwconfig/config/servers//logging.xml and enable logger by setting it to appropriate level. Add the logger if logger is missing in logging.xml.
    
    <table> 
     <tbody> 
      <tr> 
       <td> <p><code><code>'oracle.adfdiagnostics'</code> <code>level=</code><code>'CONFIG'</code><code>/&gt;</code></code></p> </td> 
      </tr> 
     </tbody> 
    </table>
 *  Re-start the server.

### On Integrated WeblogicServer (JDeveloper) ###

**Open Logging.xml in Jdeveloper.**

*  View->Application Server Navigator
 *  Expand Application Servers
 *  Right Click IntegratedWeblogicServer
 *  Select "Configure Oracle Diagnostics Logging for "IntegratedWeblogicServer" "
 *  Search for the logger. Add the logger if logger is missing in logging.xml.
 *  Set appropriate log Level and save.

![logging.png_version_1_modificationDate_1369254936000_api_v2][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pvaG5ueV9uaXU_size_16_color_FFFFFF_t_70][]

![(lightbulb)][lightbulb]**You need not re-start the server.**

## Using EM Console ##

### Configure logger level ###

*  Log into Enterprise Manager (eg: http://slc08yla.us.oracle.com:7011/em )with username/password(eg: weblogic/weblogic1) with ADMIN role privilege and navigate to the Log Configuration page for your server.
 *  To open the Log Configuration page, right-click the Server node in the navigation tree and select Logs > Log Configuration.

![EM_log_config_1.gif_version_1_modificationDate_1390854113000_api_v2][]![20190517162930179.gif][]

*  For each logger, select the desired log level.

![logConfig.png_version_1_modificationDate_1426753683000_api_v2][]![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pvaG5ueV9uaXU_size_16_color_FFFFFF_t_70 1][]

*  Add the logger (if missing) and set the log level.

### Reset logger level ###

*  To reset logger, set log level to OFF using [above][] steps.

### Configure logger for a User ###

*  Follow the instructions [here][]

![(lightbulb)][lightbulb]**Verify appropriate logger name for different use-cases**

## Using WLST ##

*  Use [WLST commands][] to set the log level. Be sure to [start WLST command prompt][] using a username/password with ADMIN role privilege:
    
    <table> 
     <tbody> 
      <tr> 
       <td> <p><code>setLogLevel(logger=</code><code>"oracle.adfdiagnostics"</code><code>, level=</code><code>"CONFIG"</code><code>, addLogger=</code><code>1</code><code>)</code></p> </td> 
      </tr> 
     </tbody> 
    </table>
    
    Note: if after setLogLevel you do getLogLevel and logger level isn't set on the target server, then use setLogLevel with option target="" as seen below.
 *  <table> 
     <tbody> 
      <tr> 
       <td> <p><code>setLogLevel(logger=</code><code>"oracle.adfdiagnostics"</code><code>, level=</code><code>"CONFIG"</code><code>, addLogger=</code><code>1</code><code>,target=</code><code>"serverName"</code><code>)</code></p> </td> 
      </tr> 
     </tbody> 
    </table>

### Turn ON Per User ADF Request Logging ###

*  Be sure to [start WLST command prompt][] using a username/password with ADMIN role privilege:
    
    <table> 
     <tbody> 
      <tr> 
       <td> <p><code>configureTracingLoggers(action=</code><code>'disable'</code><code>)</code></p> <p><code>configureTracingLoggers(pattern=[</code><code>'oracle.adfdiagnostics'</code><code>], action=</code><code>'enable'</code><code>)</code></p> <p><code>startTracing(user=</code><code>'oracle.firstname.lastname'</code><code>, level=</code><code>'CONFIG'</code><code>)</code></p> </td> 
      </tr> 
     </tbody> 
    </table>

### Turn OFF Per User ADF Request Logging ###

*  Be sure to [start WLST command prompt][] using a username/password with ADMIN role privilege:

<table> 
 <tbody> 
  <tr> 
   <td> <p><code>stopTracing(user=</code><code>'oracle.firstname.lastname'</code><code>)</code></p> </td> 
  </tr> 
 </tbody> 
</table>

## How to start WLST ##

From middleware/oracle\_common/common/bin execute following:

<table> 
 <tbody> 
  <tr> 
   <td> <p><code>./setWlstEnv.sh</code></p> <p><code>./wlst.sh</code></p> </td> 
  </tr> 
 </tbody> 
</table>

## How to connect to Weblogic Server from WLST ##

1.  Start WLST [How to start WLST][start WLST command prompt]
2.  Connect to the Weblogic Server

*  **connect(user,password,'t3://host:port')**

user- User name with ADMIN role privilege  
password - password of above user.  
host - host where app is deployed  
port - Weblogic Server port

<table> 
 <tbody> 
  <tr> 
   <td> <p><code>connect(</code><code>'weblogic'</code><code>,</code><code>'weblogic1'</code><code>,</code><code>'t3://localhost://7001'</code><code>)</code></p> </td> 
  </tr> 
 </tbody> 
</table>

![(lightbulb)][lightbulb]**User, password, host and port are used as an example.**

## Generate Incident in an event of JBOException ##

[Configure incident generation][]

[Changing Log File Locations]: http://docs.oracle.com/cd/E21764_01/core.1111/e10105/logs.htm#CHDHAEED
[Configuring Log File Rotation]: http://docs.oracle.com/cd/E21764_01/core.1111/e10105/logs.htm#CHDGFGGB
[Setting the Level of Information Written to Log Files]: http://docs.oracle.com/cd/E21764_01/core.1111/e10105/logs.htm#CHDEJBIF
[Specifying the Log File Format]: http://docs.oracle.com/cd/E21764_01/core.1111/e10105/logs.htm#CHDDBGGE
[logging.png_version_1_modificationDate_1369254936000_api_v2]: http://aseng-wiki.us.oracle.com/asengwiki/download/attachments/15100802447232/logging.png?version=1&modificationDate=1369254936000&api=v2
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pvaG5ueV9uaXU_size_16_color_FFFFFF_t_70]: /images/20220130/6f14a83560aa45dbb6c88d109d77feec.png
[lightbulb]: http://aseng-wiki.us.oracle.com/asengwiki/s/en_GB-1988229788/4727/ffd10e10ff7bc0a1d7e29b4d2225707dd7f03d0b.5/_/images/icons/emoticons/lightbulb_on.png
[EM_log_config_1.gif_version_1_modificationDate_1390854113000_api_v2]: http://aseng-wiki.us.oracle.com/asengwiki/download/attachments/15100802447232/EM_log_config_1.gif?version=1&modificationDate=1390854113000&api=v2
[20190517162930179.gif]: /images/20220130/7ffe63bce1494ba6b3d87d82db7865d4.png
[logConfig.png_version_1_modificationDate_1426753683000_api_v2]: http://aseng-wiki.us.oracle.com/asengwiki/download/attachments/15100802447232/logConfig.png?version=1&modificationDate=1426753683000&api=v2
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2pvaG5ueV9uaXU_size_16_color_FFFFFF_t_70 1]: /images/20220130/c1cbdd5650754fa3b7cbed2c158a1238.png
[above]: http://aseng-wiki.us.oracle.com/asengwiki/display/ASDevJDeveloper/Enable+ADF+Logging#EnableADFLogging-Configureloggerlevel
[here]: http://docs.oracle.com/cd/E21764_01/core.1111/e10105/logs.htm#BABGGAAE
[WLST commands]: http://fmwdocs.us.oracle.com/doclibs/fmw/E10285_01/web.1111/e13813/custom_logging.htm#BCGHAGGF
[start WLST command prompt]: http://aseng-wiki.us.oracle.com/asengwiki/display/ASDevJDeveloper/Enable+ADF+Request+Logging#EnableADFRequestLogging-HowtostartWLST
[Configure incident generation]: http://aseng-wiki.us.oracle.com/asengwiki/display/ASDevJDeveloper/Create+Incidents+in+an+event+of+a+JBOException