이벤트 추적 계획 및 거버넌스
이벤트 추적 계획은 애플리케이션 코드와 원격 분석을 사용하는 사람들 사이의 검토 가능한 계약입니다. 한 행의 의미, 이벤트가 존재하는 이유, 허용되는 필드, 변경 사항의 소유자, 이벤트의 유효성을 검사하는 방법을 설명합니다. 해당 계약이 없으면 기술적으로 유효한 JSON 페이로드는 여전히 오해의 소지가 있는 요율, 깨진 유입 경로, 개인 정보 보호 위험 또는 누구도 소유하지 않은 대시보드를 생성할 수 있습니다.
이벤트 계약당 하나의 행을 사용합니다.
| 필드 | 예 |
|---|---|
| 이벤트 이름 | checkout_completed |
| 곡물 | 모든 내부 시도 후 논리적 체크아웃 1회 |
| 결정 | 터미널 오류가 증가한 결제 단계 식별 |
| 소유자 | 결제 엔지니어링 |
| 트리거 | 성공 또는 최종 실패 |
| 필수 입력사항 | event_id, status, checkout_step, duration_ms, timestamp_utc |
| 선택 필드 | account_id, plan, release, error_type |
| 금지된 콘텐츠 | 결제 세부정보, 이메일, 요청 본문, 원시 오류 메시지 |
| 보유 | 제품 승인 운영 창구 |
| 스키마 버전 | 1 |
| 소비자 | 체크아웃 안정성 대시보드 및 단말기 오류 알림 |
| 검증 | 합성 성공, 거부, 시간 초과, 재시도 및 중복 픽스쳐 |
필드 이전에 의미 정의
결정과 그레인부터 시작하십시오. '체크아웃 이벤트'가 모호합니다. "모든 내부 시도 후 한 번의 논리적 체크아웃"은 검토자에게 COUNT(*)가 나타내는 내용과 재시도가 추가 행을 생성해야 하는지 여부를 알려줍니다.
최종 결과와 제외 사항을 작성합니다. 중단된 체크아웃을 관찰할 수 없는 경우 해당 제한 사항을 명시하십시오. 비동기 이행 단계 전에 성공 이벤트가 발생하는 경우 checkout_completed 라벨을 지정하지 마세요.
모든 분야를 분류하다
각 필드에 대해 다음을 문서화하십시오.
- 종류와 단위
- 필수, 선택 또는 조건부 필수 상태
- 허용되는 값 또는 최대 길이
- 진실의 근원
- 개인 정보인지, 가명 정보인지, 민감한 정보인지, 제한 없는 것인지 여부
- 목적: 필터링, 그룹화, 조인, 계산, 상관 관계 또는 디버그
- 값을 사용할 수 없을 때의 동작
status, error_type, feature 및 기타 그룹별 차원에 대해 제어된 분류법을 사용합니다. 승인된 조사 또는 조인에서 사용하는 경우에만 높은 카디널리티 식별자를 유지하세요. 임의의 중첩 페이로드와 제한되지 않은 문자열을 금지합니다.
다운스트림 종속성 기록
이벤트에 따라 저장된 쿼리, 대시보드, 알림, 내보내기, 실험 및 보고서를 나열합니다. 해당 소비자가 업데이트되거나 의도적으로 버전이 지정될 때까지는 필드 이름 바꾸기가 완료되지 않습니다.
각 운영 쿼리에 대해 분모, 시간대, 도착 지연 정책, 재시도 처리, 최소 볼륨 및 예상 픽스처 결과를 기록합니다. 계획은 문서화되지 않은 메트릭 이름을 다시 명시하지 말고 쿼리 또는 관련 SQL 레시피에 연결해야 합니다.
계약 변경에 따른 변경 사항 검토
추가 옵션 필드는 일반적으로 기존 의미를 변경하는 것보다 안전합니다. 유형, 단위, 그레인 또는 범주 의미가 변경되면 새 필드 또는 스키마 버전을 사용하십시오. 출시 중:
- 추적 계획을 업데이트하고 필요한 검토를 받으세요.
- 결정론적 픽스처를 추가하거나 업데이트합니다.
- 이전 버전과 호환되는 필드를 갖춘 프로듀서를 배포합니다.
- 스키마 및 null 비율을 검사합니다.
- 소비자를 업데이트합니다.
- 기록 및 배포 기간이 허용한 후에만 호환성 논리를 제거하세요.
모든 런타임이 준비되고 대체 계획이 문서화될 때까지 새로 도입된 구성 값을 필수로 설정하지 마십시오.
운영 케이던스 할당
일정에 따라 사고 발생 후 중요한 계획을 검토합니다. 사용되지 않는 필드, 소유되지 않은 대시보드, 범주 폭증, 증가하는 null 비율, 예상치 못한 스키마 버전, 더 이상 정당한 목적이 없는 식별자를 찾아보세요. 더 이상 비용과 위험이 발생하지 않는 데이터에 대한 보존 기간을 삭제하거나 단축합니다.
이벤트 추적 계획 템플릿으로 시작한 다음 이벤트 스키마 설계, 표준 와이드 이벤트 및 CI의 계측 테스트를 사용하여 계약을 구현하고 시행합니다.