Appboard/2.4/admin/log files - Revision history

imported>Mike.berman at 04:48, 28 July 2014

2014-07-28T04:48:03Z

← Older revision		Revision as of 04:48, 28 July 2014
Line 121:		Line 121:
	== Submitting Log Files to Technical Support ==		== Submitting Log Files to Technical Support ==

	For information on submitting a support ticket, see the [[~~Technical_Support~~\|Technical Support]] page.		For information on submitting a support ticket, see the [[support/technical_support\|Technical Support]] page.

	For instructions on sending information to the Technical Support team, see the [[~~Submitting_Files_For_Technical_Support~~\|Submitting Files for Technical Support]] page.		For instructions on sending information to the Technical Support team, see the [[support/submitting_files_for_technical_support\|Submitting Files for Technical Support]] page.

imported>Jason.nicholls: /* Configuring Rotation */

2014-07-17T10:57:30Z

Configuring Rotation

← Older revision		Revision as of 10:57, 17 July 2014
Line 54:		Line 54:
	== Configuring Rotation ==		== Configuring Rotation ==

	Log file rotation is configured in the <tt>config.properties</tt> or <tt>appboard.properties</tt> files under <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt>~~, including settings such~~ as ~~the following~~:		Log file rotation is configured in the <tt>config.properties</tt> (most log files) and <tt>appboard.properties</tt> (appBoard.log) property files under <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt>.

			The default configuration is as follows:

	<code>[ini,N]		<code>[ini,N]
Line 88:		Line 90:

	<tt>numberToKeep</tt> does not include the current log, and compress will put the old log in a file named the same with ".zip" added. The process runs every 30 minutes to look for old files that need to be processed.		<tt>numberToKeep</tt> does not include the current log, and compress will put the old log in a file named the same with ".zip" added. The process runs every 30 minutes to look for old files that need to be processed.


	== Log File Configuration ==		== Log File Configuration ==

imported>Jason.nicholls at 10:53, 17 July 2014

2014-07-17T10:53:25Z

← Older revision		Revision as of 10:53, 17 July 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:Log Files}}		{{DISPLAYTITLE:Log Files}}
	[[Category:AppBoard 2.4]]		[[Category:AppBoard 2.4]]

	== Overview ==		== Overview ==

Line 12:		Line 11:

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


	{\| class="wikitable"		{\| class="wikitable"
Line 52:		Line 50:
	\| The standard log file for the Tomcat web application container		\| The standard log file for the Tomcat web application container
	\|}		\|}


	== Configuring Rotation ==		== Configuring Rotation ==
Line 79:		Line 78:
	logwatch.access.compress=true		logwatch.access.compress=true
	logwatch.access.skiplast=true		logwatch.access.skiplast=true


	# Log cleanup settings		# Log cleanup settings
	logwatch.appBoard.prefix=${logger.logs.path}/appBoard.log		logwatch.appBoard.prefix=${logger.logs.path}/appBoard.log
Line 86:		Line 84:
	logwatch.appBoard.compress=true		logwatch.appBoard.compress=true
	</code>		</code>


	This background job can be used to clean up any files that always have the same prefix. It assumes either the files are names: (<logname>, <logname><suffix1>, <logname><suffix2>) or (<logname><suffix1>, <logname><suffix2>, and so on). In the first case, the one without the suffix is assumed to be the current log, while in the latter a flag “skiplast” is used to not archive/delete the last (in alpha-numeric ordering). This is only used for the tomcat access log.		This background job can be used to clean up any files that always have the same prefix. It assumes either the files are names: (<logname>, <logname><suffix1>, <logname><suffix2>) or (<logname><suffix1>, <logname><suffix2>, and so on). In the first case, the one without the suffix is assumed to be the current log, while in the latter a flag “skiplast” is used to not archive/delete the last (in alpha-numeric ordering). This is only used for the tomcat access log.


	<tt>numberToKeep</tt> does not include the current log, and compress will put the old log in a file named the same with ".zip" added. The process runs every 30 minutes to look for old files that need to be processed.		<tt>numberToKeep</tt> does not include the current log, and compress will put the old log in a file named the same with ".zip" added. The process runs every 30 minutes to look for old files that need to be processed.

imported>Jason.nicholls: /* Log Files */

2014-07-17T10:52:48Z

Log Files

