HBASE-19890 Canary usage should document hbase.canary.sink.class config

This commit is contained in:
Peter Somogyi 2018-04-03 10:44:29 +02:00
parent 7abaf22a12
commit 87ab7e712d
1 changed files with 7 additions and 0 deletions

View File

@ -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: