HBASE-19890 Canary usage should document hbase.canary.sink.class config
Project: http://git-wip-us.apache.org/repos/asf/hbase/repo Commit: http://git-wip-us.apache.org/repos/asf/hbase/commit/87ab7e71 Tree: http://git-wip-us.apache.org/repos/asf/hbase/tree/87ab7e71 Diff: http://git-wip-us.apache.org/repos/asf/hbase/diff/87ab7e71 Branch: refs/heads/HBASE-19064 Commit: 87ab7e712df4b9c9b24665488a69190310e747d9 Parents: 7abaf22 Author: Peter Somogyi <psomo...@apache.org> Authored: Tue Apr 3 10:44:29 2018 +0200 Committer: Peter Somogyi <psomo...@apache.org> Committed: Wed Apr 4 09:08:31 2018 +0200 ---------------------------------------------------------------------- src/main/asciidoc/_chapters/ops_mgt.adoc | 7 +++++++ 1 file changed, 7 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/hbase/blob/87ab7e71/src/main/asciidoc/_chapters/ops_mgt.adoc ---------------------------------------------------------------------- diff --git a/src/main/asciidoc/_chapters/ops_mgt.adoc b/src/main/asciidoc/_chapters/ops_mgt.adoc index 8d49ef8..ce327fa 100644 --- a/src/main/asciidoc/_chapters/ops_mgt.adoc +++ b/src/main/asciidoc/_chapters/ops_mgt.adoc @@ -108,6 +108,13 @@ Usage: hbase canary [opts] [table1 [table2]...] | [regionserver1 [regionserver2] -D<configProperty>=<value> assigning or override the configuration params ---- +[NOTE] +The `Sink` class is instantiated using the `hbase.canary.sink.class` configuration property which +will also determine the used Monitor class. In the absence of this property RegionServerStdOutSink +will be used. You need to use the Sink according to the passed parameters to the _canary_ command. +As an example you have to set `hbase.canary.sink.class` property to +`org.apache.hadoop.hbase.tool.Canary$RegionStdOutSink` for using table parameters. + This tool will return non zero error codes to user for collaborating with other monitoring tools, such as Nagios. The error code definitions are: