streamtool checkinstancemetrics

Usage

checkinstancemetrics [-d,--domain-id <did>] [-i,--instance-id <instance>] [-l,--long] [--fmt <format-spec>] [-f,--file <file-name>] [--services <service>,...] [--xheaders] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool checkinstancemetrics command checks and displays metrics that are used for monitoring, performance tuning, and debugging for resources that are active for the instance.

Authority

You must have read authority for the instance domain object. By default, the InstanceAdministrator and InstanceUser roles have this authority. For more information about access control lists, see streamtool getdomainacl.

Description

The metrics that are displayed as a result of this command can be filtered by instance services. If no instance services are specified, the metrics for all the instance services are displayed. The instance must be active.

Metrics that are displayed by default are defined in the default template file install-dir/version/etc/cfg/checkMetricsTemplate.json. If you want to make changes to this template file, copy it to a new location. You can affect which metrics are displayed by setting the include element for the metric. You can modify the attributes of the metric to indicate which metrics to check and provide threshold values to check against. After you update the file, specify the file in the new location on the command by using the --file parameter.

Threshold values can be set for the metrics to give a warning if the value is above the limit that is specified in the template. The values are flagged with ** if they do not meet the thresholds that are established in the template file. Some metrics are specific for the instance name. If you want to show these metrics, update the @@instance-name@@ value to the name of the instance.

The data that is time related is shown in milliseconds.

Options

-d,--domain-id <did>
Specifies the domain identifier.

If you do not specify this option, Streams uses the domain name that is set in the STREAMS_DOMAIN_ID environment variable. By default, that domain name is StreamsDomain. If you are using the interactive streamtool interface, it uses the name of the active domain for the current streamtool session or else it prompts you for the domain name.

The active domain for the current streamtool session is set every time that you successfully run a streamtool command with a -d or --domain-id option. Alternatively, you can run the streamtool domain command in the interactive interface.

--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.

-f,--file <file-name>
Specifies the file path to a customized version of the checkMetricsTemplate.json file that controls which metrics are checked and displayed.
--fmt <format-spec>
Specifies the presentation format. The command supports the following values:
  • %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.
-i,--instance-id <instance>
Specifies the instance identifier.

If you do not specify this option, Streams uses the instance identifier that is set in the STREAMS_INSTANCE_ID environment variable. By default, that instance identifier is StreamsInstance. If you are using the interactive streamtool interface, it tries to use an instance ID that you specified in a previous command. If no such value is found, the command uses the STREAMS_INSTANCE_ID environment variable. Alternatively, you can run the streamtool instance command in the interactive interface.

-l,--long
Reports host names and resource IDs when an external resource manager is used.
--services <service>
Specifies to check and display the metrics for the specified services. If you do not specify a value for this option, all services are checked and displayed. The following instance service names are valid:
  • app
  • sam
  • srm
  • view
--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.
-U,--User <user>
Specifies an Streams user ID that has authority to run the command.
-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.