Skip to main content

このバージョンの GitHub Enterprise サーバーはこの日付をもって終了となります: 2024-03-07. 重大なセキュリティの問題に対してであっても、パッチリリースは作成されません。 パフォーマンスの向上、セキュリティの向上、新機能の向上を図るために、最新バージョンの GitHub Enterprise サーバーにアップグレードしてください。 アップグレードに関するヘルプについては、GitHub Enterprise サポートにお問い合わせください

generate log-summary

[詳細設定] 構造化ログ ファイルの概要を作成します。

この機能を使用できるユーザーについて

GitHub CodeQL は、インストール時にユーザーごとにライセンスされます。 CodeQL は、ライセンスの制限の下で特定のタスクでのみ使用できます。 詳しくは、「CodeQL CLI について」を参照してください。

GitHub Advanced Security ライセンスがある場合は、CodeQL を使用して、自動分析、継続的インテグレーション、継続的デリバリーを行うことができます。 詳しくは、「GitHub Advanced Security について」を参照してください。

この記事の内容

このコンテンツでは、CodeQL CLI の最新リリースについて説明します。 このリリースについて詳しくは、 https://github.com/github/codeql-cli-binaries/releases をご覧ください。

以前のリリースの、このコマンドで使えるオプションを詳しく確認するには、ターミナルで --help オプションを指定してコマンドを実行してください。

構文

Shell
codeql generate log-summary <options>... -- <input> <result>

説明

[詳細設定] 構造化ログ ファイルの概要を作成します。

このコマンドによって、構造化された JSON エバリュエーター イベント ログの概要が作成されます。 このコマンドの出力は、ログ ファイル自体とは異なるバージョンの CLI でより安定化させることを目的としています。 そのため、ログからの出力を使用するスクリプトを実装する場合は、イベント ログを直接使用するのではなく、このコマンドを実行してその出力を使用することを強くお勧めします。

[オプション]

主なオプション

<input>

[必須] 概要を生成するイベント ログ ファイルへのパス。

<result>

概要ログ ファイルの出力先の場所へのパス。 これを省略すると、概要が stdout に出力されます。

--minify-output

該当する場合は、出力される概要の空白文字を省略します。 結果は人間が読みやすいものではありませんが、占有するメモリは少なくなります。 このオプションは、一部の出力形式にのみ影響します。

--utc

[詳細設定] このコマンドによって生成される概要の特定のタイムスタンプでは、実行されているマシンのローカル タイムゾーンが使用される場合があります。 このフラグを有効にすると、すべてのタイムスタンプが強制的に UTC になります。

--format=<format>

生成される出力の形式を制御します。

predicates (既定値) : 各述語に対して実行される計算の概要を生成します。 これは、2 つの改行文字 (既定)、または --minify-output オプションが渡された場合は 1 つの改行文字で区切られた JSON オブジェクトのストリームになります。

text: 評価実行の、人間が判読できる概要を生成します。

overall: 評価実行に関する全体的な情報を含む JSON ファイルを生成します。これには、いくつかの概要統計と、実行された最も時間のかかる評価に関する情報が含まれます。

--[no-]deduplicate-stage-summaries

[詳細設定] このオプションは、テキスト形式と組み合わせてのみ機能します。 渡された場合、クエリ間で共有されるステージ間で繰り返されない、最も負荷の高い述語を含む概要テーブルが生成されます。 これには、クエリが完了した時点で各クエリのテーブルが表示されるのではなく、すべての概要テーブルがログの末尾に移動されるという副作用があります。

共通オプション

-h, --help

このヘルプ テキストを表示します。

-J=<opt>

[詳細設定] コマンドを実行している JVM にオプションを指定します

(スペースを含むオプションは正しく処理されないことに注意してください)。

-v, --verbose

出力される進行状況メッセージの数を段階的に増やします。

-q, --quiet

出力される進行状況メッセージの数を段階的に減らします。

--verbosity=<level>

[詳細設定] 詳細レベルを、errors、warnings、progress、progress+、progress++、progress+++ のいずれかに明示的に設定します。 -v-q がオーバーライドされます。

--logdir=<dir>

[詳細設定] タイムスタンプと実行中のサブコマンドの名前を含む生成された名前を使用して、指定されたディレクトリ内の 1 つまたは複数のファイルに詳細なログを書き込みます

(完全に制御できる名前でログ ファイルを書き込むには、代わりに --log-to-stderr を指定し、必要に応じて stderr をリダイレクトします)。

--common-caches=<dir>

[[詳細設定] ダウンロードした QL パックやコンパイル済みクエリ プランなど、CLI の複数の実行間に保持される、ディスク上でキャッシュされたデータの場所を制御します。 明示的に設定されない場合、既定ではユーザーのホーム ディレクトリに名前が付けられた .codeql ディレクトリになります。まだ存在しない場合は作成されます。

v2.15.2 以降で使用できます。