From 34744096e4f60141f634793cb5e866fed4584d9f Mon Sep 17 00:00:00 2001 From: Peter Somogyi Date: Thu, 29 Mar 2018 13:18:17 +0200 Subject: [PATCH] HBASE-20313 Canary documentation is incorrect in reference guide --- src/main/asciidoc/_chapters/ops_mgt.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/main/asciidoc/_chapters/ops_mgt.adoc b/src/main/asciidoc/_chapters/ops_mgt.adoc index 928c37744e..3a979f35ec 100644 --- a/src/main/asciidoc/_chapters/ops_mgt.adoc +++ b/src/main/asciidoc/_chapters/ops_mgt.adoc @@ -78,7 +78,7 @@ Others, such as `hbase shell` (<>), `hbase upgrade` (<>), and === Canary There is a Canary class can help users to canary-test the HBase cluster status, with every column-family for every regions or RegionServer's granularity. -To see the usage, use the `--help` parameter. +To see the usage, use the `-help` parameter. ---- $ ${HBASE_HOME}/bin/hbase canary -help @@ -191,10 +191,10 @@ This daemon will stop itself and return non-zero error code if any error occurs, $ ${HBASE_HOME}/bin/hbase canary -daemon ---- -Run repeatedly with internal 5 seconds and will not stop itself even if errors occur in the test. +Run repeatedly with 5 second intervals and will not stop itself even if errors occur in the test. ---- -$ ${HBASE_HOME}/bin/hbase canary -daemon -interval 50000 -f false +$ ${HBASE_HOME}/bin/hbase canary -daemon -interval 5 -f false ---- ==== Force timeout if canary test stuck @@ -204,7 +204,7 @@ Because of this we provide a timeout option to kill the canary test and return a This run sets the timeout value to 60 seconds, the default value is 600 seconds. ---- -$ ${HBASE_HOME}/bin/hbase canary -t 600000 +$ ${HBASE_HOME}/bin/hbase canary -t 60000 ---- ==== Enable write sniffing in canary @@ -233,7 +233,7 @@ while returning normal exit code. To treat read / write failure as error, you ca with the `-treatFailureAsError` option. When enabled, read / write failure would result in error exit code. ---- -$ ${HBASE_HOME}/bin/hbase canary --treatFailureAsError +$ ${HBASE_HOME}/bin/hbase canary -treatFailureAsError ---- ==== Running Canary in a Kerberos-enabled Cluster @@ -265,7 +265,7 @@ This example shows each of the properties with valid values. /etc/hbase/conf/keytab.krb5 -property> + hbase.client.dns.interface default -- 2.16.2