DevOps Research and Assessment (DORA) key metrics API

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

DORA 지표를 GraphQL API로 검색할 수도 있습니다.

모든 방법에는 적어도 기고자 역할이 필요합니다.

프로젝트 수준의 DORA 지표 가져오기

프로젝트 수준의 DORA 지표를 가져옵니다. 

GET /projects/:id/dora/metrics
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 액세스 할 수 있는 프로젝트의 ID 또는 URL 인코딩 된 경로입니다.
metric 문자열 예 deployment_frequency, lead_time_for_changes, time_to_restore_service 또는 change_failure_rate 중 하나입니다.
end_date 문자열 아니오 종료할 날짜 범위입니다. ISO 8601 날짜 형식으로 예를 들면 2021-03-01입니다. 기본값은 현재 날짜입니다.
environment_tiers 문자열의 배열 아니오 환경의 티어입니다. 기본값은 production입니다.
interval 문자열 아니오 버킷별 간격입니다. all, monthly 또는 daily 중 하나입니다. 기본값은 daily입니다.
start_date 문자열 아니오 시작할 날짜 범위입니다. ISO 8601 날짜 형식으로 예를 들면 2021-03-01입니다. 기본값은 3달 전입니다.

예제 요청: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/dora/metrics?metric=deployment_frequency"

예제 응답: 

[
  { "date": "2021-03-01", "value": 3 },
  { "date": "2021-03-02", "value": 6 },
  { "date": "2021-03-03", "value": 0 },
  { "date": "2021-03-04", "value": 0 },
  { "date": "2021-03-05", "value": 0 },
  { "date": "2021-03-06", "value": 0 },
  { "date": "2021-03-07", "value": 0 },
  { "date": "2021-03-08", "value": 4 }
]

그룹 수준의 DORA 지표 가져오기

그룹 수준의 DORA 지표를 가져옵니다. 

GET /groups/:id/dora/metrics
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 액세스 할 수 있는 프로젝트의 ID 또는 URL 인코딩 된 경로입니다.
metric 문자열 예 deployment_frequency, lead_time_for_changes, time_to_restore_service 또는 change_failure_rate 중 하나입니다.
end_date 문자열 아니오 종료할 날짜 범위입니다. ISO 8601 날짜 형식으로 예를 들면 2021-03-01입니다. 기본값은 현재 날짜입니다.
environment_tiers 문자열의 배열 아니오 환경의 티어입니다. 기본값은 production입니다.
interval 문자열 아니오 버킷별 간격입니다. all, monthly 또는 daily 중 하나입니다. 기본값은 daily입니다.
start_date 문자열 아니오 시작할 날짜 범위입니다. ISO 8601 날짜 형식으로 예를 들면 2021-03-01입니다. 기본값은 3달 전입니다.

예제 요청: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/dora/metrics?metric=deployment_frequency"

예제 응답: 

[
  { "date": "2021-03-01", "value": 3 },
  { "date": "2021-03-02", "value": 6 },
  { "date": "2021-03-03", "value": 0 },
  { "date": "2021-03-04", "value": 0 },
  { "date": "2021-03-05", "value": 0 },
  { "date": "2021-03-06", "value": 0 },
  { "date": "2021-03-07", "value": 0 },
  { "date": "2021-03-08", "value": 4 }
]

value 필드

위의 프로젝트 및 그룹 수준 엔드포인트 모두 API 응답의 value 필드는 제공된 metric 쿼리 매개변수에 따라 다른 의미를 가집니다:

metric 쿼리 매개변수 응답의 value 설명
deployment_frequency API는 기간 동안 성공적인 배포의 총 수를 반환합니다. Issue 371271은 API를 총 수 대신 일일 평균을 반환하도록 업데이트하는 것을 제안합니다.
change_failure_rate 기간 동안 사고의 수를 배포의 수로 나눈 것입니다. production 환경에만 사용할 수 있습니다.
lead_time_for_changes 기간 동안 모든 MR에 대해 병합 요청 (MR)의 병합과 MR 커밋의 배포 사이의 중앙값입니다.
time_to_restore_service 기간 동안 사건이 열린 시간의 중앙값입니다. production 환경에만 사용할 수 있습니다.

참고: API는 일일 중앙값의 중앙 값으로 monthly 및 all 간격을 계산하여 반환합니다. 이는 반환된 데이터에 약간의 부정확성을 도입할 수 있습니다.