Skip to main content

로그 요약 생성

[고급] 구조화된 로그 파일의 요약을 만듭니다.

누가 이 기능을 사용할 수 있나요?

CodeQL은(는) 다음 리포지토리 유형에 사용할 수 있습니다.

이 문서의 내용

이 콘텐츠는 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(기본값): 각 조건자에서 수행되는 계산의 요약을 생성합니다. 이 스트림은 두 개의 줄 바꿈 문자(기본)로 구분된 JSON 개체의 스트림이거나 --minify-output 옵션이 전달된 경우 한 개입니다.

text: 사용자가 읽을 수 있는 평가 실행 요약을 생성합니다.

overall: 몇 가지 요약 통계와 가장 시간이 많이 소요되는 평가에 대한 정보를 포함하여 평가 실행에 대한 전반적인 정보의 일부가 포함된 JSON 파일을 생성합니다.

--[no-]deduplicate-stage-summaries

[고급] 이 옵션은 텍스트 형식과 함께만 작동합니다. 이 값이 전달되면 쿼리 간에 공유되는 단계에 대해 가장 비싼 조건자가 포함된 요약 테이블이 반복되지 않습니다. 이렇게 하면 쿼리가 완료된 시점에 각 쿼리에 대한 테이블이 표시되지 않고 모든 요약 테이블이 로그의 끝으로 이동하는 부작용이 발생합니다.

일반 옵션

-h, --help

이 도움말 텍스트를 표시합니다.

-J=<opt>

[고급] 명령을 실행하는 JVM에 옵션을 지정합니다.

(공백을 포함하는 옵션은 올바르게 처리되지 않을 수 있으니 주의하세요.)

-v, --verbose

출력되는 진행률 메시지 수를 점진적으로 늘립니다.

-q, --quiet

출력되는 진행률 메시지 수를 점진적으로 줄입니다.

--verbosity=<level>

[고급] 세부 정보 표시 수준을 오류, 경고, 진행률, 진행률+, 진행률++, 진행률+++ 중 하나로 명시적으로 설정합니다. -v-q를 재정의합니다.

--logdir=<dir>

[고급] 타임스탬프와 실행 중인 하위 명령의 이름을 포함하는 생성된 이름을 사용하여 지정된 디렉터리에 있는 하나 이상의 파일에 자세한 로그를 기록합니다.

(모든 권한을 가진 이름으로 로그 파일을 작성하려면 --log-to-stderr을(를) 지정하고 stderr를 원하는 대로 리디렉션합니다.)

--common-caches=<dir>

[고급] 다운로드한 QL 팩 및 컴파일된 쿼리 계획과 같이 여러 CLI 실행 간에 유지되는 디스크의 캐시된 데이터의 위치를 제어합니다. 명시적으로 설정하지 않은 경우 이 기본값은 사용자의 홈 디렉터리에 이름이 지정된 .codeql 디렉터리로 설정되며, 아직 없는 경우 만들어집니다.

v2.15.2부터 사용할 수 있습니다.