tangentum technologies    
 

Deutsch

   
   
 
   

Installation Guide

Installation Guide


This document describes the necessary steps to get CodeMonitorTM for Java up and running.

Download Software and License

You may download CodeMonitorTM for Java from tangentum technologies' website. The software is distributed as one single packed distribution file, which contains the software, the documentation, and some example files. The distribution file is a normal archive.

There is no obscure installation program (we have thrown it away), because we like to make CodeMonitor as transparent as possible to you, to make it usable even in environments with high security requirements.

The software is therefore installable without any special preconditions, but will refuse it's work without a valid license file. If you haven't already done so, you can get an evaluation license or a commercial license from tangentum technologies' website.

Install Software and License

If you've unpacked the distribution file as described on the download page, a directory codemonitor-x.y.z was created. This is the home-directory of the CodeMonitor installation.

We recommend to copy the license file that you received by email into this home-directory. If you like to store it elsewhere, you must specify its location by defining the system property codemonitor.license on the command-line when starting CodeMonitor. Note that the license file may be stored centrally and referred to by any valid URL (Uniform Resource Locator).

Now your copy of CodeMonitorTM for Java should be installed.

Setting up a first configuration file for an application

Besides a valid license file, CodeMonitorTM for Java needs a configuration file with the specification, what, where, when, and how to log. These configuration files have the name codemonitor.config by default and are located in the current directory, i.e. the directory from which CodeMonitor is invoked.

If you like, you can specify any other location of the configuration file by defining the system property codemonitor.config on the command-line when starting CodeMonitor. This can be a valid name of a local file-system or any valid URL.

A first simple configuration file is provided in the directory examples/HelloWorld in the home-directory of your CodeMonitor installation. Please consult this file for the first test of CodeMonitor.

Testing the installation

You may test the installation of CodeMonitorTM for Java by monitoring a simple “HelloWorld” example.

On Unix please open a shell and switch to the directory examples/HelloWorld in the home-directory of your CodeMonitor installation. Then execute java -cp ../../lib/codemonitor.jar:. com.tangentum.CodeMonitor HelloWorld.

Under Windows please open a command-line interpreter and switch to the directory examples\HelloWorld in the home-directory of your CodeMonitor installation. Then execute java -cp ..\..\lib\codemonitor.jar;. com.tangentum.CodeMonitor HelloWorld.

In both cases it will take some time to start up the Java VM and to load all classes of CodeMonitor, but then you should get an output like the following:

ENTRY HelloWorld.main(...)
Hello World!
EXIT HelloWorld.main

If you get this, CodeMonitorTM for Java is correctly installed.

If you don't see an output like this, please set the property codemonitor.verbose on the command line. On Unix please execute java -cp ../../lib/codemonitor.jar:. -Dcodemonitor.verbose com.tangentum.CodeMonitor HelloWorld, and under Windows java -cp ..\..\lib\codemonitor.jar;. -Dcodemonitor.verbose com.tangentum.CodeMonitor HelloWorld to log CodeMonitor's own activities on stderr. From the additional output you may see, whether the license file or the configuration file wasn't found, or any other kind of error occured.

Understanding the first generated logging output

As you can see from the first line of the output, the execution entered the method HelloWorld.main with some parameters, which are not explicitly dumped.

Then the message “Hello World!” is printed by the application.

On the last line of the output, the execution left the method HelloWorld.main.