streamtool checkzk

Usage

checkzk [--xheaders] [--fmt <format-spec>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool checkzk command performs connectivity and performance checks for the given ZooKeeper connection string and displays information on the checks.

Authority

You do not need any authority to run this command.

Description

The streamtool checkzk command performs connectivity and performance checks for the given ZooKeeper connection string and displays information on the checks.

Because it is reading from and writing to the specified ZooKeeper, this command can take some time to run.

Options

--embeddedzk

Specifies to use the embedded copy of ZooKeeper. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify either this option or the --zkconnect option, Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. Streams determines which connection maps to the domain by using cached information about the domains. In this scenario, if the domain identifier is not unique in the Streams configuration cache, the command fails.

--fmt <format-spec>
Specifies the presentation format. The command supports the following values:
  • %Hf: "Hostspec" format. Each host and its tags are reported in the format that is defined by the streamtool mkinstance host file specification. One line per host.
  • %Mf: Multiline record format. One line per field.
  • %Nf: Name prefixed field table format. One line per host.
  • %Tf: Standard table format, which is the default. One line per host.
-h,--help
Specifies to show the command syntax.
--trace <level>
Specifies the trace setting. The following valid levels are listed in order of increasing verbosity, which is to say that the first level in the list generates the least amount of information:
  • off
  • error
  • warn
  • info
  • debug
  • trace
The default value is off.
-v,--verbose <level>
Specifies to provide more detailed command output. The verbosity level can be 0-3, where 0 disables detailed reporting and each increment provides more detailed output.
--xheaders
Specifies to exclude headings from the report.
--zkconnect <{<host>:<port>},...>

The name of one or more host and port pairs that specify the configured ZooKeeper servers. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify this option, Streams tries to use:

  1. The --embeddedzk option
  2. The value from the STREAMS_ZKCONNECT environment variable
  3. A ZooKeeper connection string that is derived from cached information about the current domain.