품질 게이트 규칙 설정

문서 > Quality Gates > 품질 게이트 규칙 설정

Join the Beta!

품질 게이트는 퍼블릭 베타 서비스입니다.

개요

일반적으로 품질 게이트를 설정하려면:

Datadog 사이트에서 하나 이상의 규칙을 생성합니다.
파이프라인의 datadog-ci gate evaluate 명령어로 품질 게이트를 불러옵니다.

규칙 생성하기

기관용 품질 게이트를 생성하려면 사용자 계정에 quality_gate_rules_write 권한이 있어야 합니다.

Datadog에서 CI > 품질 게이트 규칙으로 이동하여 +새 규칙을 클릭합니다.
규칙 범위를 정의합니다. 해당 규칙 범위는 규칙을 평가하는 시기를 정의합니다. 예를 들어, 특정 리포지토리 및 분기에서만 평가되는 규칙을 생성할 수 있습니다. 규칙의 범위를 정의하려면 select when to evaluate로 전환하여 해당 범위에 포함되거나 포함되지 않는 규칙을 추가합니다. 자세한 내용을 확인하려면 규칙 범위를 참조하세요.
규칙 유형을 선택합니다. Static Analysis 및 Test를 선택할 수 있습니다.
규칙 조건을 정의합니다. 규칙 조건은 해당 규칙이 실패하여 관련 파이프라인이 실패하는 시나리오를 의미합니다(규칙이 차단하는 경우). 선택한 규칙 유형에 대한 기존 규칙 조건 중에서 하나를 선택할 수 있습니다.

다음 예시는 특정 커밋에 “오류” 상태 및 “보안” 카테고리가 도입된 하나 이상의 정적 분석 위반이 발생한 경우 실패하는 정적 분석 규칙을 생성하는 방법을 설명합니다.

파이프라인이 실패한 경우 규칙이 해당 파이프라인을 차단할지 여부를 선택합니다. 비차단 규칙은 새로운 규칙을 도입하고 차단 전 해당 규칙의 동작을 식별하고 싶을 경우 유용합니다.
쿼리 평가 기간을 선택합니다.
생성 중인 규칙을 설명하는 규칙 이름을 지정합니다.
규칙 저장을 클릭합니다.

품질 게이트 불러오기

품질 게이트를 사용하려면 datadog-ci 2.27.0 이상 버전이 필요합니다.

datadog-ci gate evaluate 명령을 호출하여 품질 게이트를 불러옵니다.

해당 명령:

현재 파이프라인 컨텍스트(명령에 전달된 리포지토리, 브랜치 또는 사용자 지정 범위)와 매칭되는 규칙 범위 및 사용자 지정 범위가 있는 모든 규칙을 불러옵니다.
매칭되는 모든 규칙을 평가합니다.
하나 이상의 차단 규칙이 실패하면 실패로 간주되며, 해당 파이프라인이 차단됩니다.

명령이 정확하게 동작하려면 해당 이벤트(테스트, 정적 분석 위반)가 datadog-ci 게이트 평가 명령이 실행되기 전에 Datadog에 전송되어야 합니다. 그렇지 않으면 해당 규칙은 이벤트의 부재로 인해 잘못된 동작으로 간주될 수도 있습니다.

환경 변수	설명
`DD_API_KEY`	Datadog API 키를 포인팅합니다.
`DD_APP_KEY`	Datadog 애플리케이션 키를 포인팅합니다.
`DD_SITE`	(옵션) 특정 Datadog 사이트를 포인팅합니다(기본값: `datadoghq.com`).

예시:

DD_SITE= DD_API_KEY=API_KEY DD_APP_KEY=APP_KEY datadog-ci gate evaluate

다음 플래그를 사용하여 datadog-ci gate evaluate 명령의 동작을 설정할 수 있습니다.

