Skip to content

Latest commit

 

History

History
262 lines (211 loc) · 12.5 KB

README.md

File metadata and controls

262 lines (211 loc) · 12.5 KB
Raw

LogNavigator

LogNavigator is a web application, made in java, which lets you browse your logs, wherever they are.

Features

  • Navigate into your logs with the comfort of a web interface
  • All your logs from different servers centralized in one entry point
  • Configure log access from different sources:
    • local directory
    • directory on a remote server (using SSH protocol)
    • remote logs exposed by Apache Httpd DirectoryIndex (using HTTP protocol)
  • List log files, with scrolling list (until 50000 files), sorting and filtering
  • Watch log content, take advantage of powerful linux commands to get filtered log content
  • Download whole file content or only filtered log content
  • Easily browse file logs (with navigation bar)
  • Watch log content inside TAR.GZ and GZ archives
  • Smart combobox to choose current log access config, with filtering and grouping
  • Ability to choose log content encoding: UTF-8 (default) or ISO
  • Ability to choose log content display : RAW (default) or TABLE (with filtering)
  • Ability to secure log access with user authentication (login form, 8 hours session) and role-based authorization
  • Dangerous commands are blocked, and command blacklist can be customized
  • Responsive design (thanks to Bootstrap library)

Getting Started

Installation

  • Go to the last release and download WAR file
  • Deploy the WAR file on your favorite java app server (tomcat, jettty, glassfish, ...)
  • Create a new file named lognavigator.xml wherever you want
  • Define your log access configurations inside lognavigator.xml.
    For example :
<?xml version="1.0" encoding="UTF-8"?>
<lognavigator-config>
    <log-access-config id="local-dir" type="LOCAL" directory="/path/to/logs" display-group="a-local-configs" />
    <log-access-config id="remote-dir-using-ssh" type="SSH" user="your-user" password="your-password" host="remote-host" trust="true" directory="/path/to/logs" display-group="b-remote-configs" />
    <log-access-config id="remote-httpd-logs" type="HTTPD" url="http://archive.apache.org/dist/tomcat/" display-group="c-httpd-configs" />
</lognavigator-config>
  • You can get more examples in Configuration Examples section
  • Link lognavigator.xml to your java app server, using one of these 3 means :
    • Add system property -Dlognavigator.config=file:/path/to/lognavigator.xml to your server startup script
    • Add JNDI key/value lognavigator.config=file:/path/to/lognavigator.xml to your server JNDI configuration
    • Add lognavigator.xml directory to your server classpath
  • Start your java app server
  • That's all !

First Use

  • Once you have installed LogNavigator, open your favorite browser and go to : http://host:port/lognavigator/
  • You see screenshot #1, the first log access configuration is selected in combobox at top right, and a table lists all log files and folders
  • You can then change current log access configuration using combobox
  • You can filter logs list using "Search" filter
  • And finally you can of course click on a log file to watch its content
  • You see screenshot #2
  • By default, you see the 1000 last lines of the file (to avoid browser freeze due to too much content), using this command : tail -1000 yourlog.log
  • You can then filter log content using powerful linux commands like grep.
  • For example, type in Command field : grep "GET" yourlog.log and click the Execute button
  • You can finally download filtered content by clicking Download button

Screenshots

1. logs list

2. log content

3. choose log access config to browse

Make it work on windows

Because LogNavigator is based on linux commands, LogNavigator doesn't work out-of-the-box on windows. But few steps make it work on windows :

  • Download and install Cygwin
  • During install process, check option Net > curl
  • Add following environment variables :
CYGWIN=mintty nodosfilewarning
CYGWIN_HOME=<cygwin install directory>
PATH=<previous value>;%CYGWIN_HOME%\bin

Enable Security

Enabling security allows 2 points :

  • Secure LogNavigator access with login/password authentication, based on HTTP Basic Authentication
  • Provide user and role based authorization for each log access configuration

To enable security, few steps :

  • create a new file called lognavigator-authentication-context.xml, containing users, passwords and roles (authorities).
    Here's an example using bcrypt algorithm to hash passwords:
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns:beans="http://www.springframework.org/schema/beans"
	   xmlns="http://www.springframework.org/schema/security"
	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security.xsd"
>
	<authentication-manager>
		<authentication-provider>
			<password-encoder hash="bcrypt"/>
			<user-service>
				<user name="user1" password="$2y$10$GaRb0RZWrg.teBQOhJdJoeGD0Q8cs4B0/6v6wOFb0dc3AtDC0FfXm" authorities="role1, role2" />
				<user name="user2" password="$2y$10$GaRb0RZWrg.teBQOhJdJoeGD0Q8cs4B0/6v6wOFb0dc3AtDC0FfXm" authorities="role3" />
				<user name="user3" password="$2y$10$GaRb0RZWrg.teBQOhJdJoeGD0Q8cs4B0/6v6wOFb0dc3AtDC0FfXm" authorities="" />
			</user-service>
		</authentication-provider>
	</authentication-manager>
</beans:beans>

