Appboard/old/log files: Difference between revisions

imported>Mike.berman
(created page)
 
imported>Cmace
(copied from internalwiki)
Line 1: Line 1:
AppBoard/enPortal provides various log files to assist you with monitoring and troubleshooting.  This article details the various log files that are provided.
AppBoard/enPortal provides various log files to assist you with monitoring and troubleshooting.  This article details the log files that are provided.


==AppBoard Log Files==
== AppBoard/enPortal Log Files ==


=== Location ===


AppBoard/enPortal maintains log files primarily in the following location:
* [INSTALL_HOME]/server/logs


==enPortal Log Files==


enPortal maintains log files primarily in the following locations
=== Summary ===
* [PORTAL_HOME]/logs
* [PORTAL_HOME]/httpd/apache-integration/logs
* [PORTAL_HOME]/httpd/jakarta-tomcat/logs


The following table summarizes each log file and the information it provides:


Below are some general notes with regard to each type of log file:


* enPortal logs - [PORTAL_HOME]/logs
{| class="wikitable" border="1" style="background-color:#eeeeee;"
** These log files are not rotated, but there are some controls you can implement to manage the size of these files
|+ align="bottom" style="color:#e76700;" |''AppBoard/enPortal Log Files''
*** Example: Observe the following lines in [PORTAL_HOME]/config/logger-jsp.properties:
|-
**** handlers.errorFile.class=com.edgetech.util.logger.FileHandler
| width=300 | <center><b>Log File</b></center>
**** handlers.errorFile.fileName=jsp-error.log
| <center><b>Description</b></center>
*** You could add the following line to logger-jsp-custom.properties to limit the size of this particular log file to about 1 MB:
|-
**** handlers.errorFile.maxSize=1024000
| appBoard.log.[<i>date</i>]
*** You could similarly limit the size of the other log files that are configured in the logger properties files
| All messages related to client-server communications<br>Information about data queries made to the server<br>Java runtime error messages<br>Other errors and warnings
** See also [PORTAL_HOME]/config/logger-portal.properties
|-
** Masking controls are also provided for controlling the verbosity of what is written to a number of the log files
| error.log.[<i>date</i>]
| Subset of appBoard.log, containing only Error messages
|-
| ldap.log.[<i>date</i>]
| Messages related to LDAP
|-
| localhost_access_log.[<i>date</i>].txt
| Detail of all individual user HTTP requests made to the system
|-
| session.log.[<i>date</i>]
| Detail of all User sessions in the system, including:<br>
- Timestamp<br>
- Role<br>
- Domain<br>
- Username<br>
- Transaction Result<br>
- Session ID<br>
- Total number of concurrent logins<br>
- Total number of concurrent logins in the User's Domain<br>
- IP address
|-
| system.log.[<i>date</i>]
| All errors, warnings, and informational messages related to the enPortal server. including:<br>
- Expired license errors<br>
- Items requested by the application that could not be located on the server<br>
- User session information
|-
| tomcat.log.[<i>day_of_week</i>]
| The standard log file for the Tomcat web application container
|}


* Apache logs - [PORTAL_HOME]/httpd/apache-integration/logs
=== Configuration ===
** The access.log file tends to grow the most rapidly, as you may have observed with the 16GB log file
** These files can be safely archived and deleted when the portal is stopped for a maintenance window.  The portal will re-create new log files when re-started
** Using more advanced techniques, you can set these log file to rotate, so that a cron job or manual process can then delete the older log files without requiring a maintenance window


* Tomcat logs - [PORTAL_HOME]/httpd/jakarta-tomcat/logs
** These are rotated by default, and typically not too large, so a simple cron job (or manual process) to occasionally delete the older log files is recommended


The standard log files above are written using the log4j library and can be configured through the enportal/WEB-INF/classes/log4j.xml file.  For information on configuring log4j, please see: http://en.wikipedia.org/wiki/Log4j#Configuration


