통찰력

Tier: Ultimate
Offering: GitLab.com, Self-Managed형, GitLab Dedicated

프로젝트 및 그룹의 통찰력을 구성하여 다음과 같은 데이터를 탐색할 수 있습니다.

  • 지정된 기간 동안 생성된 문제 및 닫힌 문제들.
  • Merge Request이 Merge되기까지의 평균 시간.
  • 트리아지 항목.

그룹에 해당하는 사용자 정의 통찰력 보고서도 생성할 수 있습니다.

통찰력 보기

필수 컴포넌트:

  • 프로젝트 통찰력의 경우, 프로젝트에 액세스하고 Merge Request 및 문제에 대한 정보를 볼 수 있는 권한이 있어야 합니다.
  • 그룹 통찰력의 경우, 그룹을 볼 수 있는 권한이 있어야 합니다.

프로젝트 또는 그룹에 대한 통찰력을 보려면:

  1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트 또는 그룹을 찾습니다.
  2. 분석 > 통찰을 선택합니다.
  3. 보고서를 보려면 보고서 선택 드롭다운 디렉터리을 선택합니다.

딥 링크를 사용하여 통찰 보고서에 액세스

깊은 링크 URL을 사용하여 사용자를 특정 통찰력 보고서로 이동시킬 수 있습니다.

깊은 링크를 생성하려면 보고서 키를 통찰 보고서 URL의 끝에 추가합니다. 예를 들어, bugsCharts라는 GitLab 보고서가 다음과 같은 깊은 링크 URL을 가집니다. https://gitlab.com/gitlab-org/gitlab/insights/#/bugsCharts.

통찰력 차트 상호 작용

통찰력 차트를 상호 작용하여 그룹 활동에 대한 세부정보를 볼 수 있습니다.

다른 보고서 표시

통찰력 페이지에서 사용 가능한 보고서 중 하나를 표시하려면 보고서 선택 드롭다운 디렉터리에서 원하는 보고서를 선택합니다.

막대 차트 주석 보기

차트 위의 각 막대에 마우스를 올리면 주석을 볼 수 있습니다.

차트 확대

통찰력은 지난 90일 동안의 데이터를 표시합니다. 90일 범위의 하위 집합에서만 데이터를 표시하도록 확대할 수 있습니다.

이를 위해 일시 정지 아이콘()을 선택하고 수평 축을 따라 이동합니다. 다음 작업을 수행할 수 있습니다.

  • 시작 날짜를 변경하려면 왼쪽 일시 정지 아이콘을 왼쪽이나 오른쪽으로 이동합니다.
  • 종료 날짜를 변경하려면 오른쪽 일시 정지 아이콘을 왼쪽이나 오른쪽으로 이동합니다.

차트에서 차원 제외

기본적으로 통찰력은 차트에서 모든 사용 가능한 차원을 표시합니다.

차원을 제외하려면 차트 아래의 범례에서 차원의 이름을 선택하세요.

차트 드릴 다운

query.data_sourceissuables인 차트의 모든 데이터를 볼 수 있습니다.

특정 월에 특정 우선순위 또는 심각도의 데이터를 드릴 다운하려면 다음을 수행합니다.

  • 차트에서 드릴 다운하려는 막대 스택을 선택합니다.

프로젝트 통찰력 구성

필수 컴포넌트:

  • 프로젝트 구성에 따라 적어도 개발자 역할이 있어야 합니다.

프로젝트 통찰력은 프로젝트의 .gitlab/insights.yml 파일을 사용하여 구성됩니다. 프로젝트에 구성 파일이 없는 경우 그룹 구성을 사용합니다.

.gitlab/insights.yml 파일은 다음을 정의하는 YAML 파일입니다.

  • 보고서의 차트 구조 및 순서.
  • 프로젝트 또는 그룹의 보고서에 표시되는 차트의 스타일.

