streamtool lspes

Usage

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

The streamtool lspes command lists the processing elements (PEs) in the instance.

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

The command reports a health summary for each PE. A healthy PE is one where the PE state is Running and all the required and optional connections to other PEs are currently connected. Otherwise, the command reports that the PE is not healthy. For more information about PE health, see the streamtool capturestate command or the Streams Console.

The command also reports the status of each PE. For more information about processing element status values and reason codes, see the Streams product documentation.

By default, the command reports short host names and only the first of the operator instance names for the PEs. If the PE has more than one operator, the command output includes ,... after the operator name. You can use the -l, --long option to report full host names and all of the operator instance names for PEs.

When a cancel request for a job is processed, streamtool lspes no longer reports the job or its PEs.

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 processing element.
  • %Tf: Standard table format, which is the default. One line per processing element.
-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.
-l,--long
Reports launch count, full host names, and all of the operator instance names for the PEs.
--pes <pe-id>
Specifies a list of processing elements (PEs).
--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.
--showtimestamp
Specifies to show a time stamp in the output to indicate when the command was run.
--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.

Examples

The following example demonstrates the type of information that you see when you run the streamtool lspes command:

[streamtool <bsmith@StreamsDomain.StreamsInstance] lspes --fmt %Mf
=================================================
Instance: StreamsInstance
=================================================
Id                      : 0
State                   : Running
RC                      : -
Healthy                 : yes
Resource                : host6
PID                     : 1349
JobId                   : 0
JobName                 : sample.CommodityPurchasing::AutomatedBuyer_0
Operators               : TopSupplierAndCurrentSupply,...
=================================================
Id                      : 1
State                   : Running
RC                      : -
Healthy                 : yes
Resource                : host6
PID                     : 1422
JobId                   : 1
JobName                 : sample.CommodityPurchasing::SupplyAndPurchase_1
Operators               : PurchaseSensorFeed,...
=================================================
...