You can also use a simple digest algorithm to hash passwords (but it's not recommended):

<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns:beans="http://www.springframework.org/schema/beans"
	   xmlns="http://www.springframework.org/schema/security"
	   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	   xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
                           http://www.springframework.org/schema/security http://www.springframework.org/schema/security/spring-security.xsd"
>
	<authentication-manager>
		<authentication-provider>
			<password-encoder ref="md5PasswordEncoder"/>
			<user-service>
				<user name="user1" password="5f4dcc3b5aa765d61d8327deb882cf99" authorities="role1, role2" />
				<user name="user2" password="5f4dcc3b5aa765d61d8327deb882cf99" authorities="role3" />
				<user name="user3" password="5f4dcc3b5aa765d61d8327deb882cf99" authorities="" />
			</user-service>
		</authentication-provider>
	</authentication-manager>
	
	<beans:bean id="md5PasswordEncoder" class="org.springframework.security.crypto.password.MessageDigestPasswordEncoder">
		<beans:constructor-arg name="algorithm" value="MD5" />
	</beans:bean>

</beans:beans>

In this example, passwords are hashed using MD5 algorithm. But you can also use all algorithms listed here.

You can find other authentication-manager examples in this sample configuration file.

  • In your lognavigator.xml file, for each log-access-config, define authorized users and roles. For example :
<log-access-config id="one-config" ... authorized-roles="role1 role2" authorized-users="user1" />
  • Activate security and reference lognavigator-authentication-context.xml in lognavigator configuration. To do that, 3 ways :
    • Add system properties -Dspring.profiles.active=security-enabled -Dlognavigator.authentication.config=file:/path/to/lognavigator-authentication-context.xml to your server startup script
    • Add JNDI keys/values spring.profiles.active=security-enabled and lognavigator.authentication.config=file:/path/to/lognavigator-authentication-context.xml to your server JNDI configuration
    • Put lognavigator-authentication-context.xml into your server classpath and define spring.profiles.active=security-enabled as system property or JNDI key/value

Configuration Examples

LOCAL log access configurations

  • access to a directory on the same machine than lognavigator server :
<log-access-config id="a-local-dir" type="LOCAL" directory="/path/to/logs" />
  • group log access configurations in lognavigator combobox :
<log-access-config id="id1" type="LOCAL" directory="/path/to/logs" display-group="local-configs" />
<log-access-config id="id2" type="LOCAL" directory="/path/to/logs2" display-group="local-configs" />
  • customize the default encoding used to read command output (possible values are ISO-8859-1 and UTF-8) :
<log-access-config id="id1" type="LOCAL" directory="/path/to/logs" default-encoding="ISO-8859-1" />

SSH log access configurations

  • access to a remote directory using login/password (and force trust to remote host) :
<log-access-config id="a-remote-dir-using-ssh" type="SSH" user="your-user" password="your-password" host="remote-host" trust="true" directory="/path/to/logs" />
  • access to a remote directory using current user's private key (~/.ssh/id_dsa or ~/.ssh/id_rsa) and no password :
<log-access-config id="a-remote-dir-using-ssh" type="SSH" user="your-user" host="remote-host" directory="/path/to/logs" />
  • access to a remote directory using a specific private key (DSA or RSA) and no password :
<log-access-config id="a-remote-dir-using-ssh" type="SSH" user="your-user" privatekey="/path/to/privatekey" host="remote-host" directory="/path/to/logs" />
  • access to a remote directory using a specific private key (DSA or RSA) and a password :
<log-access-config id="a-remote-dir-using-ssh" type="SSH" user="your-user" privatekey="/path/to/privatekey" password="your-password" host="remote-host" directory="/path/to/logs" />
  • on a remote directory, execute a pre-command before each main command (ex: add GNU Tools for AIX in PATH) :
<log-access-config id="remote-ssh-logs" type="SSH" user="your-user" host="remote-aix" directory="/path/to/logs" pre-command="PATH='/opt/freeware/bin:$PATH'" />

HTTPD log access configurations

  • access to a remote directory accessible through a httpd server :
<log-access-config id="remote-httpd-logs" type="HTTPD" url="http://archive.apache.org/dist/tomcat/" />
  • access to a remote directory accessible through a httpd server using a proxy :
<log-access-config id="remote-httpd-logs" type="HTTPD" url="http://archive.apache.org/dist/tomcat/" proxy="proxy-host:proxy-port" />
  • access to a remote directory accessible through a httpd server, protected by login/password basic authentication :
<log-access-config id="remote-httpd-logs" type="HTTPD" url="http://archive.apache.org/dist/tomcat/" user="your-user" password="your-password" />

Advanced Options

  • forbidden.commands: customize the list of forbidden commands (default is: rm,rmdir,mv,kill,ssh,chmod,chown,vi)
  • filelist.maxcount: customize the maximum file count displayed in the file list screen (default is: 1000)
  • filelist.blockexternalpaths: customize if external paths are blocked in the file list screen (default is: false)
  • default.encoding: customize the default encoding used to read command output (default is: UTF-8). Possible values are ISO-8859-1 and UTF-8

You can customize advanced options using two ways :

  • system properties
  • jndi environment entries

Requirements

  • Java 8, 11, 17 or 21
  • JEE App Server compatible from Servlet API 3.1 to Servlet API 4.0, but not Servlet API 5.0 (Tomcat 8, Tomcat 9, but not Tomcat 10)

Change Log

Versions and Release Notes are listed in Releases page

Browser Compatibility

  • Firefox
  • Chrome
  • IE8+
  • Probably some others, but I have not tested

Behind the scene

Technologies behind LogNavigator :

  • Twitter Bootstrap 3
  • Datatables
  • jQuery
  • Spring MVC
  • Spring Security
  • sshj (for remote SSH connections)
  • linux commands (tail, tar, gzip, curl)

License

LogNavigator is released under version 2.0 of the Apache License.