Provides an in-browser log viewer for Liferay Portal. Supports CE and EE
Java
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
doc/images
src/main
.gitignore
README.md
pom.xml

README.md

Liferay Log Viewer Portlet

liferay-log-viewer-portlet

This project provides a portlet that attaches to the Liferay Portal's log4j mechanism to provide a log view within the browser.

Supported Products

  • Liferay Portal 6.1 CE GA2, GA3 (6.1.1+)
  • Liferay Portal 6.1 EE GA2, GA3 (6.1.20+)
  • Liferay Portal 6.2 CE GA1 (6.2.0+)
  • Liferay Portal 6.2 EE GA1 (6.2.10+)

Downloads

The latest releases are available from SourceForge.

You can also download or install the portlet from Liferay Marketplace

Usage

Administrators will see a "Log Viewer" portlet in the Server area of the Control Panel in 6.1. In 6.2, it is present in the Apps section of the Control Panel Other users can also be assigned permissions to see the Log Viewer Portlet.

Log Viewer Portlet

Log Viewer Portlet

The portlet polls the log buffer every 2 seconds to update the page with the latest logs. You can also attach or detach the logger from the portal log4j. (when detached, the portlet does not cause any overhead on portal operations).

Two portal properties can be set:

  • permeance.log.viewer.autoattach to toggle whether the logger attaches automatically on startup, default "true".
  • permeance.log.viewer.pattern to configure the log4j pattern, default "%d{ABSOLUTE} %-5p [%c{1}:%L] %m%n"

Plugin Security

This plugin comes with the PACL Security Manager disabled. However the list of PACL requirements to run this plugin in secure mode is available (commented out) in WEB-INF/liferay-plugin-package.properties. You can uncomment those entries to run the plugin in PACL secure mode.

Building

Step 1. Checkout source from GitHub project

% git  clone  https://github.com/permeance/liferay-log-viewer

Step 2. Build and package

% mvn  -U  clean  package

This will build "liferay-log-viewer-portlet-XXXX.war" in the targets tolder.

NOTE: You will require JDK 1.6+ and Maven 3.

Installation

Liferay Portal + Apache Tomcat Bundle

eg.

Deploy "liferay-log-viewer-portlet-XXXX.war" to "LIFERAY_HOME/deploy" folder.

License

Liferay Log Viewer is available under GNU Public License version 3.0 (GPLv3). A copy of the license is attached in the code package.

Project Team