streamtool lsrestartrecs

Usage

lsrestartrecs [-d,--domain-id <did>] [-i,--instance-id <instance>] [-j,--jobs <job-id>,...] [--jobnames <job-names>,...] [--resources <resourceId>,...] [--xheaders] [--fmt <format-spec>] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool lsrestartrecs command returns processing element (PE) restart recommendations for specific jobs or resources.

Authority

You must have search authority for the jobs instance object and read authority for the appropriate jobgroup_name instance object. By default, the DomainAdministrator and InstanceAdministrator roles have this authority. If the user who submits the job has the InstanceUser role, they also have this authority.

For more information about access control lists, see streamtool lsacl and streamtool lsjobpermission.

Description

When you submit a job, the application manager service selects the resource where each PE is placed, in accordance with any requirements specified by the stream processing application. The application manager service attempts to balance the processing load of the resources in the instance by taking into account their current load. The application manager service also provides PE restart recommendations for jobs. To make this decision in an intelligent manner, the application manager service collects and maintains models of resource usage for all the PEs in the instance.

The streamtool lsrestartrecs command prioritizes the PE restart recommendations and returns one of the following values for each PE:

  • preferred: The best candidate PEs to be restarted on other hosts in the instance. This is the strongest recommendation. There might be more than one recommendation in this category. In some cases, there might not be a recommendation that qualifies as preferred.
  • high: The current resource running the PE is overloaded and there is at least one candidate resource that is underloaded. This is a strong recommendation. There can be many recommendations in this category.
  • directed: The current resource is overloaded, but there is no alternate resources that are underloaded. This recommendation might be a good choice if you add new resources.
  • low: There are some candidate resources that have lighter loads than the current resource. If you select this recommendation, it might improve the results. However, the improvement is probably not as pronounced as those resulting from selecting a preferred or high recommendation.
  • none: Do not restart the PE now. The PE is not movable or there is no alternate resource that is less loaded.

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.

--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 job.
  • %Tf: Standard table format, which is the default. One line per job.
-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.

-j,--jobs <job-id>
Specifies a list of job IDs, which are delimited by commas.
--jobnames <job-names>
Specifies a list of job names, which are delimited by commas.
--resources <resourceId>
Specifies a list of resource identifiers, which vary depending on the resource manager. For example, they might be host names or IP addresses. The resource identifiers are delimited by commas.
--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.