@blueking/open-telemetry 0.0.1 → 0.0.4

package/src/plugins/long-task.ts

@@ -1,99 +0,0 @@
-/*
- * Tencent is pleased to support the open source community by making
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
- *
- * Copyright (C) 2017-2025 Tencent.  All rights reserved.
- *
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
- *
- * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
- *
- * ---------------------------------------------------
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
- * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
- * the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
- * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import type { BkOTRumConfig } from '../core/config';
-import type { BkOTPlugin } from '../core/plugin';
-
-const DEFAULT_THRESHOLD_MS = 50;
-
-interface LongTaskAttribution {
-  containerId?: string;
-  containerName?: string;
-  containerSrc?: string;
-  containerType?: string;
-  name?: string;
-}
-
-interface LongTaskEntry extends PerformanceEntry {
-  attribution?: LongTaskAttribution[];
-}
-
-/**
- * Long Task 监控：通过 PerformanceObserver type=longtask 捕获 >= threshold 的主线程长任务。
- * 默认关闭，建议在性能敏感模块按需开启。
- */
-export const createLongTaskPlugin = (option: BkOTRumConfig['longTask']): BkOTPlugin => {
-  let observer: PerformanceObserver | undefined;
-
-  return {
-    name: 'long-task',
-    enabled: Boolean(option),
-    init(context) {
-      if (typeof PerformanceObserver === 'undefined') {
-        return;
-      }
-      const entryTypes = (PerformanceObserver as unknown as { supportedEntryTypes?: string[] }).supportedEntryTypes;
-      if (!entryTypes?.includes('longtask')) {
-        return;
-      }
-
-      const threshold = typeof option === 'object' ? (option.threshold ?? DEFAULT_THRESHOLD_MS) : DEFAULT_THRESHOLD_MS;
-      const counter = context.meter.createCounter('browser.long_task.count', {
-        description: 'Number of long tasks observed (duration >= threshold)',
-      });
-      const durationHistogram = context.meter.createHistogram('browser.long_task.duration', {
-        unit: 'ms',
-        description: 'Duration of long tasks',
-      });
-
-      try {
-        observer = new PerformanceObserver(list => {
-          for (const entry of list.getEntries() as LongTaskEntry[]) {
-            if (entry.duration < threshold) {
-              continue;
-            }
-            const attribution = entry.attribution?.[0];
-            const dimensions = context.applyRedact({
-              ...context.config.getPageAttributes(),
-              ...context.config.getMetricAttributes(),
-              'long_task.name': entry.name,
-              'long_task.attribution': attribution?.name ?? 'unknown',
-            });
-            counter.add(1, dimensions);
-            durationHistogram.record(entry.duration, dimensions);
-          }
-        });
-        observer.observe({ type: 'longtask', buffered: true });
-      } catch {
-        observer = undefined;
-      }
-    },
-    shutdown() {
-      observer?.disconnect();
-      observer = undefined;
-    },
-  };
-};

package/src/plugins/page-view.ts

