generate log-summary
[Advanced] Create a summary of a structured log file.
Who can use this feature?
CodeQL is available for the following repository types:
- Public repositories on GitHub.com, seeGitHub CodeQL Terms and Conditions
- Organization-owned repositories on GitHub Team withGitHub Code Security enabled
In this article
Note
This content describes the most recent release of the CodeQL CLI. For more information about this release, seehttps://github.com/github/codeql-cli-binaries/releases.
To see details of the options available for this command in an earlier release, run the command with the--help option in your terminal.
Synopsis
codeql generate log-summary <options>... -- <input> <result>
codeql generate log-summary <options>... -- <input> <result>Description
[Advanced] Create a summary of a structured log file.
This command creates a summary of a structured JSON evaluator event log.The output of this command aims to be more stable across differentversions of the CLI than the log files themselves. Thus, whenimplementing a script that uses output from the logs, it is stronglyrecommended to run this command and use its output rather than using theevent logs directly.
Options
Primary Options
<input>
[Mandatory] Path to the event log file to produce a summary of.
<result>
Path to the location to output the summarised log file to. If thisomitted, then the summary will be output to stdout.
--minify-output
Where applicable, omit whitespace in the outputted summary. The resultwill be less human-readable but take up less memory. This option onlyhas an effect for some output formats.
--utc
[Advanced] Certain timestamps in the summaries produced by thiscommand may use the local timezone of the machine they are running on.Enabling this flag forces all timestamps to be UTC.
--format=<format>
Control the format of the output produced.
predicates(default): Produce a summary of the computation performedfor each predicate. This will be a stream of JSON objects separatedeither by two newline characters (by default) or one if the--minify-output option is passed.
text: Produce a human-readable summary of the evaluation run.
overall: Produce a JSON file containing some overall information aboutthe evaluation run, including some summary statistics and informationabout the most time-consuming evaluations that were performed.
--[no-]deduplicate-stage-summaries
[Advanced] This option only works in conjunction with the text format.If passed, this will result in the summary tables containing the mostexpensive predicates not being repeated for stages that are sharedbetween queries. This has the side-effect of moving all the summarytables to the end of the log, rather than having the ones for each queryappear at the point when that query finished.
Common options
-h, --help
Show this help text.
-J=<opt>
[Advanced] Give option to the JVM running the command.
(Beware that options containing spaces will not be handled correctly.)
-v, --verbose
Incrementally increase the number of progress messages printed.
-q, --quiet
Incrementally decrease the number of progress messages printed.
--verbosity=<level>
[Advanced] Explicitly set the verbosity level to one of errors,warnings, progress, progress+, progress++, progress+++. Overrides-vand-q.
--logdir=<dir>
[Advanced] Write detailed logs to one or more files in the givendirectory, with generated names that include timestamps and the name ofthe running subcommand.
(To write a log file with a name you have full control over, insteadgive--log-to-stderr and redirect stderr as desired.)
--common-caches=<dir>
[Advanced] Controls the location of cached data on disk that willpersist between several runs of the CLI, such as downloaded QL packs andcompiled query plans. If not set explicitly, this defaults to adirectory named.codeql in the user's home directory; it will becreated if it doesn't already exist.
Available sincev2.15.2.