메트릭 보고서
Tier: Premium, Ultimate
Offering: GitLab.com, Self-managed, GitLab Dedicated
GitLab은 병합 요청, 단위 테스트 보고서, 코드 품질, 성능 테스트와 같은 다양한 훌륭한 보고 도구를 제공합니다. JUnit이 “통과”하거나 “실패”하는 테스트를 위한 훌륭한 오픈 프레임워크이지만, 주어진 변화에서 다른 유형의 메트릭을 보는 것도 중요합니다.
당신은 작업을 구성하여 사용자 정의 메트릭 보고서를 사용하고, GitLab은 전체 로그를 확인하지 않고도 변경 사항을 더 쉽게 빠르게 식별할 수 있도록 병합 요청에서 보고서를 표시합니다.
사용 사례
메트릭 보고서를 사용할 수 있는 데이터의 다음 예를 고려해 보세요:
- 메모리 사용량
- 로드 테스트 결과
- 코드 복잡성
- 코드 커버리지 통계
작동 방식
브랜치에 대한 메트릭은 최신 메트릭 보고서 아티팩트(기본 파일 이름: metrics.txt)에서 문자열 값으로 읽습니다.
MR의 경우 기능 브랜치에서 이 메트릭의 값은 대상 브랜치의 값과 비교됩니다. 그런 다음 MR 위젯에 다음 순서로 표시됩니다:
- 변경된 값이 있는 기존 메트릭.
- MR에 의해 추가된 메트릭. New 배지로 표시됩니다.
- MR에 의해 제거된 메트릭. Removed 배지로 표시됩니다.
- 값이 변경되지 않은 기존 메트릭.
설정 방법
메트릭 보고서(기본 파일 이름: metrics.txt)를 생성하는 작업을 추가합니다. 파일은 OpenMetrics 형식에 따라야 합니다.
예를 들어:
metrics:
script:
- echo 'metric_name metric_value' > metrics.txt
artifacts:
reports:
metrics: metrics.txt
고급 예제
OpenMetrics 텍스트 파일의 고급 예제(Prometheus documentation)는 병합 요청 위젯에 다음과 같이 표시됩니다:
문제 해결
메트릭 보고서가 변경되지 않음
병합 요청에서 메트릭 보고서를 보려고 할 때 메트릭 보고서가 변경되지 않았습니다라는 메시지를 볼 수 있습니다. 그 이유는 다음과 같습니다:
- 병합 요청에 대한 대상 브랜치에 비교를 위한 기준 메트릭 보고서가 없습니다.
- 유료 구독이 없습니다.
이 메시지를 개선하기 위한 문제가 열려 있습니다.
도움말