@@ -1,83 +0,0 @@
-/*
- * Tencent is pleased to support the open source community by making
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
- *
- * Copyright (C) 2017-2025 Tencent.  All rights reserved.
- *
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
- *
- * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
- *
- * ---------------------------------------------------
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
- * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
- * the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
- * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import { subscribeRouteChange } from '../core/route-observer';
-
-import type { BkOTRumConfig } from '../core/config';
-import type { BkOTPlugin } from '../core/plugin';
-
-const getCurrentUrl = () => {
-  if (typeof location === 'undefined') {
-    return '';
-  }
-  return location.href;
-};
-
-export const createPageViewPlugin = (enabled: BkOTRumConfig['pageView']): BkOTPlugin => {
-  const teardownCallbacks: Array<() => void> = [];
-
-  return {
-    name: 'page-view',
-    enabled: Boolean(enabled),
-    init(context) {
-      if (typeof window === 'undefined') {
-        return;
-      }
-
-      // 同 URL 去重：路由库常常因 query/hash 微调反复 push 同一 URL，去重避免重复上报
-      let lastUrl = '';
-
-      const emitPageView = (source: string, previousUrl = lastUrl) => {
-        const currentUrl = getCurrentUrl();
-        if (currentUrl === lastUrl) {
-          return;
-        }
-        lastUrl = currentUrl;
-
-        const span = context.startSpan('browser.page_view', {
-          ...context.config.getPageAttributes(),
-          'url.full': context.config.redactUrl(currentUrl),
-          'url.previous': context.config.redactUrl(previousUrl),
-          'document.referrer': context.config.redactUrl(document.referrer || ''),
-          'bk.rum.event.source': source,
-        });
-        span.end();
-      };
-
-      const unsubscribe = subscribeRouteChange(event => {
-        emitPageView(event.source, event.fromUrl);
-      });
-      emitPageView('load');
-
-      teardownCallbacks.push(unsubscribe);
-    },
-    shutdown() {
-      while (teardownCallbacks.length) {
-        teardownCallbacks.pop()?.();
-      }
-    },
-  };
-};

package/src/plugins/route-timing.ts

@@ -1,89 +0,0 @@
-/*
- * Tencent is pleased to support the open source community by making
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
- *
- * Copyright (C) 2017-2025 Tencent.  All rights reserved.
- *
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
- *
- * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
- *
- * ---------------------------------------------------
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
- * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
- * the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
- * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import { subscribeRouteChange } from '../core/route-observer';
-
-import type { BkOTRumConfig } from '../core/config';
-import type { BkOTPlugin } from '../core/plugin';
-
-/**
- * 估算 SPA 路由切换耗时：路由变更 → 双 raf + 一个宏任务后视为"渲染完成"。
- * 不依赖具体框架，但仅是粗粒度估算；如需精确，业务可走自定义 plugin 在框架钩子内 startSpan/end。
- */
-export const createRouteTimingPlugin = (enabled: BkOTRumConfig['routeTiming']): BkOTPlugin => {
-  const teardownCallbacks: Array<() => void> = [];
-
-  return {
-    name: 'route-timing',
-    enabled: Boolean(enabled),
-    init(context) {
-      if (typeof window === 'undefined' || typeof history === 'undefined') {
-        return;
-      }
-
-      const histogram = context.meter.createHistogram('browser.route_change.duration', {
-        unit: 'ms',
-        description: 'Estimated SPA route change duration (route start to next idle)',
-      });
-
-      const measure = (source: string, fromUrl: string, toUrl: string) => {
-        const startedAt = performance.now();
-        const finalize = () => {
-          const duration = performance.now() - startedAt;
-          const dimensions = context.applyRedact({
-            ...context.config.getPageAttributes(),
-            ...context.config.getMetricAttributes(),
-            'route.change.source': source,
-          });
-          histogram.record(duration, dimensions);
-          const span = context.startSpan('browser.route_change', {
-            ...dimensions,
-            'url.full': context.config.redactUrl(toUrl),
-            'url.previous': context.config.redactUrl(fromUrl),
-            'route.change.duration_ms': duration,
-          });
-          span.end();
-        };
-        // 双 raf 等到下一帧渲染后，再补一个宏任务，覆盖大多数同步组件挂载场景
-        requestAnimationFrame(() => requestAnimationFrame(() => setTimeout(finalize, 0)));
-      };
-
-      const unsubscribe = subscribeRouteChange(event => {
-        if (event.fromUrl === event.toUrl) {
-          return;
-        }
-        measure(event.source, event.fromUrl, event.toUrl);
-      });
-
-      teardownCallbacks.push(unsubscribe);
-    },
-    shutdown() {
-      while (teardownCallbacks.length) {
-        teardownCallbacks.pop()?.();
-      }
-    },
-  };
-};

package/src/plugins/session.ts

