Home

Welcome to Remote Log Monitor wiki!

This page will show how Remote Log Monitor works and how to configure it. The configuration of this web application is simple, you just need to follow the steps shown in here and you will be running it in no time.

Pre-requisites

Remote Log Monitor is a Java application, it was written using Java 8, so in order to run it you need to have JDK8 or above installed in your machine.
This can be found at: http://www.oracle.com/technetwork/java/javase/downloads/index.html.

Installation

Once you have JDK8 installed in your machine you can proceed installing remote-log-monitor.

To install it just uncompress the tarball remote-log-monitor.tar.gz to the destination folder.
tar zxvf remote-log-monitor.tar.gz

It will create a folder called remote-log-monitor.

Inside you will find
- README.txt - This file
- config
---- application.yml -> File containing all configuration for this app. THIS FILE HAS TO BE CONFIGURED BEFORE RUNNING.
---- logback-conf.xml -> Configuration for logging, only need to change if you want to application logs differently than default.
- logs - This folder will contain application logs
- remote-log-monitor-0.0.3.jar - War file containing application itself
- remote-log-monitor.jar - Link pointing to the war file. The link was create to abstract version upgrades
- start.sh - Script to start application
- stop.sh - Script to stop application

Configuration:

In the start.sh you can uncomment and adjust the lines to configure JAVA_HOME:

#Configuration for JDK8 path, if it's the default in your system there is not need to change
export JAVA_HOME=<<JAVA FOLDER>>
export PATH=$JAVA_HOME/bin:$PATH

All other the configuration is done in the file config/application.yml

As default the port used by the application is 8080. This can be changed at:

server:
  port:<<DESIRED PORT>>

All the files that can be tailed needs to be added in the configuration as shown

monitor:
  files:
    Sample: /tmp/test.log
    Log2: /etc/log/log2.log

The application uses a single user to authenticate, this user can be configured as shown below. Yuo can change name and password but leave role as ADMIN.

security:
  user:
    name: "admin"
    password: "!admin"
    role: ADMIN

Running:

To start the server just execute:
$ ./start.sh

You can check if the server was started properly looking at the file logs/init.log

To stop the server you can execute:
$ ./stop.sh

After the server is started you can execute in the Browser: http://<<YOUR_SERVER_IP>>:<<PORT>>
this will open the Web Interface for tailing the logs.