diff --git a/README.md b/README.md index 954c1e5..22bbdfd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,63 @@ -# remoraj -RemoraJ is java application monitoring tool. +# RemoraJ + +RemoraJ is java application monitoring tool. RemoraJ monitors your application performance by tracking common application building blocks and services services like HTTP, JMS, JDBC. + +# Installing + +You must set up Java agent and TNT4J-streams to run RemoraJ. Your should have working repository and token in JKoolCloud. + +## Java agent +## Using -javaagent option + +### IBM WebSphere + +Option 1: using IBM WebSphere console. + +* Step 1 Navigate to Application servers > [Your server name] > Process definition > Java Virtual Machine +* Step 2 Edit field "Generic JVM arguments" +* Step 3 Add -javaagent:[c:\remora]\remora.jar=[c:\remora] +* Step 4 Restart IBM websphere +* Step 5 Run and configure TNT4J streams + +Option 2: editing server.xml properties manually + +* Step 1 Navigate to `c:\Users\\IBM\WebSphere\\profiles\\config\cells\\nodes\\servers\\server.xml` +* Step 2 Edit node `/process:Server/processDefinitions/jvmEntries` paramter `@genericJvmArguments` +* Step 3 Edit the path to where your remora.jar situated +``` + + +``` + +### JBoss application server + +#### Standalone version + +* Step 1 Edit `bin\standalone.bat` +* Step 2 Add line +```set "JAVA_OPTS=%JAVA_OPTS% -javaagent:c:\remora\remora-0.1-SNAPSHOT\remora.jar=c:\remora\remora-0.1-SNAPSHOT\"``` +* Step 3 Edit the path to where your remora.jar situated + + + +## TNT4J streams + +* Step 1 Go to tnt4j streams config +* Step 2 Edit `tnt4j-streams.properties` and setup your access Token (`event.sink.factory.EventSinkFactory.prod.Token`) +* Step 3 (Optional) Edit tnt `remora-0.1-SNAPSHOT\tnt4j-streams\remora-streamer\tnt-data-source.xml` +* Step 4 (Optional) Setup line `````` to point to your RemoraJ queue directory. + + +# Configuration + +The configuration file is ir your remora dir under `config` folder, file named remora.properties. +See relevant comments in file for advanced config. + +# Running + +Once the agent atached and TNT4J-Streams configured you can +Run remoraJ\tnt4j-streams\remora-streamer\run.bat(run.sh). + + diff --git a/remora-jboss/README.md b/remora-jboss/README.md index 66ac4e8..e69de29 100644 --- a/remora-jboss/README.md +++ b/remora-jboss/README.md @@ -1,57 +0,0 @@ -# RemoraJ - -RemoraJ is java application monitoring tool. RemoraJ monitors your application performance by tracking common application building blocks and services services like HTTP, JMS, JDBC. - -# Installing - -You must set up Java agent and TNT4J-streams to run RemoraJ. Your should have working repository and token in JKoolCloud. - -## Java agent -## Using -javaagent option - -### IBM WebSphere - -Option 1: using IBM WebSphere console. - -* Step 1 Navigate to Application servers > [Your server name] > Process definition > Java Virtual Machine -* Step 2 Edit field "Generic JVM arguments" -* Step 3 Add -javaagent:[c:\remora]\remora.jar=[c:\remora] -* Step 4 Restart IBM websphere -* Step 5 Run and configure TNT4J streams - -Option 2: editing server.xml properties manually - -* Step 1 Navigate to c:\Users\\IBM\WebSphere\\profiles\\config\cells\\nodes\\servers\\server.xml -* Step 2 Edit node /process:Server/processDefinitions/jvmEntries paramter @genericJvmArguments -* Step 3 Edit the path to where your remora.jar situated -``` - - -``` - -### JBoss application server - -#### Standalone version - -* Step 1 Edit bin\standalone.bat -* Step 2 Add line -```set "JAVA_OPTS=%JAVA_OPTS% -javaagent:c:\remora\remora-0.1-SNAPSHOT\remora.jar=c:\remora\remora-0.1-SNAPSHOT\"``` -* Step 3 Edit the path to where your remora.jar situated - - - -## TNT4J streams - -* Step 1 Go to tnt4j streams config -* Step 2 Edit tnt4j.properties and setup your access Token -* Step 3 Edit tnt tnt4j-streams\samples\probe-streamer\tnt-data-source.xml -* Step 4 Setup line `````` to point to your RemoraJ queue directory. - - -# Configuration - -The configuration file is ir your remora dir under `config` folder, file named remora.properties. -See relevant comments in file for advanced config. - - -