@blueking/open-telemetry 0.0.6 → 0.0.7

package/dist/plugins/action.d.ts

@@ -0,0 +1,3 @@
+import type { ResolvedRumPluginConfig } from '../core/config';
+import type { BkOTPlugin } from '../core/plugin';
+export declare const createActionPlugin: (option: ResolvedRumPluginConfig["action"]) => BkOTPlugin;

package/dist/plugins/blank-screen.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createBlankScreenPlugin: (option: BkOTRumConfig["blankScreen"]) => BkOTPlugin;
+export declare const createBlankScreenPlugin: (option: ResolvedRumPluginConfig["blankScreen"]) => BkOTPlugin;

package/dist/plugins/csp-violation.d.ts

@@ -1,4 +1,4 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
 /**
  * CSP 违规事件采集插件，通过监听 `securitypolicyviolation` 事件捕获被 CSP 策略拦截的脚本/资源，
@@ -16,4 +16,4 @@ import type { BkOTPlugin } from '../core/plugin';
  * - `blockedURI` / `sourceFile` 中的 URL 类值会经 `redactUrl` 脱敏。
  * - `blockedURI` 是 'inline' / 'eval' 等 CSP 关键字时直接保留，不调用 redactUrl。
  */
-export declare const createCspViolationPlugin: (option: BkOTRumConfig["cspViolation"]) => BkOTPlugin;
+export declare const createCspViolationPlugin: (option: ResolvedRumPluginConfig["cspViolation"]) => BkOTPlugin;

package/dist/plugins/device.d.ts

@@ -1,4 +1,4 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
 /**
  * 设备元数据采集插件，把"设备级"信息写入 SDK 的 runtimeAttributes，
@@ -20,4 +20,4 @@ import type { BkOTPlugin } from '../core/plugin';
  *
  * 与 session 插件的关系：device 跨会话持久（终身），session 有过期与续期（连续访问语义）。
  */
-export declare const createDevicePlugin: (option: BkOTRumConfig["device"]) => BkOTPlugin;
+export declare const createDevicePlugin: (option: ResolvedRumPluginConfig["device"]) => BkOTPlugin;

package/dist/plugins/error.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createErrorPlugin: (option: BkOTRumConfig["error"]) => BkOTPlugin;
+export declare const createErrorPlugin: (option: ResolvedRumPluginConfig["error"]) => BkOTPlugin;

package/dist/plugins/http-body.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTHttpBodyConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createHttpBodyPlugin: (option: false | Required<BkOTHttpBodyConfig>) => BkOTPlugin;
+export declare const createHttpBodyPlugin: (option: ResolvedRumPluginConfig["httpBody"]) => BkOTPlugin;

package/dist/plugins/long-task.d.ts

@@ -1,4 +1,4 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
 /**
  * Long Task 监控插件，通过 PerformanceObserver 捕获主线程上 >= threshold（默认 50ms）的长任务，
@@ -12,4 +12,4 @@ import type { BkOTPlugin } from '../core/plugin';
  * - 仅在 PerformanceObserver 与 `supportedEntryTypes` 包含 `longtask` 的浏览器上启用，否则 init 直接 return；
  *   Firefox 当前不支持 longtask，会自动跳过。
  */
-export declare const createLongTaskPlugin: (option: BkOTRumConfig["longTask"]) => BkOTPlugin;
+export declare const createLongTaskPlugin: (option: ResolvedRumPluginConfig["longTask"]) => BkOTPlugin;

package/dist/plugins/page-view.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createPageViewPlugin: (option: BkOTRumConfig["pageView"]) => BkOTPlugin;
+export declare const createPageViewPlugin: (option: ResolvedRumPluginConfig["pageView"]) => BkOTPlugin;

package/dist/plugins/resource.d.ts

@@ -0,0 +1,3 @@
+import type { ResolvedRumPluginConfig } from '../core/config';
+import type { BkOTPlugin } from '../core/plugin';
+export declare const createResourcePlugin: (option: ResolvedRumPluginConfig["resource"]) => BkOTPlugin;

