streamtool cleanlog
The streamtool cleanlog command removes log and trace files.
Usage
cleanlog >>-+-----------------------+--+---------+-----------------------> '-+- -d----------+--did-' +- -h-----+ '- --domain-id-' '- --help-' >--+-------------------------+--+-------------+--+---------+----> '-+- -i------------+--iid-' '- --noprompt-' '---trace-' '- --instance-id-' >--+---------------------+--+-----------------------+-----------> '-+- -U-----+--userid-' '-+- -v--------+--level-' '- --User-' '- --verbose-' >--| Non-interactive tool options |---------------------------->< Non-interactive tool options (1) |--------+-----------------------------+------------------------| +- --embeddedzk---------------+ | .-,---------. | | V | | '- --zkconnect----host:port-+-'
- The non-interactive tool options are not supported in the interactive streamtool interface.
Authority
To remove log or trace data for the instance, you must have delete authority on the instance object for the instance. By default, the DomainAdministrator and InstanceAdministrator roles have this authority.
To remove all log or trace data, you must have delete authority on the domain object for the domain. By default, the DomainAdministrator role has this authority.
For more information, see streamtool getacl and streamtool getdomainacl.
Description
You must stop the instance before you clean trace or log files.
When you do not specify the -i or --instance-id options, all of the log and trace files are removed for the domain and for all of the instances in the domain.
Options and arguments
- -d, --domain-id did
Specifies the domain identifier.
If you do not specify this option, InfoSphere® 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, InfoSphere Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. InfoSphere 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 InfoSphere Streams configuration cache, the command fails.
- -h, --help
Specifies to show the command syntax.
- -i, --instance-id iid
Specifies the instance identifier.
If you do not specify this option, InfoSphere 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.
- --noprompt
Specifies to suppress confirmation prompts.
- --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 InfoSphere Streams user ID that has authority to run the command.
- -v,--verbose level
Specifies to provide more detailed command output. The vebosity level can be from 0 to 3 where 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, InfoSphere 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.
Examples
[streamtool <bsmith@StreamsDomain.StreamsInstance>] stopinstance
[streamtool <bsmith@StreamsDomain.StreamsInstance>] cleanlog -i StreamsInstance
CDISC1076W Do you want to remove the trace files from the StreamsInstance instance
in the StreamsDomain domain"? Enter "y" to continue or "n" to cancel:y
CDISA0095I Cleaning the server1.ibm.com resource.
The resource is allocated to the StreamsInstance instance for the following domain: StreamsDomain.
CDISC0018I The log files in the StreamsInstance instance in the StreamsDomain domain were cleaned up successfully.