DeleakerConsole.exe
DeleakerConsole.exe is a command line tool created to automate taking and exporting snapshots. One can use DeleakerConsole.exe in the CI process to get leaks reports in any application.
The tool is installed into Deleaker installation directory, by default DeleakerConsole.exe is available via the path %ProgramFiles(x86)%\Deleaker\DeleakerConsole.exe or %ProgramFiles%\Deleaker\DeleakerConsole.exe
Syntax
DeleakerConsole.exe [options] parameters
Options
| Option | Description |
|---|---|
| --export-xml-report-on-exit report path | Optional. If specified, DeleakerConsole.exe creates an xml leaks report on the process exit. report path is a file path, not a directory. |
| --snapshot-database snapshot database path | Required if either --save-snapshot-on-exit or --save-snapshot-period are specified. If specified, DeleakerConsole.exe saves snapshots (*.dsnapshot that can be opened in the Deleaker UI) to the file snapshot database path. |
| --dont-overwrite-snapshot-database | Optional. If specified, DeleakerConsole.exe doesn't remove a snapshot database before saving snapshots. Instead new snapshots are added to the database. By default, DeleakerConsole.exe removes a snapshot database before saving snapshots. |
| --save-snapshot-on-exit | Optional. If specified, DeleakerConsole.exe saves a snapshot on the process exit. If specified, also use --snapshot-database to set snapshot database path. |
| --save-snapshot-period saving snapshot period | Optional. If specified, DeleakerConsole.exe saves a set of snapshots each saving snapshot period seconds. If specified, also use --snapshot-database to set snapshot database path. |
| --crash-dump-directory crashDumpsDirectory | Optional. If specified, DeleakerConsole.exe saves a dump to the directory crashDumpsDirectory if the process crashes. crashDumpsDirectory is a directory path, not a file. |
| --process-working-directory processWorkingDirectory | Optional. If specified, DeleakerConsole.exe uses directory processWorkingDirectory as a working directory for the process. |
Parameters
| Parameter | Description |
|---|---|
| --run exePath [arguments] | Required. DeleakerConsole.exe starts the process exePath with optional arguments arguments. IMPORTANT: place this parameter to the end of the command line as DeleakerConsole.exe treats everything after --run as a command line to start a new process. |
Remarks
It's obligatory to place --run exePath [arguments] to the end of the command line.
Consider the following:
DeleakerConsole.exe --run C:\Repo\App\trunk\bin\App.exe /someOption --export-xml-report-on-exit exit_report.xml
One may assume that DeleakerConsole.exe will start C:\Repo\App\trunk\bin\App.exe /someOption, and then save a report to exit_report.xml, but in fact it will start all specified after --run, no report will be created, and the command line for a new process will be:
C:\Repo\App\trunk\bin\App.exe /someOption --export-xml-report-on-exit exit_report.xml
The correct command line for DeleakerConsole.exe is (notice that --run moved to the end):
DeleakerConsole.exe --export-xml-report-on-exit exit_report.xml --crash-dump-directory . --run C:\Repo\App\trunk\bin\App.exe /someOption
Examples
Example 1
DeleakerConsole.exe --export-xml-report-on-exit exit_report.xml --crash-dump-directory . --run C:\Repo\App\trunk\bin\App.exe /someOption
Runs C:\Repo\App\trunk\bin\App.exe /someOption.
If the process crashes, a dump will be stored to a current directory.
When the process exits, the report will be saved to exit_report.xml.
Example 2
DeleakerConsole.exe --save-snapshot-on-exit --snapshot-database leaks.dsnapshot --run C:\Repo\App\trunk\bin\App.exe /someOption
Runs C:\Repo\App\trunk\bin\App.exe /someOption.
When the process exits, the snapshot will be saved to leaks.dsnapshot.
Example 3
DeleakerConsole.exe --save-snapshot-period 3 --snapshot-database leaks.dsnapshot --run C:\Repo\App\trunk\bin\App.exe /someOption
Runs C:\Repo\App\trunk\bin\App.exe /someOption.
Saves new snapshot each 3 seconds to leaks.dsnapshot.