GitLab 개발자를 위한 서비스 메트릭 가이드

서비스 메트릭은 느린 서비스의 실행 시간, SQL 호출 수, 가비지 수집 통계, 메모리 사용량 등을 디버그하는 데 사용할 수 있습니다.

메트릭 모듈

메트릭 모듈은 서비스의 실행을 메트릭하고 다음을 기록할 수 있는 도구입니다.

메트릭 모듈은 각 서비스 실행에 대해 단일 항목으로 구조화된 service_measurement.log로써 이러한 메트릭을 기록합니다.(service_measurement.log)

GitLab.com의 경우, service_measurement.log는 모니터링 솔루션의 일환으로 Elasticsearch 및 Kibana에 투입됩니다.

메트릭 모듈을 사용하면 모든 서비스의 실행을 쉽게 메트릭하고 기록할 수 있습니다. 이를 위해 해당 클래스가 포함된 파일의 마지막 줄에 Measurable을 간단히 추가하면 됩니다.

예를 들어, DummyService 클래스에 모듈을 추가하려면 다음 접근 방식을 사용합니다.

class DummyService
  def execute
  # ...
  end
end

DummyService.prepend(Measurable)

EE 네임스페이스에서 EE 기능을 사용하는 모듈을 추가하는 경우, EE 모듈을 먼저 추가한 후 Measurable을 추가해야 합니다.

이렇게 하면 Measurable이 조상 체인의 맨 아래에 있어서 EE 기능의 실행을 메트릭할 수 있습니다.

class DummyService
  def execute
  # ...
  end
end

DummyService.prepend_mod_with('DummyService')
DummyService.prepend(Measurable)

추가 속성을 로깅해야 하는 경우, 서비스 클래스에 extra_attributes_for_measurement를 정의할 수 있습니다.

def extra_attributes_for_measurement
  {
    project_path: @project.full_path,
    user: current_user.name
  }
end

서비스에 메트릭 모듈이 삽입된 후, 일반적인 피처 플래그 뒤에 숨겨져 있습니다. 실제 사용하려면 원하는 서비스에 대해 해당 피처 플래그를 활성화해야 합니다.

다음 예에서 :gitlab_service_measuring_projects_import_service 피처 플래그를 사용하여 Projects::ImportService의 메트릭 기능을 활성화합니다.

ChatOps에서:

/chatops run feature set gitlab_service_measuring_projects_import_service true