← Older revision		Revision as of 10:52, 17 July 2014
Line 22:		Line 22:
	\| 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		\| 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
	\|-		\|-
	\| error.log~~.[<i>date~~</i>]		\| <tt>error.log</tt>
	\| Subset of appBoard.log, containing only Error messages		\| Subset of appBoard.log, containing only Error messages
	\|-		\|-
	\| ldap.log~~.[<i>date~~</i>]		\| <tt>ldap.log</tt>
	\| Messages related to LDAP		\| Messages related to LDAP
	\|-		\|-
	\| localhost_access_log.[<i>date</i>].txt		\| <tt>localhost_access_log.[<i>date</i>].txt</tt>
	\| Detail of all individual user HTTP requests made to the system. Note: AppBoard/enPortal does not log access to specific individual Widgets or Boards, but could enable debugging of all data queries so that those could be audited.		\| Detail of all individual user HTTP requests made to the system. Note: AppBoard/enPortal does not log access to specific individual Widgets or Boards, but could enable debugging of all data queries so that those could be audited.
	\|-		\|-
	\| session.log~~.[<i>date~~</i>]		\| <tt>session.log</tt>
	\| Detail of all User sessions in the system, including:<br>		\| Detail of all User sessions in the system, including:<br>
	- Timestamp<br>		- Timestamp<br>
Line 43:		Line 43:
	- IP address		- IP address
	\|-		\|-
	\| system.log~~.[<i>date~~</i>]		\| <tt>system.log</tt>
	\| All errors, warnings, and informational messages related to the enPortal server. including:<br>		\| All errors, warnings, and informational messages related to the enPortal server. including:<br>
	- Expired license errors<br>		- Expired license errors<br>
Line 49:		Line 49:
	- User session information		- User session information
	\|-		\|-
	\| tomcat.log~~.[<i>day_of_week~~</i>]		\| <tt>tomcat.log</tt>
	\| The standard log file for the Tomcat web application container		\| The standard log file for the Tomcat web application container
	\|}		\|}

imported>Jason.nicholls: Created page with '{{DISPLAYTITLE:Log Files}} Category:AppBoard 2.4 == Overview == AppBoard provides a number of log files to record activity and to assist with monitoring and troubleshooting…'

2014-07-17T10:50:40Z

Created page with '{{DISPLAYTITLE:Log Files}} Category:AppBoard 2.4 == Overview == AppBoard provides a number of log files to record activity and to assist with monitoring and troubleshooting…'

New page

{{DISPLAYTITLE:Log Files}}
[[Category:AppBoard 2.4]]

== Overview ==

AppBoard provides a number of log files to record activity and to assist with monitoring and troubleshooting. By default these log files are set to be automatically compressed and rotated to prevent run-away disk usage.

Log files are stored in the following location: <tt>[INSTAL_HOME]/server/logs/</tt>

== Log Files ==

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

{| class="wikitable"
|-
! Log File
! Description
|-
| <tt>appBoard.log</tt>
| 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. Note: AppBoard/enPortal does not log access to specific individual Widgets or Boards, but could enable debugging of all data queries so that those could be audited.
|-
| 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
|}

== Configuring Rotation ==

Log file rotation is configured in the <tt>config.properties</tt> or <tt>appboard.properties</tt> files under <tt>[INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/</tt>, including settings such as the following:

<code>[ini,N]
# Log cleanup settings
logwatch.error.prefix=${logger.logs.path}/error.log
logwatch.error.numberToKeep=7
logwatch.error.compress=true

logwatch.system.prefix=${logger.logs.path}/system.log
logwatch.system.numberToKeep=7
logwatch.system.compress=true

logwatch.session.prefix=${logger.logs.path}/session.log
logwatch.session.numberToKeep=7
logwatch.session.compress=true

logwatch.ldap.prefix=${logger.logs.path}/ldap.log
logwatch.ldap.numberToKeep=7
logwatch.ldap.compress=true

logwatch.access.prefix=${logger.logs.path}/localhost_access_log
logwatch.access.numberToKeep=7
logwatch.access.compress=true
logwatch.access.skiplast=true

# Log cleanup settings
logwatch.appBoard.prefix=${logger.logs.path}/appBoard.log
logwatch.appBoard.numberToKeep=7
logwatch.appBoard.compress=true
</code>

This background job can be used to clean up any files that always have the same prefix. It assumes either the files are names: (<logname>, <logname><suffix1>, <logname><suffix2>) or (<logname><suffix1>, <logname><suffix2>, and so on). In the first case, the one without the suffix is assumed to be the current log, while in the latter a flag “skiplast” is used to not archive/delete the last (in alpha-numeric ordering). This is only used for the tomcat access log.

<tt>numberToKeep</tt> does not include the current log, and compress will put the old log in a file named the same with ".zip" added. The process runs every 30 minutes to look for old files that need to be processed.

== Log File 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.

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

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.

=== enPortal 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|Technical Support]] page.

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