Review Log Files and Download Debug Data
Every owner or project manager of a project can retrieve the analysis log files for their projects without the need to consult an administrator. This is done by accessing the Manage project > Versions tab for a particular project directly from the Projects page as shown below:
Clicking the Log icon opens a page showing the project’s client and server logs for that analysis, as well as configuration and output files will open in a new browser tab.
Clicking the one of the Download Debug Data links above the versions table downloads a zip file of the logs and project data that can be further analyzed to understand problems during analysis. The lower levels include only data related to the latest analysis, while the higher levels include information related to the history of the entire project.
A debug data zip file contains a collection of logs, temporary and output files for each one or more versions of the project. Each version folder can contain the following items:
-
A DataProviders folder containing the output files generated by each Data Provider run during the analysis.
-
A [DataProviderName].log file for each Data Provider included in the analysis.
-
A conf.xml file summarising the project parameters used for the analysis.
-
An output.xml file containing the output information requested with the --filter parameter during the analysis.
-
A build.log file containing the information relative to actions carried out on the server during the analysis.
-
A build_client.log file containing the information relative to actions carried out on the client during the analysis.
-
An excluded.log file containing the list of all files not included in the analysis and the reason for their exclusion. Note that this file is only generated if some files were excluded.
-
A table.md5 file containing state information about the analyzed source code, if any.
-
A storage folder containing information about the analyzed source code, if any.
|
If you do not want to download the entire debug package, note that the main log files can also be downloaded individually from the Projects page by clicking on the project status label. |
In order to investigate application failures (rather than project analysis errors), Squore administrators have the possibility to extract and download Squore Logs file created by the application. You can access the Logs if you have administrator privileges by clicking Administration > System > Logs tab in the toolbar after logging in.
In the Logs tab, administrators have two kind of logs available:
-
Server Logs: extract and download into a .zip file the latest server log file created by the application. It is also possible to consult the server log in the UI.
-
Database Logs: extract and download into a .zip file the last week database logs.
Administrators can also get debug information and manage any project created on the server by clicking Administration > Projects, which provides a detailed view of all projects created on Squore Server, on a summary page shown below.
