HBASE-20348 Add HTrace to upgrade notes
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/8adf1bb2 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/8adf1bb2 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/8adf1bb2 Branch: refs/heads/master Commit: 8adf1bb2b478cb79fc709ece6325c20b673c7e41 Parents: e2b0490 Author: Mike Drob <md...@apache.org> Authored: Wed Apr 4 12:23:55 2018 -0700 Committer: Mike Drob <md...@apache.org> Committed: Thu Apr 5 10:13:23 2018 -0700 ---------------------------------------------------------------------- src/main/asciidoc/_chapters/tracing.adoc | 6 ++++-- src/main/asciidoc/_chapters/upgrading.adoc | 8 ++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/8adf1bb2/src/main/asciidoc/_chapters/tracing.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/tracing.adoc b/src/main/asciidoc/_chapters/tracing.adoc index 8bd1962..7305aa8 100644 --- a/src/main/asciidoc/_chapters/tracing.adoc +++ b/src/main/asciidoc/_chapters/tracing.adoc @@ -30,8 +30,10 @@ :icons: font :experimental: -link:https://issues.apache.org/jira/browse/HBASE-6449[HBASE-6449] added support for tracing requests through HBase, using the open source tracing library, link:https://htrace.incubator.apache.org/[HTrace]. -Setting up tracing is quite simple, however it currently requires some very minor changes to your client code (it would not be very difficult to remove this requirement). +HBase includes facilities for tracing requests using the open source tracing library, link:https://htrace.incubator.apache.org/[Apache HTrace]. +Setting up tracing is quite simple, however it currently requires some very minor changes to your client code (this requirement may be removed in the future). + +Support for this feature using HTrace 3 in HBase was added in link:https://issues.apache.org/jira/browse/HBASE-6449[HBASE-6449]. Starting with HBase 2.0, there was a non-compatible update to HTrace 4 via link:https://issues.apache.org/jira/browse/HBASE-18601[HBASE-18601]. The examples provided in this section will be using HTrace 4 package names, syntax, and conventions. For older examples, please consult previous versions of this guide. [[tracing.spanreceivers]] === SpanReceivers http://git-wip-us.apache.org/repos/asf/hbase/blob/8adf1bb2/src/main/asciidoc/_chapters/upgrading.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/upgrading.adoc b/src/main/asciidoc/_chapters/upgrading.adoc index f5cdff3..31589d7 100644 --- a/src/main/asciidoc/_chapters/upgrading.adoc +++ b/src/main/asciidoc/_chapters/upgrading.adoc @@ -543,6 +543,14 @@ A number of internal dependencies for HBase were updated or removed from the run .Multiple breaking changes to source and binary compatibility for client API The Java client API for HBase has a number of changes that break both source and binary compatibility for details see the Compatibility Check Report for the release you'll be upgrading to. +[[upgrade2.0.tracing]] +.Tracing implementation changes +The backing implementation of HBase's tracing features was updated from Apache HTrace 3 to HTrace 4, which includes several breaking changes. While HTrace 3 and 4 can coexist in the same runtime, they will not integrate with each other, leading to disjoint trace information. + +The internal changes to HBase during this upgrade were sufficient for compilation, but it has not been confirmed that there are no regressions in tracing functionality. Please consider this feature expiremental for the immediate future. + +If you previously relied on client side tracing integrated with HBase operations, it is recommended that you upgrade your usage to HTrace 4 as well. + //// This would be a good place to link to an appendix on migrating applications ////
