scylla-jmx/README.md
Amnon Heiman 1476024285 Adding the JMX README file
The README file holds explnation on how to compile and run the JMX
API.

Signed-off-by: Amnon Heiman <amnon@cloudius-systems.com>
2015-05-17 12:58:59 +03:00

23 lines
574 B
Markdown

# Urchin JMX Interface
This is the JMX interface for urchin.
## Compile
To compile do:
```
mvn install
```
## Run
The maven will copy relevant jars to your local directory and would
set the classpath accordingly.
```
java -jar target/urchin-mbean-1.0.jar
```
## Setting IP and Port
By default the the JMX would connect to a node on the localhost
on port 10000.
The jmx API uses the system properties to set the IP address and Port.
To change the ip address use the apiaddress property (e.g. -Dapiaddress=1.1.1.1)
To change the port use the apiport (e.g. -Dapiport=10001)