Log and trace files generated by InfoSphere Streams
By default, InfoSphere® Streams generates log and trace files for the domain and instance services and applications. Administrators, instance owners, application developers, and IBM® Software Support can use this data to correct problems with InfoSphere Streams.
Location of log and trace files
Log and trace files are on the resources where the InfoSphere Streams services and applications are running. The log and trace files for a processing element (PE) are on multiple hosts if the PE is moved during its execution.
The default root directory for all log and trace files is the /tmp directory. You can configure a different root directory by updating the domainLog.path domain property. The names of the subdirectories under your configured root directory cannot be changed.
The /tmp directory is also the default root directory for the web management service application server class cache files, trace files, and log files. You can configure a different root directory by updating the domain.fileStoragePath domain property.
Removal of log and trace files
By default, InfoSphere Streams automatically removes all log and trace files when you start an instance, or remove a domain, instance, or host.
To remove log and trace files, you must use the streamtool cleanlog command.
Rolling log and trace files
Most log and trace files that are generated by InfoSphere Streams are rolling files, which consist of multiple file fragments. By default, InfoSphere Streams retrieves the most current fragment.
Rolling file fragments are numbered such that the most recent fragment has the number 1 and the older fragments have the larger numbers. For example, fragment 1 is a more recent fragment than fragment 2.
- Removes the oldest (highest numbered) file fragment.
- Increases the number of each file fragment by one. For example, fragment 1 becomes fragment 2.
- Changes the current fragment to fragment 1.
- Creates a new empty current fragment.
- domainTrace.maximumFileSize
- domainTrace.maximumFileCount
- instanceTrace.maximumFileSize
- instanceTrace.maximumFileCount
Log and trace file types, default locations, and descriptions
To collect and view log and trace data, you can use the streamtool command line interface, the Streams Console, or Streams Studio.
The following table describes the types of log and trace files that are generated for InfoSphere Streams services and applications.
| File type | Description |
|---|---|
| Default location on each host: /tmp/domain-id/logs/resource-id directory The trace files for an instance are in the /tmp/domain-id/logs/resource-id/instances/instance-id directory. |
|
| Domain log file | For each domain, there are streams.number.log files that contain log messages for the InfoSphere Streams services and applications. |
| Service trace files | These rolling service-name.out files
contain trace messages for the InfoSphere Streams services.1 The service-name_process-id.out files are trace files for the waiting state service, for example: sam_12345.out. |
| Service console trace files | These rolling service-name.stdouterr files contain stdout/stderr trace messages for the InfoSphere Streams services.1 |
| Default location on each host: /tmp/domain-id/logs/resource-id/instances/instance-id/jobs/job-id directory | |
| Application trace files | These files are rolling pe.pe-id.out files,
where pe-id is the processing
element ID. These files contain the following types of trace messages:
|
| Processing Element Container (PEC) service trace files | These files are rolling pec.pe-id.out files, where pe-id is the processing element ID. |
| Application and PEC service console trace files | These files are rolling pec.pe.pe-id.stdouterr files,
where pe-id is the processing
element ID. These files contain stdout/stderr messages for InfoSphere Streams applications and the PEC service. |
| Default location on the resources that run the web management services: /tmp/domain-id/SWSCache directory | |
| Application server class cache files, trace files, and log files | These files are non-rolling files that are generated by the application server that is used by the web management service. |
Table note:
|
|