@@ -1,127 +0,0 @@
-/*
- * Tencent is pleased to support the open source community by making
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
- *
- * Copyright (C) 2017-2025 Tencent.  All rights reserved.
- *
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
- *
- * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
- *
- * ---------------------------------------------------
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
- * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
- * the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
- * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import type { BkOTRumConfig } from '../core/config';
-import type { BkOTPlugin } from '../core/plugin';
-
-const DEFAULT_SESSION_STORAGE_KEY = 'bk_ot_session';
-const DEFAULT_INACTIVITY_MS = 30 * 60 * 1000;
-
-interface SessionRecord {
-  id: string;
-  // 会话上次活跃时间戳
-  ts: number;
-}
-
-const createId = () => {
-  if (typeof crypto !== 'undefined' && typeof crypto.randomUUID === 'function') {
-    return crypto.randomUUID();
-  }
-  return `session-${Date.now()}-${Math.random().toString(16).slice(2)}`;
-};
-
-const readRecord = (storageKey: string): null | SessionRecord => {
-  try {
-    const raw = window.sessionStorage.getItem(storageKey) ?? window.localStorage.getItem(storageKey);
-    if (!raw) {
-      return null;
-    }
-    const parsed = JSON.parse(raw) as SessionRecord;
-    if (typeof parsed?.id === 'string' && typeof parsed?.ts === 'number') {
-      return parsed;
-    }
-    return null;
-  } catch {
-    return null;
-  }
-};
-
-const writeRecord = (storageKey: string, record: SessionRecord) => {
-  try {
-    const serialized = JSON.stringify(record);
-    window.sessionStorage.setItem(storageKey, serialized);
-    // 同时写到 localStorage，让多 tab / 关闭页后短期内复用同一个 session
-    window.localStorage.setItem(storageKey, serialized);
-  } catch {
-    /* storage 不可用时忽略，运行期仍能继续 */
-  }
-};
-
-const resolveSessionId = (storageKey: string, inactivityMs: number) => {
-  const now = Date.now();
-  const existed = readRecord(storageKey);
-  if (existed && now - existed.ts < inactivityMs) {
-    const record: SessionRecord = { id: existed.id, ts: now };
-    writeRecord(storageKey, record);
-    return record.id;
-  }
-  const record: SessionRecord = { id: createId(), ts: now };
-  writeRecord(storageKey, record);
-  return record.id;
-};
-
-/**
- * 会话级标识：带不活跃过期时间，超过 inactivityMs 视为新会话。
- * 与 device 插件互补：device 是设备终身标识，session 反映"用户连续访问"语义。
- */
-export const createSessionPlugin = (option: BkOTRumConfig['session']): BkOTPlugin => {
-  let teardown: (() => void) | undefined;
-
-  return {
-    name: 'session',
-    enabled: Boolean(option),
-    init(context) {
-      const storageKey =
-        typeof option === 'object' ? (option.storageKey ?? DEFAULT_SESSION_STORAGE_KEY) : DEFAULT_SESSION_STORAGE_KEY;
-      const inactivityMs =
-        typeof option === 'object' ? (option.inactivityMs ?? DEFAULT_INACTIVITY_MS) : DEFAULT_INACTIVITY_MS;
-
-      const refresh = () => {
-        const sessionId = typeof window === 'undefined' ? createId() : resolveSessionId(storageKey, inactivityMs);
-        context.setRuntimeAttributes({ 'session.id': sessionId });
-      };
-
-      refresh();
-
-      if (typeof window === 'undefined' || typeof document === 'undefined') {
-        return;
-      }
-
-      // 用户回到页面时检查是否过期，过期则轮换 sessionId
-      const onVisibilityChange = () => {
-        if (document.visibilityState === 'visible') {
-          refresh();
-        }
-      };
-      document.addEventListener('visibilitychange', onVisibilityChange);
-      teardown = () => document.removeEventListener('visibilitychange', onVisibilityChange);
-    },
-    shutdown() {
-      teardown?.();
-      teardown = undefined;
-    },
-  };
-};

package/src/plugins/web-vitals.ts

