streamtool getapplicationlog
The streamtool getapplicationlog command retrieves the trace files for streams processing applications.
Usage
getapplicationlog >>-+-----------------------------------------------+------------> '- --collection-directory--collection-directory-' >--+-----------------------+--+------------------------+--------> '-+- -d----------+--did-' '-+- -f-----+--file-name-' '- --domain-id-' '- --file-' >--+---------+--+-------------------------+---------------------> +- -h-----+ '-+- -i------------+--iid-' '- --help-' '- --instance-id-' >--+-------------------------+--+---------------------------+---> | .-,------. | | .-,--------. | | V | | | V | | '-+- -j-----+----job-id-+-' '- --jobnames----job-name-+-' '- --jobs-' >--+--------------------+--+------------------------------+-----> | .-,------. | | .-,----------. | | V | | | V | | '- --pes----pes-id-+-' '- --resources----resourceId-+-' >--+-----------------+--+---------------------+-----------------> '- --trace--level-' '-+- -U-----+--userid-' '- --User-' >--+-----------------------+------------------------------------> '-+- -v--------+--level-' '- --verbose-' >--| Non-interactive tool options |--object-------------------->< Non-interactive tool options (1) |--------+-----------------------------+------------------------| +- --embeddedzk---------------+ | .-,---------. | | V | | '- --zkconnect----host:port-+-'
- The non-interactive tool options are not supported in the interactive streamtool interface.
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
- 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 and arguments
- --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, IBM® 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, IBM Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. IBM 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 IBM 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 iid
Specifies the instance identifier.
If you do not specify this option, IBM 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.
- --jobnames job-name
Specifies a list of job names, which are delimited by commas.
- -j, --jobs job-id
Specifies a list of job IDs, 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
- -U, --User userid
Specifies an IBM 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, IBM Streams tries to use:- The --embeddedzk option
- The value from the STREAMS_ZKCONNECT environment variable
- A ZooKeeper connection string that is derived from cached information about the current domain.