diff --git a/BUILDING.txt b/BUILDING.txt index d8314b0..e1bf0e9 100644 --- a/BUILDING.txt +++ b/BUILDING.txt @@ -1,21 +1,25 @@ -On Building HTrace +Building HTrace +=============== -Requires the go programming language, version 1.3 or higher. See -htrace-core/src/go/BUILDING.txt for more information. +Building HTrace requires -Requires Java 1.6 at least. +* Java 1.7 at least. +* Apache Maven 3.x. +* Go programming language, version 1.3 or higher (for htrace-htraced) +* The development package for leveldb (for htrace-htraced) -Requires maven 3.x. +After installing dependencies, to build, run: -After installing go, to build, run: - - $ mvn install + $ mvn install To build a tarball, do: - $ mvn clean install -DskipTests assembly:single -Pdist + $ mvn clean install -DskipTests assembly:single -Pdist This will build a tarball into ./target. To skip the rat-check -- it can take a while -- pass a -Drat.skip on the mvn command-line. + + +See htrace-htraced/BUILDING.txt for more information to build htrace-htraced. diff --git a/htrace-htraced/BUILDING.txt b/htrace-htraced/BUILDING.txt new file mode 100644 index 0000000..fb493a4 --- /dev/null +++ b/htrace-htraced/BUILDING.txt @@ -0,0 +1,30 @@ +Building the HTrace Go code +=========================== +The htrace go code consists of 4 main parts: +* The "htraced" standalone server + This is a server which accepts trace spans, and services REST queries. + +* The "htrace" command-line program which can query the server + This is a simple command-line program which can query the htrace server. + +* The htraced Javascript Web UI (not yet implemented) + +* The htrace go client library (not yet implemented) + This is the equivalent of the Java HTrace client library, but written in Go. + +You can build all these parts simply by running "gobuild.sh". +The binaries will be created in bin/. + +Dependencies +============ +You will need to install: +* The Go programming language +* The development package for leveldb (some Linux distros call this "leveldb-devel") containing libleveldb.so + +htraced requires libleveldb.so to be in your shared library path in order to run. +You can set LD_LIBRARY_PATH to the path for this library, or simply install +libleveldb.so to your system library path. + +Testing +======= +You can run the unit tests by running "src/go/gobuild.sh test" diff --git a/htrace-htraced/src/go/BUILDING.txt b/htrace-htraced/src/go/BUILDING.txt deleted file mode 100644 index d54d410..0000000 --- a/htrace-htraced/src/go/BUILDING.txt +++ /dev/null @@ -1,30 +0,0 @@ -Building the HTrace Go code -=========================== -The htrace go code consists of 4 main parts: -* The "htraced" standalone server - This is a server which accepts trace spans, and services REST queries. - -* The "htrace" command-line program which can query the server - This is a simple command-line program which can query the htrace server. - -* The htraced Javascript Web UI (not yet implemented) - -* The htrace go client library (not yet implemented) - This is the equivalent of the Java HTrace client library, but written in Go. - -You can build all these parts simply by running "gobuild.sh". -The binaries will be created in bin/. - -Dependencies -============ -You will need to install: -* The Go programming language -* The development package for leveldb (some Linux distros call this "leveldb-devel") containing libleveldb.so - -htraced requires libleveldb.so to be in your shared library path in order to run. -You can set LD_LIBRARY_PATH to the path for this library, or simply install -libleveldb.so to your system library path. - -Testing -======= -You can run the unit tests by running "./gobuild.sh test"