Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

For Datical DB versions 5.9 and higher, you can use the hammer debug export command to "scrub" sensitive information such as hosts, ports, and credentials from your files before sending them to Datical Support.  The hammer debug export command will create a new zip file in your <ProjectName>/Reports/debug directory that contains the files you specify to include. The files in the zip will have the actual values for hosts, ports, usernames and password hashes (password hashes are only relevant if you use the less secure Stored Credentials option) replaced by the scrubber with more generic strings (tokens).  This is to avoid emailing files that contain the actual values as they may be sensitive information.

The hammer debug export command provides a simple way to archive the needed files into a zip file that you then send to Datical Support:

  • You can specify which files to include in the zip. 
  • The command must be run from the command line (not from the Datical desktop client/GUI).
  • The "scrubber" will only handle files that are located somewhere within your <ProjectName> directory structure for that project.  If there are relevant files located outside of the project's directory structure (for example the daticaldb.log file for operations performed in the Datical desktop client/Eclipse GUI), you can copy that log into the project directory structure prior to running the hammer debug export command.
  • You can add a new step near the end of your automation jobs so that the hammer debug export command creates the zip of "scrubbed" files automatically for each job.

Command: hammer debug export

...

All files must be in the project file hierarchy. If you want to add a file from outside the project, copy it to the file hierarchy. Place it in the root <ProjectName> directory, or in the <ProjectName>/Log subdirectory, or other subdirectory.  

...

You can include only files modified within a specified number of hours.  This is optional.  

Use the --lastmodified option to specify a number of hours.  All files are included that have a last modified date within the number of hours measured from the time the command is run. 

...

Code Block
hammer debug export --include=datical.project,changelog.xml,daticaldb*.log,packager.log,*.html

Using --report

You can use the --report option to specify the alternative path and/or filename for the zip archive produced by this command.  This is optional.  

Example of --report to go to a folder called tmp

Code Block
hammer debug export --include="datical.project,changelog.xml,daticaldb*.log,*.html,deployPackager.properties,packager.log" --report=/tmp


If you already use a BUILD_NUMBER variable in your automation configuration, you could include the build number as part of the filename of the zip file created by the hammer debug export command.

Example of --report with BUILD_NUMBER

Code Block
hammer debug export --include="datical.project,changelog.xml,daticaldb*.log,*.html,deployPackager.properties,packager.log" --report=scrubbed_debug_files_${BUILD_NUMBER}.zip

Default (no command options specified)

Include and scrub all files in the project directory.  The zip created may be quite large because it would include all of the sql scripts and all other files.

Example of Default

Code Block
hammer debug export

...