The Log Viewer is developed as an Eclipse plug-in. It is an independent tool designed to view single or multiple log files. A log file records activities and operations that occurred on a server/computer, maintaining an operational history of these activities. A log file is identified by its .log extension.
The Log Viewer allows the user to:
Specify refresh intervals.
Specify the number of lines to be displayed from a file.
Customize the way to view files by specifying filter conditions.
Save the log files added in the viewer so that the user is able access them easily the next time.
Provide extension points so as to enable other Eclipse plugins to contribute their log files for viewing.
This document discusses the following topics:
To add a new Log Viewer
In the Eclipse view, open .
In the Show View screen, select .
The Log Viewer view appears. You may position it to appear at a convenient location on your screen.
To add a new Log Viewer, choose the button.
The Create Log Viewer dialog appears, in which you can specify the file to be viewed and conditions for viewing.
If you are manually selecting a log file, specify the following details:
Specify the following details:
| Log file to view is fixed | Select this option if the log file that must be viewed is fixed i.e. if its name does not change. The Log Viewer will view/read this file every time. |
| Name of the log file varies | Select this option if the name of the log file changes on some criteria; name of the log file might contain timestamp which is changed daily; hence the name of the log file also varies daily. |
| Select the log file directory | Browse and select the location of the file for the Log Viewer to view. The Log Viewer in this case picks up the file to view/read from this location. Specify this if you have selected the Name of the log file varies option. |
| Log file name pattern | Specify the date pattern of your log files.
For example,
${TOMCAT_HOME}\logs\catalina.${yyyy}-${mm}-${dd}.log.
Note: |
| Add pattern | Select the date format from the available options in the drop down list. |
| Name of the view | Enter a name to identify this viewer. |
| Refresh Interval (in seconds) | The Log Viewer refreshes the view as per the interval you specify here. |
| Options | Choose the option to either view the complete log file or a few lines of it when opened the first time. If you select the latter option, you need to specify the Total Lines to be displayed. |
Or:
If you are selecting a predefined log, select the log file from the
Select a Predefined log file drop down list. On selection,
the settings of the predefined file are auto populated in other fields. To
learn more about predefined logs, see About
Predefined Logs.
Choose the Add Filter button if you wish to add filters to the log files you view. Using these features, you can filter lines based on some conditions such as skipping the entire line or changing the display style in the view.
In the dialog box that appears, add line filters. For example, to view a line highlighted in black and the font color as green, specify the following filters:
Select "Contains text" in the If Line field and specify the text as "Info".
Select the Filter Action as Change the style of the line.
Select the Foreground color as "green" and the Background color as "black".
Choose the Ok button to complete adding a new Log Viewer.
You can edit an existing Log Viewer or remove it using the Log Viewer toolbar buttons. The procedure to edit a Log Viewer is the same as to add a Log Viewer except that you cannot edit the log file being viewed. You may access the Edit Log Viewer, Remove Log Viewer buttons from the Log Viewer toolbar or on right click of your mouse.
The Log Viewer allows you to configure predefined logs. It displays predefined logs for selection in the Select a Predefined log file drop down list.
The following list of predefined log files appear for selection in the Log Viewer.
|
File Name
|
Purpose of the File
|
File Location
|
| Application DesignerApplication ComposerNatural for Ajax Server Log | Runtime log file of the BPEL processing layer. It logs system generated and user defined information. | \xciwebapps\xciservices\logs\ApplComposer.log |
| Application DesignerApplication ComposerNatural for Ajax Deployment Log | Deployment log file of the processing layer.
Note: |
\AeBpelEngine\deployment-logs\aeDeployment.log |
| Application DesignerApplication ComposerNatural for Ajax Server Log | Runtime log file of the GUI and processing layers. | \projects\log\serverLog_${yyyy}${mm}${dd}.log |
| CentraSite Tomcat Catalina Log | Catalina log file of the CentraSite Tomcat. This log file is only written if the CentraSite Tomcat is manually started using catalina.bat. If tomcat is started from > , Catalina Service file is generated according to the parameters passed to the service start. (See Tomcat documentation for details.) | ${XCI_TOMCAT_HOME}\logs\catalina.${yyyy}-${mm}-${dd}.log |