codeql_generate_log-summary.prompt.md

description	Reference for the codeql generate log-summary command

Command Resource for codeql generate log-summary

The codeql generate log-summary command is used to create a summary of a structured JSON evaluator event log file. This command provides more stable output across CLI versions than parsing the raw log files directly.

Primary use of codeql generate log-summary

The following is an example use of the command for creating a human-readable summary of evaluator logs:

codeql generate log-summary \
  --format=text \
  -- evaluator-log_<language>-db_SomeQuery.json.txt summary.txt

Advanced uses of codeql generate log-summary

Different output formats

The command supports three output formats for different analysis needs:

# Human-readable text summary
codeql generate log-summary \
  --format=text \
  -- evaluator-log.json.txt summary.txt

# Predicate-level JSON summary (default format)
codeql generate log-summary \
  --format=predicates \
  --minify-output \
  -- evaluator-log.json.txt summary.json

# Overall evaluation statistics as JSON
codeql generate log-summary \
  --format=overall \
  -- evaluator-log.json.txt overall-stats.json

Using with evaluator logs from codeql query run

This command is typically used to analyze logs generated by the --evaluator-log option of codeql query run:

# First, run a query with evaluator logging
codeql query run \
  --database=/path/to/db \
  --evaluator-log=evaluator-log_MyQuery.json.txt \
  --evaluator-log-minify \
  --output=results_MyQuery.bqrs \
  -- MyQuery.ql

# Then, generate a human-readable summary
codeql generate log-summary \
  --format=text \
  -- evaluator-log_MyQuery.json.txt summary_MyQuery.txt

Advanced options

# Force UTC timestamps and deduplicate stage summaries
codeql generate log-summary \
  --format=text \
  --utc \
  --deduplicate-stage-summaries \
  -- evaluator-log.json.txt

Help for codeql generate log-summary

Run codeql generate log-summary --help for more information. Run codeql generate log-summary --help --verbose for much more information.

Commands commonly run BEFORE codeql generate log-summary

• codeql query run - Run queries with --evaluator-log to generate log files

Commands commonly run AFTER codeql generate log-summary

• Analysis of the generated summary files for query performance optimization and debugging