Skip to content

Commit

Permalink
move README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mjok committed Nov 4, 2019
1 parent b89752c commit b8bb69a
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 59 deletions.
63 changes: 61 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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\<USER_DIR>\IBM\WebSphere\<Server>\profiles\<App Server>\config\cells\<Cell>\nodes\<Node>\servers\<Server>\server.xml`
* Step 2 Edit node `/process:Server/processDefinitions/jvmEntries` paramter `@genericJvmArguments`
* Step 3 Edit the path to where your remora.jar situated
```
<jvmEntries xmi:id="JavaVirtualMachine_1183122130078" verboseModeClass="false" verboseModeGarbageCollection="false" verboseModeJNI="false" initialHeapSize="512" maximumHeapSize="2056" runHProf="false" hprofArguments="" genericJvmArguments="-javaagent:c:\remora\remora-0.1-SNAPSHOT\remora.jar=c:\remora\remora-0.1-SNAPSHOT\" executableJarFileName="" disableJIT="false">
```

### 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 ```<property name="FileName" value="..\..\queue"/>``` 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).



57 changes: 0 additions & 57 deletions remora-jboss/README.md
Original file line number Diff line number Diff line change
@@ -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\<USER_DIR>\IBM\WebSphere\<Server>\profiles\<App Server>\config\cells\<Cell>\nodes\<Node>\servers\<Server>\server.xml
* Step 2 Edit node /process:Server/processDefinitions/jvmEntries paramter @genericJvmArguments
* Step 3 Edit the path to where your remora.jar situated
```
<jvmEntries xmi:id="JavaVirtualMachine_1183122130078" verboseModeClass="false" verboseModeGarbageCollection="false" verboseModeJNI="false" initialHeapSize="512" maximumHeapSize="2056" runHProf="false" hprofArguments="" genericJvmArguments="-javaagent:c:\remora\remora-0.1-SNAPSHOT\remora.jar=c:\remora\remora-0.1-SNAPSHOT\" executableJarFileName="" disableJIT="false">
```

### 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 ```<property name="FileName" value="c:\remora\remora-0.1-SNAPSHOT\queue\"/>``` 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.



0 comments on commit b8bb69a

Please # to comment.