Appboard/2.6/admin/log files - Revision history

imported>Mike.berman: 1 revision: Upload production docs for 2.6.2 releases

2016-09-06T21:19:14Z

1 revision: Upload production docs for 2.6.2 releases

← Older revision	Revision as of 21:19, 6 September 2016
(No difference)

imported>Mike.berman: /* Log Files */

2016-09-02T21:02:54Z

Log Files

← Older revision		Revision as of 21:02, 2 September 2016
Line 5:		Line 5:
	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.		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 are stored in the following location: <tt>[INSTALL_HOME]/server/logs/</tt>


Line 23:		Line 23:
	* Java runtime error messages		* Java runtime error messages
	* Other errors and warnings		* Other errors and warnings
			* User IP address
	\|-		\|-
	\| <tt>error.log</tt>		\| <tt>error.log</tt>
Line 31:		Line 32:
	\|-		\|-
	\| <tt>localhost_access_log.[<i>date</i>].txt</tt>		\| <tt>localhost_access_log.[<i>date</i>].txt</tt>
	\| Log of individual HTTP requests serviced by the system including proxied requests. For application access information covering enPortal channel, and AppBoard Stack and Board usage refer to the <tt>system.log</tt>.		\| Log of individual HTTP requests serviced by the system including proxied requests. For application access information covering enPortal channel, and AppBoard Stack and Board usage refer to the <tt>system.log</tt>. Includes Actor (role, user, domain) and session details in versions 2.6.2 or higher.
	\|-		\|-
	\| <tt>session.log</tt>		\| <tt>session.log</tt>
Line 128:		Line 129:
	''appboard.log.begin=true		''appboard.log.begin=true
	''		''

			== Monitoring Log Files ==

			The AppBoard system administrator may want to pro-actively monitor the log files to check for any messages that may indicate an issue that needs attention. There are various third-party log-monitoring tools that can perform this operation.

			The logging system contains logs from several product related processes and sources. To avoid having to monitor multiple log files, all error conditions are written to the <tt>error.log</tt> file. Error conditions that are captured in this file should be reviewed and are generally indicative of a configuration issue or a web content retrieval issue.

			In order to detect error conditions in an enPortal/AppBoard server, monitor the log file: <tt>${INSTALL_HOME}/server/logs/error.log</tt>. In this file, it is recommended to monitor for lines that begin with a timestamp and “ERROR” in the form as follows:

			<tt>##:##:##:### - ERROR - …</tt>

			An example of such a line would be:

			<tt>06:51:19:866 - ERROR - AppBoardDataService - 47681: FINISH – doAction('findByQuery') namespace=cacheDB.SlaTrackNotes, session '2968d98378b7564b' not valid</tt>

			It is also suggested to ignore lines that end with text such as:

			<tt>… session ‘xxxxxxxxxxxxxxxx’ not valid</tt>

			as these messages only refer to expired user sessions and are routine.


	== Configuring Rotation ==		== Configuring Rotation ==

imported>Jason.nicholls: 1 revision

2015-12-04T05:14:09Z

1 revision

← Older revision	Revision as of 05:14, 4 December 2015
(No difference)

imported>Doug yeager: /* Configuring appBoard.log */

2015-11-16T16:58:42Z

Configuring appBoard.log

@@ Line 101: / Line 101: @@
 | This represents the time in milliseconds (1000 = 1 second) from when the request was first received (<tt>BEGIN</tt>) until the response given back to the client (<tt>FINISH</tt>). For cached responses this is typically very low. For responses that require the AppBoard server to fetch a response from a data source this ''can'' be much larger as this is dependent on the data source. For non-cached responses this is a useful metric to measure data source response time.
 |}
 == Configuring Rotation ==

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

2015-07-28T06:47:07Z

Log Files

@@ Line 18: / Line 18: @@
 |-
 | <tt>appBoard.log</tt>
-| 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
 |-
 | <tt>error.log</tt>
@@ Line 53: / Line 57: @@
 | <tt>blazeds.log</tt>
 | BlazeDS is used for serialization / de-serialization of messages to and from the Viewer and Builder. By default BlazeDS logging is disabled and this file will not be present. Unless instructed by support it is best to leave this disabled.
 |}

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

2015-07-27T12:17:18Z

Log Files

← Older revision		Revision as of 12:17, 27 July 2015
Line 50:		Line 50:
	\| <tt>tomcat.log</tt>		\| <tt>tomcat.log</tt>
	\| The standard log file for the Tomcat web application container		\| The standard log file for the Tomcat web application container
			\|-
			\| <tt>blazeds.log</tt>
			\| BlazeDS is used for serialization / de-serialization of messages to and from the Viewer and Builder. By default BlazeDS logging is disabled and this file will not be present. Unless instructed by support it is best to leave this disabled.
	\|}		\|}

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

2015-07-24T06:13:58Z

Log Files

← Older revision		Revision as of 06:13, 24 July 2015
Line 46:		Line 46:
	* Items requested by the application that could not be located on the server<br>		* Items requested by the application that could not be located on the server<br>
	* User session information		* User session information
	* Application-level access log. This logs ~~individual~~ accesses to enPortal Channels, AppBoard Stacks, and AppBoard Boards ~~per user~~.		* Application-level access log. This logs per-user accesses to enPortal Channels, AppBoard Stacks, and AppBoard Boards.
	\|-		\|-
	\| <tt>tomcat.log</tt>		\| <tt>tomcat.log</tt>

imported>Jason.nicholls: /* Log File Configuration */

2015-07-24T06:13:10Z

Log File Configuration

← Older revision		Revision as of 06:13, 24 July 2015
Line 106:		Line 106:
	The <b>MaxBackupIndex</b> is the number of daily logs to keep for each log file type, which is 15 by default.		The <b>MaxBackupIndex</b> is the number of daily logs to keep for each log file type, which is 15 by default.

			=== Additional enPortal Logging ===

	~~=== enPortal CRS Log Configuration ===~~		Refer to the enPortal [[enportal/5.6/admin/system_administration/Log_Files#Log_File_Configuration\|Log File]] documentation for further information.

	~~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 ==		== Submitting Log Files to Technical Support ==

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

2015-07-24T06:10:20Z

Log Files

← Older revision		Revision as of 06:10, 24 July 2015
Line 46:		Line 46:
	* Items requested by the application that could not be located on the server<br>		* Items requested by the application that could not be located on the server<br>
	* User session information		* User session information
	* Application-level access log. ~~Details~~ individual accesses to enPortal ~~channel~~, AppBoard ~~Stack~~, and AppBoard Boards per user.		* Application-level access log. This logs individual accesses to enPortal Channels, AppBoard Stacks, and AppBoard Boards per user.
	\|-		\|-
	\| <tt>tomcat.log</tt>		\| <tt>tomcat.log</tt>

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

2015-07-24T06:08:55Z

Log Files

← Older revision		Revision as of 06:08, 24 July 2015
Line 46:		Line 46:
	* Items requested by the application that could not be located on the server<br>		* Items requested by the application that could not be located on the server<br>
	* User session information		* User session information
	* Application-level access log ~~information covering~~ enPortal channel, ~~and~~ AppBoard Stack and ~~Board usage by~~ user.		* Application-level access log. Details individual accesses to enPortal channel, AppBoard Stack, and AppBoard Boards per user.
	\|-		\|-
	\| <tt>tomcat.log</tt>		\| <tt>tomcat.log</tt>