From 87ab7e712df4b9c9b24665488a69190310e747d9 Mon Sep 17 00:00:00 2001 From: Peter Somogyi Date: Tue, 3 Apr 2018 10:44:29 +0200 Subject: [PATCH] HBASE-19890 Canary usage should document hbase.canary.sink.class config --- src/main/asciidoc/_chapters/ops_mgt.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/main/asciidoc/_chapters/ops_mgt.adoc b/src/main/asciidoc/_chapters/ops_mgt.adoc index 8d49ef89b07..ce327fa1b79 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= 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: