GUI: Logs

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

GUI Reference: Logs

CodeSonar keeps several logs during the project build and analysis. Users can select different logs, and different parts of logs, for viewing.

Log Types
Log Views
Viewing Logs
Deleting Logs
Log Output

Log Types

CodeSonar maintains several logs during the project build and analysis:

Build Log	A transcription of the interleaved stdout and stderr messages issued by the observed command that the CodeSonar project was based on. For C and C++ projects, the build log contains the messages produced by the regular software build process. For Java projects, the contents of the build log will depend on the observed command; cs-java-scan itself does not produce any output on stdout or stderr.
Parse Log	When SEND_HOOK_LOG_TO_HUB=Yes, errors and diagnostic information that CodeSonar encountered while parsing code will appear here. Otherwise, the parse log contains no logging information. Such errors might occur if a user's compiler accepts a slightly different dialect of C than the compiler model it is mapped to, or if CodeSonar is unaware of an implicit system include directory. Parse errors can seriously degrade the quality of analysis results, so it good practice to review the parse log for errors (and resolve them) before examining analysis results. Parse errors will appear in red. Entries in the parse log link to more detailed information in the native compilation details log. If SEND_PARSE_LOG_TO_HUB=Yes, they also link to the parse details log
Analysis Log	The CodeSonar analysis phase.

Build Log

A transcription of the interleaved stdout and stderr messages issued by the observed command that the CodeSonar project was based on.

For C and C++ projects, the build log contains the messages produced by the regular software build process.
For Java projects, the contents of the build log will depend on the observed command; cs-java-scan itself does not produce any output on stdout or stderr.

Parse Log

When SEND_HOOK_LOG_TO_HUB=Yes, errors and diagnostic information that CodeSonar encountered while parsing code will appear here. Otherwise, the parse log contains no logging information.

Such errors might occur if a user's compiler accepts a slightly different dialect of C than the compiler model it is mapped to, or if CodeSonar is unaware of an implicit system include directory. Parse errors can seriously degrade the quality of analysis results, so it good practice to review the parse log for errors (and resolve them) before examining analysis results. Parse errors will appear in red.

Entries in the parse log link to more detailed information in the native compilation details log. If SEND_PARSE_LOG_TO_HUB=Yes, they also link to the parse details log

Analysis Log

The CodeSonar analysis phase.

Log Views

For each log type, users can choose between four views.

View	if phase still executing:	if phase complete:
Full	Displays the log from the beginning of the phase to the time the user requested the log page.	Displays the complete log.
Streamed Full	Displays the log from the beginning of the phase. As the phase continues, the page updates to reflect every subsequent update to the log.	Displays the complete log.
Tail	Displays the most recent update to the log.	Displays the last few updates to the log.
Streamed Tail	Displays the most recent update to the log. As the phase continues, the page updates to reflect every subsequent update to the log.	Displays the last few updates to the log.

Viewing Logs

Log pages can be accessed by navigating from other pages in the CodeSonar Web GUI, or by specifying their URLs directly.

Navigating Through The GUI

The logs for a specific analysis can be accessed from the following pages.

Analysis	Expand the Analysis Details section.
Any Source Listing from the analysis.	Expand the File Details section, then click show logs (on the Finished line).
Any log page associated with the analysis.	In the summary information section, click show logs (on the Finished line).

In each case, you will be presented with a list of log options:

screenshot fragment: show logs expansion

Select your preferred log from the list and click your chosen link. The corresponding log page will open.

If the analysis logs have been deleted, you will see a "logs have been deleted" message instead of a list of log options.

Constructing a Log Page URL

The general form of a log page URL is:

http://hub_location/analysis/analysisID-logtype_log[stream][tailnum].html

where

analysisID

is the Analysis ID for the analysis whose log is required.

logtype

depending on the type of log required, one of native, parse, ad:

native	build log
parse	parse log
ad	analysis log

[stream]

include stream if you want the page to update every time the log is updated.

[tailnum]

include tailnum if you want to view the log starting from the current point (instead of the beginning). num specifies the number of rows to retrieve from the log database for display (or initial display, if the log is streamed).

For example:

http://hub_location/analysis/2-native_log.html is the Full view of the build log associated with the analysis with ID 2.
http://hub_location/analysis/6-ad_logtail20.html is the Tail view of the analysis log associated with the analysis with ID 6, showing the last 20 rows in the log database.
http://hub_location/analysis/16-parse_logstreamtail10.html is the Streamed Tail view of the parse log associated with the analysis with ID 16, and will initially show the last 10 rows in the log database.

Deleting Logs

You may wish to delete logs from one or more analyses on the hub if you are trying to reduce the size of the hub database and do not anticipate any future need for any information in the logs from those analyses.

There are several options:

Delete the logs for a single analysis from the corresponding Analysis page.
Delete the logs for one or more analyses at once...
- ...from the corresponding Project page, if all the analyses belong to the same project.
- ...from an Analysis Search Results page, for an arbitrary set of analyses.
Set up autodeletion for logs...
- ...from the corresponding Project page, for project-wide autodeletion.
- ... from the Analysis tab of the Settings page, for hub-wide autodeletion.

If an analysis is still running when you remove its logs, any further log information that is submitted to the hub by that analysis will be ignored.

Log Output

All logs pages can be output in plain text and XML formats. For streaming views (Streamed Full and Streamed Tail), the text and XML output files will likewise be streamed.

To report problems with this documentation, please visit https://support.codesecure.com/.