Detect Diagnostic mode

Black Duck Detect
Version
latest

Detect's diagnostic mode produces a diagnostic zip containing files needed for troubleshooting. If you contact Black Duck Support for help troubleshooting an issue, you will need to provide a diagnostic zip from a Detect run that exhibits the problem.

To enable diagnostic mode, add any one of the following to the command line:

A diagnostic zip includes many files valuable for troubleshooting, such as:

  • INFO, DEBUG, and TRACE level logs.

  • The BDIO file produced by the run.

  • Intermediary files generated by Detect, such as Gradle inspector output files.

  • Various reports.

  • Relevant package manager files.

  • The output of commands executed by Detect (package manager commands, etc.).

  • Logs and output files from other executed tools (Black Duck Signature Scanner, etc.).

After running Detect in diagnostic mode, log messages similar to the following provide the path to the diagnostic zip file.

2019-03-29 09:32:02 INFO  [main] --- Creating diagnostics zip.
2019-03-29 09:32:02 INFO  [main] --- Diagnostics zip location: C:\detect\blackduck\runs\detect-run-2019-03-29-13-31-50-492.zip
2019-03-29 09:32:03 INFO  [main] --- Diagnostics file created at: C:detect\blackduck\runs\detect-run-2019-03-29-13-31-50-492.zip
2019-03-29 09:32:03 INFO  [main] --- Diagnostic mode has completed.

By default, the diagnostic zip is created in the runs output directory. You can specify a custom path for the diagnostic archive using the detect.diagnostic.archive.path property. An original copy of the diagnostics archive remains in the runs directory as a backup.

To conserve disk space, be sure to disable diagnostic mode once it is no longer needed.