@imqa/instrumentation-connectivity

개요

@imqa/instrumentation-connectivity는 웹 애플리케이션의 네트워크 연결 상태 변경을 캡처하고 보고합니다. 이 스키마는 OpenTelemetry 형식을 사용하여 온라인/오프라인 상태 전환을 추적하도록 설계되었습니다.

스키마 구조

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

스팬

각 스팬은 브라우저에서 발생하는 연결 상태 변경을 나타내며, 다음과 같은 내용을 포함합니다:

• traceId: 트레이스의 고유 식별자
• spanId: 스팬의 고유 식별자
• name: 작업의 이름 (일반적으로 "connectivity")
• kind: 스팬의 타입 (1 = INTERNAL)
• startTimeUnixNano: 에포크 이후의 연결 상태 변경 시간 (나노초)
• endTimeUnixNano: 종료 시간 (순간적 이벤트의 경우 시작 시간과 동일) (나노초)
• status: 결과 상태 (0 = OK, 1 = ERROR, 2 = UNSET)

스팬 속성

각 스팬은 다음과 같은 속성을 포함합니다:

| 속성 | 타입 | 설명 | | ------------------------ | --------- | -------------------------------------------------------- | | location.href | string | 현재 페이지 URL | | environment | string | 환경 이름 | | deployment.environment | string | 배포 환경 | | screen.name | string | 화면/페이지 이름 | | screen.type | string | 화면/페이지 타입 | | session.id | string | 사용자 세션 식별자 | | url.full | string | 완전한 URL | | online | boolean | 네트워크 연결 상태 (true = 온라인, false = 오프라인) | | span.type | string | 스팬 타입 ("connectivity") |

사용 방법

계측 설정

(boolean 또는 InstrumentationConfig, 선택)

네트워크 연결 상태 계측을 활성화하거나 비활성화합니다. true로 설정하면 네트워크 상태(온라인/오프라인 변화)가 자동으로 계측됩니다.

export interface InstrumentationConfig {
    enabled?: boolean;
}

기타

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

• 서비스, 브라우저 및 환경을 식별하는 리소스 정보
• 연결 상태 변경을 나타내는 하나 이상의 스팬
• 연결 상태(온라인/오프라인)에 대한 상세 정보를 포함하는 각 스팬

연결 상태 변경을 모니터링하면 네트워크 상태가 불안정할 때의 사용자 경험을 이해하는 데 도움이 됩니다. 이러한 메트릭은 오프라인이나 간헐적인 네트워크 환경에서 작동해야 하는 애플리케이션에 매우 유용합니다.

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

라이센스

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