Generating a debug log bundle
Should you encounter any difficulties while executing a project scan through the FOSSA CLI, we kindly request that you forward the debug bundle to our support team ([email protected]) and/or your designated Customer Success team for prompt and thorough assistance. This step is crucial for expeditiously resolving any scan-related issues.
Using FOSSA CLI v3.13.0+
Previously, FOSSA created fossa.debug.json.gz and fossa.telemetry.json directly in the scanned directory. The format is a single zip file named fossa.debug.zip, which as the following contents:
fossa.debug.jsonfossa.telemetry.json
If snippet scanning is enabled, it will also include Ficus debug logs.
This change simplifies collection of debug information, especially for snippet scans.
Prior to FOSSA CLI v3.13.0
The debug bundle is fossa.debug.json.gz which is the output of running fossa analyze with the --debug flag, so in practice this is fossa analyze --debug. The following terminal example below shows that fossa.debug.json.gz is the output to the location in which the CLI is ran. A fossa.telemetry.json is also an output, and that may be sent along with the debug bundle as well.
➜ fossa-python-test git:(main) ✗ fossa analyze --debug
[DEBUG] Loading configuration file from "/Users/fossaiscool/fossa-python-test/"
[DEBUG] A task succeeded with warnings
...
<redacted additional debug output>➜ fossa-python-test git:(main) ✗ ls -l
total 80
-rw-r--r-- 1 fossaiscool staff 13884 Apr 24 11:12 fossa.debug.json.gz
-rw-r--r-- 1 fossaiscool staff 5293 Apr 24 11:12 fossa.telemetry.json
-rw-r--r-- 1 fossaiscool staff 791 Apr 16 12:58 requirements.txtUpdated 14 days ago