When executing Elipse Event Log Collector, the dialog box on the next figure is opened.
Elipse Event Log Collector's main window
The available options on this window are described on the next table.
Available options for Elipse Event Log Collector
Option |
Description |
|---|---|
Search options |
Allows selecting how files are collected. The available options are Collect only the running sessions, in which log collection is performed only on open log sessions, and Collect log files on disk, which allows selecting log files to collect, by using the Input folder option. Regardless the selected mode, collected files are serialized, if supported by the API and by the log session, to the next value on the daily sequence |
Input folder |
Informs the directory from where the log files must be retrieved. It is initially filled in with parameters configured on log storage, so that users can determine where logs are currently generated. To select a directory, click |
Include files in sub-directories |
Indicates if the collect process must be performed by searching files on sub-directories |
File extension filter |
Informs which file extensions must be collected |
Collection interval |
Allows selecting a time interval to collect logs. The available options are Everything, all logs, Last 24 hours, logs from the last 24 hours, Last 7 days, logs from the last 7 days, Last 30 days, logs from the last 30 days, Last 365 days, logs from the last 365 days, or Custom range, logs from a specific date. When selecting the Custom range option, users can select a specific date to collect logs |
Action |
Informs an output type for the log collector. If the selected option is Send by e-mail to, the result of the log collect, after saved to the output folder, is sent by e-mail to the address informed on this option. If the selected option is Only save the compressed file to 'Output Folder', the generated file is only saved to the output folder |
Output Folder |
Indicates an output directory where the compressed log file is saved. Regardless of the option selected in Action, a copy of the compressed file is always saved to that directory. To select a directory, click |
Details |
Shows information about the progress of the process of collecting log files |
Go |
Starts collecting log files |
Stop |
Stops collecting log files |
View Files |
Allows viewing which log files were found, according to the Input file options and File extension filter options. If compression is successful, this list matches the list of compressed files |
NOTE |
Changes on the parameters of the Input file options option must be performed carefully, because this action determines from where the collector retrieves those files. It is only advised to change these values under technical recommendation by Elipse Software. |
When collecting files with an .etl (Elipse Trace Logs) extension that are in use, the program automatically flushes in-memory events (flush of event buffers), preventing loss of information.
Flushing in-memory events to disk only happens when the files to collect are on the same computer where Elipse Event Log Collector is executing. A collecting executed on remote computers has no way to perform flushing events on the other computer, although they are collecting files written to disk. The generated output file is always named CollectedLogs.ezp. When starting a new collect process, if there were a previous file on the same output directory named CollectedLogs.ezp, this file is erased and a new one is created.
If the disk unit where the CollectedLogs.ezp file is generated has less than or equal to 5 MB free space, the collector does not start the collect process. If collecting has already begun, it is stopped when reaching this limit.
If the Send by e-mail to option is selected, at the end of the collect process a window is opened to send an e-mail. The collected file is then attached to it.
If there is no e-mail client configured or compatible, or any other error has occurred while preparing the message, the file is not sent. In this case, users must send this file manually using an e-mail client or a webmail. Depending on the size of the generated file, it may be necessary to send it via physical media, such as a CD or DVD, to Elipse Software.
NOTE |
For Elipse Event Log Collector to open an e-mail message, users must have an e-mail client compatible with Microsoft Simple MAPI (Microsoft Simple Message API), a protocol used by the collector to create a call to an e-mail client that generates the message. |
Any error due to search option parameters, access rights to output folders, insufficient disk space (less than 5 MB), users aborting the collect process, or any other error, prevents the CollectedLog.ezp final file to be generated.
While the collect process is executing and the output file is being generated, its name has a __tmp suffix, therefore it is named CollectedLogs.ezp__tmp. This file is renamed at the end of the collect process to CollectedLogs.ezp.
If the option to send by e-mail was selected, a message is displayed asking whether the list of collected files should be displayed before sending it.
Message asking to display a list of collected files
By clicking Yes, a list is displayed with all files added to the file CollectedLogs.ezp.
List of added files
Next, the e-mail is configured to be sent, using the default e-mail client of the machine where Elipse Event Log Collector is installed.