DevOps Research and Assessment (DORA) Key Metrics API

Tier: Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated
History
  • Introduced in GitLab 13.10.
  • 레거시 키/값 쌍 { "<date>" => "<value>" }가 GitLab 14.0에서 페이로드에서 제거되었습니다.
  • time_to_restore_service 메트릭은 GitLab 14.9에서 도입되었습니다.

또한 GraphQL API를 사용하여 DORA 메트릭을 검색할 수 있습니다.

모든 메서드는 적어도 기자 역할이 필요합니다.

프로젝트 수준 DORA 메트릭 가져오기

프로젝트 수준 DORA 메트릭을 가져옵니다. 

GET /projects/:id/dora/metrics
속성 유형 필수 설명
id integer/string yes 인증된 사용자가 액세스할 수 있는 프로젝트의 ID 또는 URL 인코딩 된 경로.
metric string yes deployment_frequency, lead_time_for_changes, time_to_restore_service 또는 change_failure_rate 중 하나.
end_date string no 끝나는 날짜 범위. ISO 8601 날짜 형식, 예를 들어 2021-03-01. 기본값은 현재 날짜입니다.
environment_tiers 문자열 배열 no 환경의 티어. 기본값은 production입니다.
interval string no 버킷 인터벌 중 하나. all, monthly 또는 daily 중 하나. 기본값은 daily입니다.
start_date string no 시작하는 날짜 범위. 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 메트릭 가져오기

History

그룹 수준 DORA 메트릭을 가져옵니다. 

GET /groups/:id/dora/metrics
속성 유형 필수 설명
id integer/string yes 인증된 사용자가 액세스할 수 있는 프로젝트의 ID 또는 URL 인코딩 된 경로.
metric string yes deployment_frequency, lead_time_for_changes, time_to_restore_service 또는 change_failure_rate 중 하나.
end_date string no 끝나는 날짜 범위. ISO 8601 날짜 형식, 예를 들어 2021-03-01. 기본값은 현재 날짜입니다.
environment_tiers 문자열 배열 no 환경의 티어. 기본값은 production입니다.
interval string no 버킷 인터벌 중 하나. all, monthly 또는 daily 중 하나. 기본값은 daily입니다.
start_date string no 시작하는 날짜 범위. 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 장애 사건 수를 배포 수로 나눈 것입니다. 프로덕션 환경에만 사용 가능합니다.
lead_time_for_changes 시간 기간 동안 배포된 모든 MR에 대해 MR의 머지부터 MR 커밋의 배포 사이의 미디안 초 단위 숫자입니다.
time_to_restore_service 시간 기간 동안 장애가 열려 있었던 중간 순간입니다. 프로덕션 환경에만 사용 가능합니다.
note
API는 일일 중간 값의 중간값을 계산하여 monthly 및 all 간격을 반환합니다. 이로 인해 반환된 데이터에 약간의 부정확성이 있을 수 있습니다.