@imqa/instrumentation-webvitals

개요

@imqa/instrumentation-webvitals는 IMQA 모니터링 시스템에서 웹 성능 메트릭을 캡처합니다. 이 계측은 OpenTelemetry 형식을 사용하여 웹 애플리케이션의 핵심 성능 지표를 추적하도록 설계되었습니다.

스키마 구조

스키마는 JSON 문서로, JSON Schema Draft 2020-12 사양을 따릅니다. 웹 성능 Telemetry 데이터의 구조화된 형식을 정의하며, 다음과 같은 주요 구성요소를 포함합니다:

WebVitals 스팬

WebVitals 스팬은 웹 성능 지표를 캡처합니다:

• traceId: 트레이스의 고유 식별자
• spanId: 스팬의 고유 식별자
• name: 성능 지표의 이름 (예: "LCP", "FID", "CLS")
• kind: 스팬의 타입 (1 = INTERNAL)
• startTimeUnixNano: 에포크 이후의 시작 시간 (나노초)
• endTimeUnixNano: 에포치 이후의 종료 시간 (나노초)
• status: 결과 상태 (0 = OK)

WebVitals 스팬 속성

| 속성 | 타입 | 설명 | |-----------|------|-------------| | metric.name | string | 성능 지표의 이름 (LCP, FID, CLS 등) | | metric.value | integer | 지표의 값 (밀리초 또는 비율) | | metric.rating | string | 지표의 등급 (good, needs-improvement, poor) | | location.href | string | 현재 페이지 URL | | environment | string | 환경 이름 | | deployment.environment | string | 배포 환경 | | screen.name | string | 화면/페이지 이름 | | screen.type | string | 화면/페이지 타입 | | session.id | string | 사용자 세션 식별자 | | url.full | string | 요청 전체 URL (예: "https://example.com/articles/4?s=1&t1" ) | | component | string | 컴포넌트 (WebVitals) | | span.type | string | 스팬 타입 (WebVitals) |

사용 방법

이 스키마는 IMQA 모니터링 시스템으로 Telemetry 데이터를 처리하고 저장하기 전에 웹 성능 지표를 위한 Telemetry 데이터를 검증하는 데 사용됩니다. 이는 모든 필수 필드가 올바르게 포함되어 있는지 확인합니다.

계측 설정

(boolean, 선택)

Web Vitals 계측을 활성화하거나 비활성화합니다. true로 설정하면 Core Web Vitals 지표가 자동으로 계측됩니다.

자세한 계측 정보는 @imqa/instrumentation-webvitals 참조

interface InstrumentationConfig {
  enabled?: boolean;
}

• enabled: 계측을 활성화할지 여부를 설정합니다. 기본값은 true입니다.

기타

유효한 WebVitals Telemetry 객체는 다음과 같은 내용을 포함합니다:

• 서비스, 브라우저 및 환경을 식별하는 리소스 정보
• LCP, FID, CLS와 같은 웹 성능 지표를 캡처하는 WebVitals 스팬
• 지표의 값과 등급을 포함하는 성능 메트릭

데이터는 다양한 Telemetry 수집 및 분석 도구와 호환되는 OpenTelemetry 프로토콜 형식을 따릅니다.

라이센스

Copyright (c) 2024-2025 ONYCOM CO., LTD. All rights reserved.