@@ -1,159 +0,0 @@
-/*
- * Tencent is pleased to support the open source community by making
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) available.
- *
- * Copyright (C) 2017-2025 Tencent.  All rights reserved.
- *
- * 蓝鲸智云PaaS平台 (BlueKing PaaS) is licensed under the MIT License.
- *
- * License for 蓝鲸智云PaaS平台 (BlueKing PaaS):
- *
- * ---------------------------------------------------
- * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
- * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
- * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
- * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
- * the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
- * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
- * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
- */
-
-import type { BkOTRumConfig } from '../core/config';
-import type { BkOTPlugin } from '../core/plugin';
-import type { Attributes } from '@opentelemetry/api';
-
-interface VitalLike {
-  attribution?: Record<string, unknown>;
-  id?: string;
-  name: string;
-  rating?: string;
-  value: number;
-}
-
-const getNavigationType = () => {
-  const navigation = performance.getEntriesByType('navigation')[0] as PerformanceNavigationTiming | undefined;
-
-  return navigation?.type || 'unknown';
-};
-
-// 仅挑选低基数、可枚举的字段进 metric attributes，避免指标维度爆炸
-const getMetricDimensions = (metric: VitalLike): Attributes => ({
-  'rum.navigation.type': getNavigationType(),
-  'web_vital.name': metric.name,
-  'web_vital.rating': metric.rating,
-});
-
-// 把 attribution 中价值最高的字段抽出来（仅放进 span/log，不放进 metric）
-const pickAttribution = (metric: VitalLike, redactUrl: (url: string) => string): Attributes => {
-  const attr = metric.attribution ?? {};
-  const result: Attributes = {};
-
-  const setIfDefined = (key: string, value: unknown, transform?: (value: string) => string) => {
-    if (value === undefined || value === null) return;
-    if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-      result[key] = typeof value === 'string' && transform ? transform(value) : value;
-    }
-  };
-
-  switch (metric.name) {
-    case 'LCP':
-      setIfDefined('web_vital.lcp.url', attr.url, redactUrl);
-      setIfDefined('web_vital.lcp.target', attr.target);
-      setIfDefined('web_vital.lcp.element_render_delay', attr.elementRenderDelay);
-      setIfDefined('web_vital.lcp.resource_load_duration', attr.resourceLoadDuration);
-      setIfDefined('web_vital.lcp.time_to_first_byte', attr.timeToFirstByte);
-      break;
-    case 'CLS':
-      setIfDefined('web_vital.cls.largest_shift_target', attr.largestShiftTarget);
-      setIfDefined('web_vital.cls.largest_shift_value', attr.largestShiftValue);
-      setIfDefined('web_vital.cls.load_state', attr.loadState);
-      break;
-    case 'INP':
-      setIfDefined('web_vital.inp.interaction_target', attr.interactionTarget);
-      setIfDefined('web_vital.inp.interaction_type', attr.interactionType);
-      setIfDefined('web_vital.inp.input_delay', attr.inputDelay);
-      setIfDefined('web_vital.inp.processing_duration', attr.processingDuration);
-      setIfDefined('web_vital.inp.presentation_delay', attr.presentationDelay);
-      break;
-    case 'FCP':
-      setIfDefined('web_vital.fcp.time_to_first_byte', attr.timeToFirstByte);
-      setIfDefined('web_vital.fcp.load_state', attr.loadState);
-      break;
-    case 'TTFB':
-      setIfDefined('web_vital.ttfb.waiting_duration', attr.waitingDuration);
-      setIfDefined('web_vital.ttfb.dns_duration', attr.dnsDuration);
-      setIfDefined('web_vital.ttfb.connection_duration', attr.connectionDuration);
-      setIfDefined('web_vital.ttfb.request_duration', attr.requestDuration);
-      break;
-    default:
-      break;
-  }
-  return result;
-};
-
-export const createWebVitalsPlugin = (enabled: BkOTRumConfig['webVitals']): BkOTPlugin => ({
-  name: 'web-vitals',
-  enabled: Boolean(enabled),
-  async init(context) {
-    if (typeof window === 'undefined') {
-      return;
-    }
-
-    const { onCLS, onFCP, onINP, onLCP, onTTFB } = await import('web-vitals/attribution');
-    const clsHistogram = context.meter.createHistogram('browser.web_vital.cls', {
-      unit: '1',
-      description: 'Cumulative Layout Shift',
-    });
-    const durationHistogram = context.meter.createHistogram('browser.web_vital.duration', {
-      unit: 'ms',
-      description: 'Web Vitals duration metrics, including FCP, INP, LCP and TTFB',
-    });
-
-    const recordSpan = (metric: VitalLike) => {
-      const span = context.startSpan('browser.web_vital', {
-        ...context.config.getPageAttributes(),
-        ...context.config.getMetricAttributes(),
-        ...getMetricDimensions(metric),
-        // 单条度量唯一 ID 仅放进 span，避免污染 metric 维度
-        'web_vital.id': metric.id,
-        'web_vital.value': metric.value,
-        ...pickAttribution(metric, context.config.redactUrl),
-      });
-      span.end();
-    };
-
-    const recordDurationMetric = (metric: VitalLike) => {
-      durationHistogram.record(
-        metric.value,
-        context.applyRedact({
-          ...context.config.getPageAttributes(),
-          ...context.config.getMetricAttributes(),
-          ...getMetricDimensions(metric),
-        })
-      );
-      recordSpan(metric);
-    };
-
-    onCLS(metric => {
-      clsHistogram.record(
-        metric.value,
-        context.applyRedact({
-          ...context.config.getPageAttributes(),
-          ...context.config.getMetricAttributes(),
-          ...getMetricDimensions(metric),
-        })
-      );
-      recordSpan(metric);
-    });
-    onFCP(recordDurationMetric);
-    onINP(recordDurationMetric);
-    onLCP(recordDurationMetric);
-    onTTFB(recordDurationMetric);
-  },
-});