diff --git a/ghpages.sh b/ghpages.sh new file mode 100644 index 000000000..919057572 --- /dev/null +++ b/ghpages.sh @@ -0,0 +1,46 @@ +#!/bin/bash -x + +git remote set-url --push origin `git config remote.origin.url | sed -e 's/^git:/https:/'` + +if ! (git remote set-branches --add origin gh-pages && git fetch -q); then + echo "No gh-pages, so not syncing" + exit 0 +fi + +if ! [ -d docs/target/generated-docs ]; then + echo "No gh-pages sources in docs/target/generated-docs, so not syncing" + exit 0 +fi + +# Stash any outstanding changes +################################################################### +git diff-index --quiet HEAD +dirty=$? +if [ "$dirty" != "0" ]; then git stash; fi + +# Switch to gh-pages branch to sync it with master +################################################################### +git checkout gh-pages + +for f in docs/target/generated-docs/*; do + file=${f#docs/target/generated-docs/*} + if ! git ls-files -i -o --exclude-standard --directory | grep -q ^$file$; then + # Not ignored... + cp -rf $f . + git add -A $file + fi +done + +git commit -a -m "Sync docs from master to gh-pages" + +# Uncomment the following push if you want to auto push to +# the gh-pages branch whenever you commit to master locally. +# This is a little extreme. Use with care! +################################################################### +git push origin gh-pages + +# Finally, switch back to the master branch and exit block +git checkout master +if [ "$dirty" != "0" ]; then git stash pop; fi + +exit 0 diff --git a/images/.gitkeep b/images/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/images/zipkin-trace-screenshot.png b/images/zipkin-trace-screenshot.png new file mode 100644 index 000000000..a0ce3ea91 Binary files /dev/null and b/images/zipkin-trace-screenshot.png differ diff --git a/spring-cloud-sleuth.html b/spring-cloud-sleuth.html new file mode 100644 index 000000000..8eca5618d --- /dev/null +++ b/spring-cloud-sleuth.html @@ -0,0 +1,453 @@ + + + + + + + +Spring Cloud Sleuth + + + + + +
+
+

Spring Cloud Sleuth

+
+
+

Spring Cloud Sleuth implements a distributed tracing solution for Spring Cloud.

+
+
+

Terminology

+
+

Spring Cloud Sleuth borrows Dapper’s terminology.

+
+
+

Span: The basic unit of work. For example, sending an RPC is a new span, as is sending a response to an RPC. Span’s are identified by a unique 64-bit ID for the span and another 64-bit ID for the trace the span is a part of. Spans also have other data, such as descriptions, key-value annotations, the ID of the span that caused them, and process ID’s (normally IP address).

+
+
+

Spans are started and stopped, and they keep track of their timing information. Once you create a span, you must stop it at some point in the future.

+
+
+

Trace: A set of spans forming a tree-like structure. For example, if you are running a distributed big-data store, a trace might be formed by a put request.

+
+
+
+
+
+

TODO: Document Spring Cloud Sleuth

+
+ +
+
+
+ + + \ No newline at end of file