프로젝트 통찰력을 구성하려면 다음을 수행하세요.

  • 파일 .gitlab/insights.yml을 만들어서:
    • 로컬에서 프로젝트의 루트 디렉터리에 만들고 변경 사항을 푸시합니다.
    • UI에서:
      1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
      2. 파일 디렉터리 위에서 커밋하려는 브랜치를 선택하고 플러스 아이콘을 선택한 후 새 파일을 선택하세요.
      3. 파일 이름 텍스트 상자에 .gitlab/insights.yml을 입력하세요.
      4. 큰 텍스트 상자에서 파일 내용을 업데이트하세요.
      5. 변경 사항 커밋을 선택하세요.

구성 파일을 만든 후에는 프로젝트 그룹에도 사용할 수 있습니다.

그룹 통찰력 구성

GitLab은 통찰력을 기본 구성 파일에서 읽습니다.

그룹 통찰력을 구성하려면 다음을 수행하세요.

  1. 그룹에 속한 프로젝트에서 .gitlab/insights.yml`파일을 생성합니다.
  2. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 그룹을 찾습니다.
  3. 설정 > 일반을 선택합니다.
  4. 분석을 확장하고 통찰 섹션을 찾습니다.
  5. .gitlab/insights.yml 구성 파일이 포함된 프로젝트를 선택하세요.
  6. 변경 사항 저장을 선택하세요.

통찰력 구성 파일

.gitlab/insights.yml 파일에서 다음을 정의합니다.

  • 구성 매개변수는 차트 동작을 정의합니다.
  • 각 보고서에는 고유한 키와 가져올 차트의 컬렉션이 있습니다.
  • 각 차트 정의는 키-값 쌍으로 이루어진 해시로 구성됩니다.

다음 예제는 하나의 차트가 있는 보고서를 표시하는 단일 정의를 보여줍니다.

bugsCharts:
  title: "버그 차트"
  charts:
    - title: "월별 생성된 버그"
      description: "매월 생성된 오픈 버그"
      type: bar
      query:
        data_source: issuables
        params:
          issuable_type: issue
          issuable_state: opened
          filter_labels:
            - bug
          group_by: month
          period_limit: 24

통찰력 구성 매개변수

다음 표는 차트 매개변수를 나열합니다.

키워드 설명
title 차트 제목. 이는 통찰 페이지에 표시됩니다.
description 개별 차트에 대한 설명. 이는 해당 차트 위에 표시됩니다.
type 차트 유형: bar, line, 또는 stacked-bar.
query 차트의 데이터 소스 및 필터링 조건을 정의하는 해시입니다.

title

title을 사용하여 차트 제목을 업데이트합니다. 이는 통찰 보고서에 표시됩니다.

예시:

monthlyBugsCreated:
  title: "월별 생성된 버그"

description

description을 사용하여 차트에 대한 설명을 추가합니다. 이는 제목 아래에 해당 차트 위에 표시됩니다.

예시:

monthlyBugsCreated:
  title: "월별 생성된 버그"
  description: "매월 생성된 오픈 버그"

type

type을 사용하여 차트 유형을 정의합니다.

지원되는 값:

이름 예시:
bar 통찰력 예시 막대 차트
bar (시계열, group_by가 사용된 경우) 통찰력 예시 막대 시계열 차트
line 통찰력 예시 선 차트
stacked-bar 통찰력 예시 쌓인 막대 차트

dora 데이터 소스는 barline 차트 유형을 지원합니다.

예시:

monthlyBugsCreated:
  title: "월별 생성된 버그"
  type: bar

query

query를 사용하여 차트의 데이터 소스 및 필터링 조건을 정의합니다.

예시:

monthlyBugsCreated:
  title: "월별 생성된 버그"
  description: "매월 생성된 오픈 버그"
  type: bar
  query:
    data_source: issuables
    params:
      issuable_type: issue
      issuable_state: opened
      filter_labels:
        - bug
      collection_labels:
        - S1
        - S2
        - S3
        - S4
      group_by: week
      period_limit: 104

data_source 파라미터 없이 있는 이전 형식은 아직 지원됩니다.

monthlyBugsCreated:
  title: "월별 생성된 버그"
  description: "매월 생성된 오픈 버그"
  type: bar
  query:
    issuable_type: issue
    issuable_state: opened
    filter_labels:
      - bug
    collection_labels:
      - S1
      - S2
      - S3
      - S4
    group_by: week
    period_limit: 104

query.data_source

data_source를 사용하여 데이터를 노출하는 데이터 소스를 정의합니다.

지원되는 값:

  • issuables: Merge Request 또는 이슈 데이터를 노출합니다.
  • dora: DORA 메트릭스를 노출합니다.

issuable 쿼리 매개변수

query.params.issuable_type

query.params.issuable_type을 사용하여 차트를 만들 issuable의 유형을 정의합니다.

지원되는 값:

  • issue: 차트가 이슈 데이터를 표시합니다.
  • merge_request: 차트가 Merge Request 데이터를 표시합니다.
query.params.issuable_state

query.params.issuable_state을 사용하여 쿼리된 issuable의 현재 상태로 필터링합니다.

기본적으로 opened 상태 필터가 적용됩니다.

지원되는 값:

  • opened: 열린 이슈 또는 Merge Request입니다.
  • closed: 닫힌 이슈 또는 Merge Request입니다.
  • locked: 토론이 잠긴 이슈 또는 Merge Request입니다.
  • merged: Merge된 Merge Request입니다.
  • all: 모든 상태의 이슈 또는 Merge Request입니다.
query.params.filter_labels

query.params.filter_labels를 사용하여 쿼리된 issuable에 적용된 라벨로 필터링합니다.

기본적으로 라벨 필터가 적용되지 않습니다. 선택된 issuable에 적용된 모든 정의된 라벨이 있어야 합니다.

예시::

monthlyBugsCreated:
  title: "월간 회귀 생성됨"
  type: bar
  query:
    data_source: issuables
    params:
      issuable_type: issue
      issuable_state: opened
      filter_labels:
        - bug
        - regression
query.params.collection_labels

query.params.collection_labels를 사용하여 설정된 라벨에 따라 issuable을 그룹화합니다. 기본적으로 그룹화가 적용되지 않습니다.

예시:

weeklyBugsBySeverity:
  title: "주간 심각도별 버그"
  type: stacked-bar
  query:
    data_source: issuables
    params:
      issuable_type: issue
      issuable_state: opened
      filter_labels:
        - bug
      collection_labels:
        - S1
        - S2
        - S3
        - S4
query.group_by

query.group_by를 사용하여 차트의 X축을 정의합니다.

지원되는 값:

  • day: 날짜별 데이터 그룹화
  • week: 주별 데이터 그룹화
  • month: 월별 데이터 그룹화
query.period_limit

query.period_limit을 사용하여 issuable을 쿼리하는 기간을 정의합니다 (query.period_field를 사용).

기간은 query.group_by에 정의된 값과 관련이 있습니다. 예를 들어, query.group_by: 'day'로 정의했고 query.period_limit: 365로 정의했다면, 차트는 마지막 365일간의 데이터를 표시합니다.

기본적으로 query.group_by에 따라 기본값이 적용됩니다.

query.group_by 기본값
day 30
week 4
month 12

query.period_field

query.period_field를 사용하여 issuable을 그룹화하기 위해 타임스탬프 필드를 정의합니다.

지원되는 값:

  • created_at (기본): created_at 필드를 사용하여 데이터를 그룹화합니다.
  • closed_at: closed_at 필드를 사용하여 데이터를 그룹화합니다 (이슈에만 해당).
  • merged_at: merged_at 필드를 사용하여 데이터를 그룹화합니다 (Merge Request에만 해당).

period_field는 다음과 같이 자동으로 설정됩니다:

  • query.issuable_stateclosed인 경우 closed_at
  • query.issuable_statemerged인 경우 merged_at
  • 그 외에는 created_at
note
이 버그가 해결될 때까지 created_at 대신에 merged_at이 표시될 수 있습니다. created_at이 대신 사용됩니다.

DORA 쿼리 매개변수

dora 데이터 소스를 사용하여 DORA 차트 정의를 생성하는 데에 dora 특정 쿼리를 사용하세요.

예시:

dora:
  title: "DORA 차트"
  charts:
    - title: "DORA 배포 빈도"
      type: bar # 또는 line
      query:
        data_source: dora
        params:
          metric: deployment_frequency
          group_by: day
          period_limit: 10
      projects:
        only:
          - 38
    - title: "DORA 변경의 리드 타임"
      description: "변경의 리드 타임"
      type: bar
      query:
        data_source: dora
        params:
          metric: lead_time_for_changes
          group_by: day
          environment_tiers:
            - staging
          period_limit: 30
query.metric

query.metric을 사용하여 DORA metrics를 정의합니다.

지원되는 값:

  • deployment_frequency (기본)
  • lead_time_for_changes
  • time_to_restore_service
  • change_failure_rate
query.group_by

query.group_by를 사용하여 차트의 X축을 정의합니다.

지원되는 값:

  • day (기본): 날짜별 데이터 그룹화
  • month: 월별 데이터 그룹화
query.period_limit

query.period_limit을 사용하여 지난 시간 동안 메트릭을 쿼리하는 범위를 정의합니다 (기본값: 15). 최대 기간은 180일 또는 6개월입니다.

query.environment_tiers

query.environment_tiers를 사용하여 계산에 포함할 환경의 배열을 정의합니다.

지원되는 값:

  • production(기본)
  • staging
  • testing
  • development
  • other

projects

issuable이 쿼리되는 프로젝트를 제한하기 위해 projects를 사용하세요:

  • 그룹의 인사이트에 .gitlab/insights.yml이 사용되는 경우, 모든 프로젝트가 기본적으로 사용됩니다. projects를 사용하여 쿼리될 프로젝트를 정의합니다.
  • 프로젝트의 인사이트에 .gitlab/insights.yml이 사용되는 경우, 다른 프로젝트를 지정해도 결과가 나타나지 않습니다. 기본적으로 프로젝트가 사용됩니다.

projects.only

쿼리된 issuable에 대해 지정된 프로젝트를 지정하기 위해 projects.only를 사용하세요.

이 매개변수에 나열된 프로젝트는 다음 조건에서 무시됩니다:

  • 존재하지 않을 경우
  • 현재 사용자가 읽기 권한을 갖고 있지 않을 경우
  • 그룹 밖에 위치하는 경우

예시:

monthlyBugsCreated:
  title: "월간 생성된 버그"
  description: "월별로 생성된 오픈된 버그"
  type: bar
  query:
    data_source: issuables
    params:
      issuable_type: issue
      issuable_state: opened
      filter_labels:
        - bug
  projects:
    only:
      - 3                         # 프로젝트 ID를 사용할 수 있습니다
      - groupA/projectA           # 또는 전체 프로젝트 경로
      - groupA/subgroupB/projectC # 서브그룹의 프로젝트를 포함할 수 있습니다
      - groupB/project            # 그룹 밖의 프로젝트는 무시됩니다

완전한 인사이트 구성 예시

.projectsOnly: &projectsOnly
  projects:
    only:
      - 3
      - groupA/projectA
      - groupA/subgroupB/projectC

bugsCharts:
  title: "버그 차트"
  charts:
    - title: "월간 생성된 버그"
      description: "월별로 생성된 오픈된 버그"
      type: bar
      <<: *projectsOnly
      query:
        data_source: issuables
        params:
          issuable_type: issue
          issuable_state: opened
          filter_labels:
            - bug
          group_by: month
          period_limit: 24
    
    - title: "주간 심각도별 버그"
      type: stacked-bar
      <<: *projectsOnly
      query:
        data_source: issuables
        params:
          issuable_type: issue
          issuable_state: opened
          filter_labels:
            - bug
          collection_labels:
            - S1
            - S2
            - S3
            - S4
          group_by: week
          period_limit: 104
    
    - title: "팀별 월간 버그"
      type: line
      <<: *projectsOnly
      query:
        data_source: issuables
        params:
          issuable_type: merge_request
          issuable_state: opened
          filter_labels:
            - bug
          collection_labels:
            - Manage
            - Plan
            - Create
          group_by: month
          period_limit: 24