package/dist/plugins/route-timing.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createRouteTimingPlugin: (option: BkOTRumConfig["routeTiming"]) => BkOTPlugin;
+export declare const createRouteTimingPlugin: (option: ResolvedRumPluginConfig["routeTiming"]) => BkOTPlugin;

package/dist/plugins/session.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createSessionPlugin: (option: BkOTRumConfig["session"]) => BkOTPlugin;
+export declare const createSessionPlugin: (option: ResolvedRumPluginConfig["session"]) => BkOTPlugin;

package/dist/plugins/web-vitals.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createWebVitalsPlugin: (option: BkOTRumConfig["webVitals"]) => BkOTPlugin;
+export declare const createWebVitalsPlugin: (option: ResolvedRumPluginConfig["webVitals"]) => BkOTPlugin;

package/dist/plugins/websocket.d.ts

@@ -1,3 +1,3 @@
-import type { BkOTRumConfig } from '../core/config';
+import type { ResolvedRumPluginConfig } from '../core/config';
 import type { BkOTPlugin } from '../core/plugin';
-export declare const createWebSocketPlugin: (option: BkOTRumConfig["websocket"]) => BkOTPlugin;
+export declare const createWebSocketPlugin: (option: ResolvedRumPluginConfig["websocket"]) => BkOTPlugin;

package/dist/schema/attributes.d.ts

@@ -0,0 +1,50 @@
+/**
+ * RUM 上报字段 key 集中定义。
+ *
+ * 插件里不要散落硬编码字符串，后续字段命名调整只改这里，避免采集端与字段文档逐步漂移。
+ */
+export declare const RUM_ATTRIBUTES: {
+    readonly actionType: "action.type";
+    readonly deploymentEnvironmentName: "deployment.environment.name";
+    readonly browserName: "browser_name";
+    readonly browserVersion: "browser_version";
+    readonly cacheHit: "cache_hit";
+    readonly deviceType: "device_type";
+    readonly durationBucket: "duration_bucket";
+    readonly errorType: "error_type";
+    readonly eventLabel: "event_label";
+    readonly exceptionFingerprint: "exception.fingerprint";
+    readonly exceptionMessageShort: "exception.message_short";
+    readonly exceptionStackTopFrame: "exception.stack_top_frame";
+    readonly longtaskAttributionScript: "longtask.attribution_script";
+    readonly longtaskBlockingDuration: "longtask.blocking_duration";
+    readonly networkEffectiveType: "network.effective_type";
+    readonly nextHopProtocol: "next_hop_protocol";
+    readonly result: "result";
+    readonly serviceName: "service.name";
+    readonly serviceVersion: "service.version";
+    readonly osName: "os_name";
+    readonly sessionHasReplay: "session.has_replay";
+    readonly sessionId: "session.id";
+    readonly sessionStartTime: "session.start_time";
+    readonly spanSubtype: "span_subtype";
+    readonly spanType: "span_type";
+    readonly statusClass: "status_class";
+    readonly targetDomain: "target_domain";
+    readonly targetLabel: "target_label";
+    readonly targetPathTemplate: "target_path_template";
+    readonly targetTag: "target.tag";
+    readonly targetTextShort: "target.text_short";
+    readonly targetValue: "target_value";
+    readonly traceScene: "trace_scene";
+    readonly transferSize: "transfer_size";
+    readonly userId: "user.id";
+    readonly vitalMetric: "vital.metric";
+    readonly vitalRating: "vital.rating";
+    readonly vitalValue: "vital.value";
+    readonly viewId: "view.id";
+    readonly viewLoadingType: "view.loading_type";
+    readonly viewUrl: "view.url";
+    readonly viewUrlPathGroup: "view.url_path_group";
+};
+export type RumAttributeKey = (typeof RUM_ATTRIBUTES)[keyof typeof RUM_ATTRIBUTES];

package/dist/schema/span.d.ts

