[HBASE-10086] [book] document the HBase canary tool usage in the HBase Book

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 0.99.0
• Component/s: documentation
• Labels: docs
• Hadoop Flags: Reviewed
• Assignee: takeshi.miao
• Reporter: takeshi.miao
• Created: 05/Dec/13 06:18
• Updated: 21/Feb/15 23:32
• Resolved: 12/Dec/13 07:10

Description

Since the HBASE-7525 merged into trunk, which makes the canary tool a little bit hard to understand by users at first glance of it's usage. So I'd like to add some docs for it in HBase book.

I think that the section 15.1 may be the appropriate place to doc, I plan to doc the canary tool in item 15.1.16.

Issue Links

• is duplicated by: HBASE-8048 Delete or document Canary
• is related to: HBASE-7525 A canary monitoring program specifically for regionserver
• relates to: HBASE-8048 Delete or document Canary