--fail-on-empty: 매칭되는 규칙을 찾지 못하면 명령이 실패합니다. 현재 파이프라인 콘텍스트에 기반합니다. 기본적으로 해당 명령은 성공합니다.
--fail-if-unavailable: 내부 문제로 인해 하나 이상의 규칙을 평가할 수 없는 경우 명령은 실패합니다. 기본적으로 해당 명령은 성공합니다.
--timeout: 본 명령은 지정한 시간(초)이 지나면 명령 실행을 중지합니다. 시간 제한 기본값은 10분입니다. 명령 수행은 대개 몇 분 내에 완료되지만 더 오래 걸릴 수도 있습니다.
--no-wait: Skips the default time that the command waits for the events (for example, tests, static analysis violations) to arrive to Datadog. The default wait time makes sure that the events are queryable in Datadog before the rules are executed, avoiding incorrect evaluations. If, in your pipeline, the job containing the datadog-ci gate evaluate command is called several minutes after the related events are sent to Datadog, you can opt to skip this waiting time by specifying the --no-wait 플래그. 그러나 본 플래그를 잘못 사용할 경우 규칙 평가 결과가 부정확할 수도 있습니다.

커스텀 범위를 다음 --scope 옵션을 한 번 이상 사용하여 명령에 추가합니다.

datadog-ci gate evaluate --scope team:backend --scope team:frontend

로그 명령을 점검하여 전체 게이트 평가 상태와 평가한 규칙에 대한 정보를 확인할 수 있습니다.

규칙 범위

품질 게이트 기능을 사용하면 Datadog에서 신호에 기반하여 워크플로우를 게이트할 수 있습니다. 정적 분석과 테스트라는 두 가지 규칙을 생성할 수 있습니다. 예를 들어, 신규 취약 테스트, 코드 보안 위반 또는 CI/CD 파이프라인이 실패하지 않고 프로덕션에 배포되는 기타 문제가 발생한 경우 코드가 병합되는 것을 차단할 수 있습니다.

규칙 생성 시 해당 규칙을 평가해야 하는 시기를 명시하는 범위를 정의할 수 있습니다. 규칙 범위를 always evaluate로 설정하면 해당 규칙은 모든 리포지토리와 브랜치에서 평가됩니다. 품질 게이트를 사용하면 기본 브랜치에 병합되는 항목과 최종 배포되는 항목을 제어할 수 있습니다. 이를 통해 프로덕션에서 실행되는 코드가 높은 품질 기준을 충족할 수 있게 하고 인시던트를 줄여 원치 않는 동작을 최소화할 수 있습니다.

datadog-ci gate evaluate 명령이 호출되면 명령 컨텍스트와 매칭되는 범위의 규칙이 평가됩니다.

각 범위(예: branch)에 대해 포함 또는 제외되는 값을 선택할 수 있습니다. 포함되는 값을 선택하면, 포함되는 값 하나 이상이 명령 컨텍스트의 일부인 경우 해당 규칙이 평가됩니다.

제외된 값을 선택한 경우, 제외된 값이 명령 컨텍스트의 일부라면 해당 규칙은 평가되지 않습니다.

규칙 생성

예를 들어, example-repository 리포지토리의 main를 제외하고 모든 브랜치에서 평가되는 규칙을 생성하려면 다음과 같이 범위를 정의합니다.

규칙에 범위에 포함되지 않는 경우, 해당 범위의 모든 값을 평가합니다. 예를 들어, 규칙에 repository 범위가 포함되지 않으면 모든 리포지토리를 평가합니다.

커스텀 범위

브랜치 및 리포지토리외에도 커스텀 범위를 정의하여 특정 CI 파이프라인을 평가하는 규칙을 필터링할 수 있습니다.

규칙 생성 시 커스텀 범위를 추가하려면 다음을 따릅니다.

+필터 추가를 클릭하고 **커스텀 범위 **를 선택합니다.
범위 이름을 정의합니다(예: team).
범위에 포함 또는 제외되는 값을 정의합니다.

branch 및 repository 범위와는 다르게, 커스텀 범위를 ‘–scope’ 옵션을 사용하여 datadog-ci gate evaluate 명령에 전달해야 합니다. 예를 들어, example-repository 리포지토리를 평가하는 규칙을 생성할 수 있지만 팀이 backend인 경우에만 해당 규칙을 만들 수 있습니다.