DevOps Research and Assessment (DORA) 키 메트릭스 API
Tier: Ultimate
Offering: GitLab.com, Self-Managed, GitLab Dedicated
DORA 메트릭스를 GraphQL API로 가져올 수도 있습니다.
모든 방법은 적어도 기자 역할이 필요합니다.
프로젝트 수준 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
| 문자열 | no | 버킷링 간격 중 하나입니다. all, monthly, daily 중 하나입니다. 기본값은 daily입니다.
|
start_date
| 문자열 | 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 메트릭스 가져오기
그룹 수준의 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
| 문자열 | 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 Merge과 MR 커밋의 배포 사이의 중간 숫자입니다. |
time_to_restore_service
| 인시던트가 시간 범위 동안 열려 있던 중간 시간(초)입니다. 프로덕션 환경에만 사용할 수 있습니다. |
API는 일일 중앙값 값의 중앙값을 계산함으로써
monthly 및 all 간격을 반환합니다. 이로 인해 반환된 데이터가 약간 부정확할 수 있습니다.
도움말