streamtool displaype

Usage

displaype [-d,--domain-id <did>] [-i,--instance-id <instance>] [--access] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk] <pe-id>

The streamtool displaype command displays details about a specific processing element (PE), including the configuration settings currently being used by the PE.

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 getacl and streamtool lsjobpermission commands.

Options

--access
Specifies to return the information in an accessible output format.
-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.

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

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

Arguments

pe-id
Specifies the processing element ID.

Examples

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

[streamtool <bsmith@StreamsDomain.StreamsInstance] displaype 1 
PE settings:
   PE ID: 1
   Job ID: 1
   Job name: sample.CommodityPurchasing::SupplyAndPurchase_1
   Status: Running
   Status reason: None
   Health: Healthy
   Required connections: Connected
   Optional connections: Connected
   Host: host1.teracloud.com
   Process ID: 1422
   Host tags: 
   Movable: true
   Restartable: true
   Launch count: 1
   Tracing: error
   Operators: PurchaseSensorFeed, Purchases, PurchaseTransactions, AveragePurchaseWeatherScore, 
ConsumptionSensorFeed, CurrentStock, PurchaseAverage, AllPurchases, Stock
Ports:
   Input port ID: 3
     Input port 3 index: 0
     Input port 3 transport type: TCP
   Input port ID: 4
     Input port 4 index: 1
     Input port 4 transport type: TCP
   Input port ID: 5
     Input port 5 index: 2
     Input port 5 transport type: TCP
   Output port ID: 6
     Output port 6 index: 0
     Output port 6 transport type: TCP
   Output port ID: 7
     Output port 7 index: 1
     Output port 7 transport type: TCP