==Console Output==


Of note, the following settings will change the verbosity of the log files and how long each daily log is kept.


<code>[xml,N]
<param name="Threshold" value="INFO"/>
<param name="MaxBackupIndex" value="15"/>
</code>
<b>Threshold</b> can have values from most verbose to least of: TRACE, DEBUG, INFO, WARN, ERROR and FATAL.
The <b>MaxBackupIndex</b> is the number of daily logs to keep for each log file type, which is 15 by default.
=== CRS Log Configuration ===
The custom CRS log for the enPortal proxy is not handled by log4j. The log files are not rotated, but there are some controls you can implement to manage the size and content of the CRS log.
* Example: Observe the following lines in [INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/logger-crs.properties:
** handlers.crsFile.class=com.edgetech.util.logger.FileHandler
** handlers.crsFile.fileName=crs.log
* You could add the following line to logger-crs-custom.properties to limit the size of this particular log file to about 1 MB:
** handlers.crsFile.maxSize=1024000
* Masking controls are also provided for controlling the verbosity of what is written to a number of the log files.  The mask uses bits to turn on/off various information, and can be the sum of any of (0,1,2,4,8).




Revision as of 21:06, 8 March 2012

AppBoard/enPortal provides various log files to assist you with monitoring and troubleshooting. This article details the log files that are provided.

AppBoard/enPortal Log Files

Location

AppBoard/enPortal maintains log files primarily in the following location:

  • [INSTALL_HOME]/server/logs


Summary

The following table summarizes each log file and the information it provides:


AppBoard/enPortal Log Files
Log File
Description
appBoard.log.[date] All messages related to client-server communications
Information about data queries made to the server
Java runtime error messages
Other errors and warnings
error.log.[date] Subset of appBoard.log, containing only Error messages
ldap.log.[date] Messages related to LDAP
localhost_access_log.[date].txt Detail of all individual user HTTP requests made to the system
session.log.[date] Detail of all User sessions in the system, including:

- Timestamp
- Role
- Domain
- Username
- Transaction Result
- Session ID
- Total number of concurrent logins
- Total number of concurrent logins in the User's Domain
- IP address

system.log.[date] All errors, warnings, and informational messages related to the enPortal server. including:

- Expired license errors
- Items requested by the application that could not be located on the server
- User session information

tomcat.log.[day_of_week] The standard log file for the Tomcat web application container

Configuration

The standard log files above are written using the log4j library and can be configured through the enportal/WEB-INF/classes/log4j.xml file. For information on configuring log4j, please see: http://en.wikipedia.org/wiki/Log4j#Configuration


Of note, the following settings will change the verbosity of the log files and how long each daily log is kept.

[xml,N] <param name="Threshold" value="INFO"/> <param name="MaxBackupIndex" value="15"/>


Threshold can have values from most verbose to least of: TRACE, DEBUG, INFO, WARN, ERROR and FATAL.

The MaxBackupIndex is the number of daily logs to keep for each log file type, which is 15 by default.


CRS Log Configuration

The custom CRS log for the enPortal proxy is not handled by log4j. The log files are not rotated, but there are some controls you can implement to manage the size and content of the CRS log.

  • Example: Observe the following lines in [INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/logger-crs.properties:
    • handlers.crsFile.class=com.edgetech.util.logger.FileHandler
    • handlers.crsFile.fileName=crs.log
  • You could add the following line to logger-crs-custom.properties to limit the size of this particular log file to about 1 MB:
    • handlers.crsFile.maxSize=1024000
  • Masking controls are also provided for controlling the verbosity of what is written to a number of the log files. The mask uses bits to turn on/off various information, and can be the sum of any of (0,1,2,4,8).


Submitting Log Files to Technical Support

For information on submitting a support ticket, see the Technical Support page.

For instructions on sending information to the Technical Support team, see the Submitting Files for Technical Support page.

Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Appboard/old/log_files&oldid=578"