@@ -0,0 +1,62 @@
+import type { Attributes } from '@opentelemetry/api';
+export declare const RUM_SPAN_RESULT: {
+    readonly abort: "abort";
+    readonly error: "error";
+    readonly success: "success";
+    readonly timeout: "timeout";
+    readonly warning: "warning";
+};
+export declare const RUM_SPAN_TYPE: {
+    readonly action: "action";
+    readonly custom: "custom";
+    readonly document: "document";
+    readonly error: "error";
+    readonly http: "http";
+    readonly longtask: "longtask";
+    readonly resource: "resource";
+    readonly route: "route";
+    readonly vital: "vital";
+};
+export interface RumHttpSpanInput {
+    duration?: number;
+    method?: string;
+    statusCode?: number;
+    subtype: 'fetch' | 'xhr';
+    url?: string;
+    urlPathTemplate?: string;
+}
+export interface RumResourceSpanInput {
+    duration: number;
+    initiatorType?: string;
+    responseStatus?: number;
+    transferSize?: number;
+    url: string;
+    urlPathTemplate?: string;
+}
+export interface RumSpanClassification {
+    duration?: number;
+    errorType?: string;
+    eventLabel?: string;
+    result?: RumSpanResult;
+    spanSubtype: string;
+    spanType: RumSpanType;
+    targetLabel?: string;
+    targetValue?: boolean | number | string;
+    traceScene?: string;
+}
+export type RumSpanResult = (typeof RUM_SPAN_RESULT)[keyof typeof RUM_SPAN_RESULT];
+export type RumSpanType = (typeof RUM_SPAN_TYPE)[keyof typeof RUM_SPAN_TYPE];
+export interface RumUrlTarget {
+    domain?: string;
+    label?: string;
+    pathTemplate?: string;
+}
+export declare const getDurationBucket: (duration: number) => "<100ms" | "100~500ms" | "500ms~2s" | ">2s";
+export declare const getStatusClass: (statusCode: number) => string;
+export declare const getHttpResult: (statusCode: number | undefined) => RumSpanResult;
+export declare const getHttpErrorType: (statusCode: number | undefined) => "none" | "network_timeout" | "http_5xx" | "http_4xx";
+export declare const getVitalResult: (rating: string | undefined) => RumSpanResult;
+export declare const getUrlTarget: (url: string | undefined, pathTemplate?: string) => RumUrlTarget;
+export declare const buildRumSpanAttributes: ({ duration, errorType, eventLabel, result, spanSubtype, spanType, targetLabel, targetValue, traceScene, }: RumSpanClassification) => Attributes;
+export declare const buildRumHttpSpanAttributes: ({ duration, method, statusCode, subtype, url, urlPathTemplate, }: RumHttpSpanInput) => Attributes;
+export declare const buildRumResourceSpanAttributes: ({ duration, initiatorType, responseStatus, transferSize, url, urlPathTemplate, }: RumResourceSpanInput) => Attributes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blueking/open-telemetry",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "OpenTelemetry browser SDK for BK RUM",
   "author": "TencentCloud Real User Monitoring",
   "main": "dist/index.js",
@@ -12,9 +12,12 @@
   ],
   "scripts": {
     "prepublishOnly": "pnpm build && pnpm dts",
-    "build": "vite build && vite build --mode cdn",
+    "build": "vite build && vite build --mode cdn && pnpm dts",
     "build:cdn": "vite build --mode cdn",
     "build:esm": "vite build",
+    "docs:build": "vitepress build wikis",
+    "docs:dev": "vitepress dev wikis",
+    "docs:preview": "vitepress preview wikis",
     "dev": "vite dev",
     "dts": "vue-tsc --project tsconfig.dts.json"
   },
@@ -46,6 +49,7 @@
     "@vue/tsconfig": "^0.9.0",
     "vite": "^8.0.2",
     "vite-bundle-analyzer": "^1.3.2",
+    "vitepress": "2.0.0-alpha.16",
     "vue": "^3.5.34",
     "vue-router": "^5.0.6",
     "vue-tsc": "^3.1.4"