내부 분석 리뷰 가이드라인

Analytics Instrumentation 리뷰 절차, 역할별 책임, 이벤트·메트릭·CLI 변경 시 검토 항목을 설명합니다.

이 페이지는 Analytics Instrumentation 리뷰에 대한 입문 자료를 포함합니다. 코드 리뷰에 대한 더 넓은 조언과 일반적인 모범 사례는 코드 리뷰 가이드 를 참조하세요. 리뷰 프로세스 # 머지 리퀘스트(MR)가 내부 분석 코드에 접촉하거나 사용하는 경우 Analytics Instrumentation 리뷰가 의무적으로 요구됩니다. 이에는 다음이 포함되지만 이에 한정되지 않습니다: 메트릭, 예를 들어: config/metrics 의 파일. ee/config/metrics 의 파일. schema.json . 내부 이벤트, 예를 들어 config/events 의 파일. Analytics Instrumentation 툴링, 예를 들어 Internal events CLI . 대부분의 경우 Analytics Instrumentation 리뷰는 자동으로 추가되지만, 자동화가 관련 변경을 감지하지 못한 경우 수동으로 요청할 수도 있습니다. 역할 및 프로세스 # Analytics Instrumentation 리뷰에는 세 가지 역할이 참여합니다: 머지 리퀘스트 작성자 : 분석 변경을 수행하는 개발자. Analytics Instrumentation 리뷰어 : Analytics Instrumentation 팀의 구성원. 엣지 케이스와 예외를 포함한 전체 리뷰를 담당합니다. 외부 리뷰어 : 해당 Stage의 일반적인 분석 변경을 승인하는 Stage 레벨 CODEOWNER. 아래 체크리스트 범위를 벗어나는 항목은 Analytics Instrumentation 팀에 위임합니다. 머지 리퀘스트 작성자가 해야 할 사항 # Analytics Instrumentation 리뷰가 필요한지 결정합니다. 변경 사항이 Analytics Instrumentation 도메인과 관련이 없는 경우 Analytics Instrumentation 리뷰를 건너뛰고 라벨을 제거할 수 있습니다. Analytics Instrumentation 리뷰가 필요하고 자동으로 할당되지 않은 경우, ~analytics instrumentation 및 ~analytics instrumentation::review pending 라벨을 추가합니다. MR의 일부로 이벤트에 대한 변경이 있는 경우: 사용 가능한 테스트 도구 중 하나를 사용하여 이벤트가 로컬에서 발화되는지 확인합니다. MR의 일부로 메트릭에 대한 변경이 있는 경우: require_relative 'spec/support/helpers/service_ping_helpers.rb'; ServicePingHelpers.get_current_usage_metric_value(key_path) 를 실행하여 새 메트릭이 Service Ping 페이로드에서 사용 가능하고 데이터를 보고하는지 확인합니다. key_path 는 새 메트릭의 key_path 로 대체합니다. 리뷰어 룰렛을 사용하여 작성자가 아닌 Analytics Instrumentation 리뷰어 를 할당합니다. 필요에 따라 다른 리뷰를 할당합니다. ~analytics instrument