streamtool getapplicationlog

Usage

getapplicationlog [-d,--domain-id <did>] [-i,--instance-id <instance>] [-j,--jobs <job-id>,...] [--jobnames <job-names>,...] [--pes <pe-id>,...] [--resources <resourceId>,...] [-f,--file <file-name>] [--collection-directory <collection-directory>] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool getapplicationlog command retrieves the trace files for stream processing applications.

Authority

You must have read authority for the application-log instance object and read authority for the jobgroup_name instance object. By default, the DomainAdministrator and InstanceAdministrator roles have this authority. If the user who submits a job has the InstanceUser role, they also have this authority. For more information about access control lists, see streamtool getacl.

Description

Applications have two types of trace files:

  • A rolling component trace
  • A rolling console trace that captures the stdout and stderr messages

By default, the streamtool getapplicationlog command saves the trace data in the StreamsLogs.tgz file. To specify a different file name, use the --file option.

Options

--collection-directory <collection-directory>
Specifies the directory that is used for storing temporary copies of intermediate log collection results. If you do not specify this command option, the domain log path is used for temporary storage.
-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 that the command uses to store the compressed tar file output. By default, the following file is created in the current working directory: StreamsLogs.tgz.
-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.
--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.
--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.