From 1476024285656628dd9dbbc2e38cd34a942b4440 Mon Sep 17 00:00:00 2001 From: Amnon Heiman Date: Sun, 17 May 2015 12:27:00 +0300 Subject: [PATCH] Adding the JMX README file The README file holds explnation on how to compile and run the JMX API. Signed-off-by: Amnon Heiman --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a8eabb --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# 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)