Edit of the htrace-hbase README
diff --git a/htrace-hbase/README.md b/htrace-hbase/README.md
index b7aad96..a2e4ca6 100644
--- a/htrace-hbase/README.md
+++ b/htrace-hbase/README.md
@@ -2,57 +2,62 @@
============
htrace-hbase provides the span receiver which sends tracing spans to HBase
-and the viewer which retrieves spans from HBase and show them graphically.
+and a viewer which retrieves spans from HBase and displays them graphically.
Tutorial
--------
-We are using the same HBase instance running in standalone-mode as a tracee
-and storage of tracing spans at the same time in this example.
+In the example below, we use the same HBase instance running in standalone-mode
+as both tracee and storage for the tracing spans.
-At first, get HBase and build it.:
+First, get HBase and build it:
$ git clone https://github.com/apache/hbase
$ cd hbase
$ mvn package -DskipTests
-Putting jar of hbase-htrace on the classpath of HBase.:
+Build htrace-hbase (by building all of htrace... just takes a second):
- $ mkdir lib
- $ cp path/to/htrace/htrace-hbase/target/htrace-hbase-3.0.4.jar lib/
+ $ git clone git@github.com:cloudera/htrace.git
+ $ cd htrace.git
+ $ mvn install
-Adding configuration for span receiver to hbase-site.xml.:
+This will add the htrace jars including htrace-hbase to your local
+maven repository.
+
+Add a configuration that sets HBase as span receiver in hbase-site.xml:
<property>
<name>hbase.trace.spanreceiver.classes</name>
<value>org.htrace.impl.HBaseSpanReceiver</value>
</property>
-Starting HBase server in standalone-mode.:
+Starting HBase server in standalone-mode with htrace-hbase jar added
+to the CLASSPATH.
- $ bin/hbase master start
+ $ HBASE_CLASSPATH=$HOME/.m2/repository/org/htrace/htrace-hbase/3.0.4/htrace-hbase-3.0.4.jar $HBASE_HOME/bin/hbase master start
-Running HBase shell from another terminal,
-adding the table in which tracing spans stored.
-It uses the table named "htrace" with two column families "s" and "i" by default.:
+Running HBase shell from another terminal, add the table in which
+tracing spans are stored. By default it uses the table named
+"htrace" with two column families "s" and "i" by default:
hbase(main):001:0> create 'htrace', 's', 'i'
-Run some tracing from hbase shell.:
+Run some tracing from hbase shell:
hbase(main):002:0> trace 'start'; create 't1', 'f'; trace 'stop'
...
hbase(main):003:0> trace 'start'; put 't1', 'r1', 'f:c1', 'value'; trace 'stop'
...
-Running the main class of receiver also generate simple trace for test.:
+Running the main class of receiver also generate a simple, artificial trace for test:
$ bin/hbase org.htrace.impl.HBaseSpanReceiver
Starting viewer process which listens 0.0.0.0:16900 by default.:
- $ bin/hbase org.htrace.viewer.HBaseSpanViewerServer
+ $ HBASE_CLASSPATH=/Users/stack/.m2/repository/org/htrace/htrace-hbase/3.0.4/htrace-hbase-3.0.4.jar ./bin/hbase org.htrace.viewer.HBaseSpanViewerServer
Accessing http://host:16900/ with Web browser shows you list of traces like below.:
@@ -62,13 +67,12 @@
-
Receiver Configuration
----------------------
Configurations for span receiver running in HBase
to connect to the HBase to which spans are sent.
-These are different from the properties of usual HBase client.:
+These are different from the properties of usual HBase client:
<property>
<name>hbase.htrace.hbase.collector-quorum</name>
@@ -100,14 +104,14 @@
</property>
Notice that these configurations are prefixed by `hbase.`
-because the tracee is assumed to be HBase here.
+because the tracee are assumed to be HBase here.
Viewer Configuration
--------------------
You can set listen address of span viewer server by `htrace.viewer.http.address`.
-In addition, span viewer server uses
+In addition, span viewer server uses
- usual HBase client configuration to connect to HBase and
- receiver's configuration properties without prefix
to specify the name of table and column families.
