@blueking/open-telemetry 0.0.1 → 0.0.4

package/src/index.ts

@@ -1,55 +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.
- */
-
-export {
-  type BkOTAttributesConfig,
-  type BkOTAttributeValue,
-  type BkOTBatchConfig,
-  type BkOTConfig,
-  type BkOTCustomEventPayload,
-  type BkOTHttpBodyConfig,
-  type BkOTHttpBodyRedactPayload,
-  type BkOTRedactConfig,
-  type BkOTRumConfig,
-  normalizeConfig,
-  type NormalizedBkOTConfig,
-  type SignalExporterConfig,
-} from './core/config';
-export { type BkOTPlugin, type BkOTRuntimeContext, createPlugin, type PluginManager } from './core/plugin';
-export { FilteringSpanProcessor } from './core/processor';
-export { type BkOTInstance, createBkOT, initBkOT } from './core/sdk';
-export { createBlankScreenPlugin } from './plugins/blank-screen';
-export { createCommonInstrumentationsPlugin } from './plugins/common';
-export { createCspViolationPlugin } from './plugins/csp-violation';
-export { createDevicePlugin } from './plugins/device';
-export { createErrorPlugin } from './plugins/error';
-export { createHttpBodyPlugin } from './plugins/http-body';
-export { createLongTaskPlugin } from './plugins/long-task';
-export { createPageViewPlugin } from './plugins/page-view';
-export { createRouteTimingPlugin } from './plugins/route-timing';
-export { createSessionPlugin } from './plugins/session';
-export { createWebVitalsPlugin } from './plugins/web-vitals';
-export { createWebSocketPlugin } from './plugins/websocket';

package/src/plugins/blank-screen.ts

@@ -1,170 +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 { SeverityNumber } from '@opentelemetry/api-logs';
-
-import type { BkOTRumConfig } from '../core/config';
-import type { BkOTPlugin } from '../core/plugin';
-
-const DEFAULT_SELECTOR = 'body';
-const DEFAULT_CHECK_DELAY = 3000;
-const DEFAULT_THRESHOLD = 0.8;
-// 常见 loading mask / spinner 选择器，命中说明页面正在加载而非空白
-const DEFAULT_LOADING_SELECTORS = [
-  '[data-loading="true"]',
-  '[aria-busy="true"]',
-  '.loading',
-  '.is-loading',
-  '.spinner',
-  '.skeleton',
-  '.bk-loading',
-];
-
-const SAMPLE_POINTS: Array<[number, number]> = [
-  [0.5, 0.5],
-  [0.25, 0.25],
-  [0.75, 0.25],
-  [0.25, 0.75],
-  [0.75, 0.75],
-];
-
-const getElementSelector = (element: Element | null) => {
-  if (!element) {
-    return '';
-  }
-  const tag = element.tagName.toLowerCase();
-  if (element.id) {
-    return `${tag}#${element.id}`;
-  }
-  return tag;
-};
-
-const matchesAny = (element: Element | null, selectors: string[]) => {
-  if (!element) return false;
-  return selectors.some(selector => {
-    try {
-      return element.matches(selector) || !!element.closest(selector);
-    } catch {
-      return false;
-    }
-  });
-};
-
-// 页面就绪后再开始计时，避免 SPA / 慢加载场景下检测时机过早
-const whenDocumentReady = (callback: () => void) => {
-  if (typeof document === 'undefined') return;
-  if (document.readyState === 'complete' || document.readyState === 'interactive') {
-    callback();
-    return;
-  }
-  const handler = () => {
-    document.removeEventListener('DOMContentLoaded', handler);
-    callback();
-  };
-  document.addEventListener('DOMContentLoaded', handler);
-};
-
-export const createBlankScreenPlugin = (option: BkOTRumConfig['blankScreen']): BkOTPlugin => {
-  let timer: number | undefined;
-
-  return {
-    name: 'blank-screen',
-    enabled: Boolean(option),
-    init(context) {
-      if (typeof window === 'undefined' || typeof document === 'undefined') {
-        return;
-      }
-
-      const optionObj = typeof option === 'object' ? option : {};
-      const rootSelector = optionObj.rootSelector ?? DEFAULT_SELECTOR;
-      const checkDelay = optionObj.checkDelay ?? DEFAULT_CHECK_DELAY;
-      const threshold = optionObj.threshold ?? DEFAULT_THRESHOLD;
-      const loadingSelectors = [...DEFAULT_LOADING_SELECTORS, ...(optionObj.ignoreSelectors ?? [])];
-
-      // 仅创建一次 counter，避免每次回调都触发一次 meter lookup
-      const counter = context.meter.createCounter('browser.blank_screen.count', {
-        description: 'Number of suspected blank screen detections',
-      });
-
-      whenDocumentReady(() => {
-        timer = window.setTimeout(() => {
-          const root = document.querySelector(rootSelector);
-          let emptyCount = 0;
-          let loadingCount = 0;
-
-          for (const [x, y] of SAMPLE_POINTS) {
-            const element = document.elementFromPoint(window.innerWidth * x, window.innerHeight * y);
-            if (matchesAny(element, loadingSelectors)) {
-              loadingCount += 1;
-              continue;
-            }
-            if (element === root || element === document.body || element === document.documentElement) {
-              emptyCount += 1;
-            }
-          }
-
-          const score = emptyCount / SAMPLE_POINTS.length;
-          // 触发 loading mask 的样本算"非空"，但若全部点都是 loading，则视为待定不上报
-          if (loadingCount === SAMPLE_POINTS.length) {
-            return;
-          }
-          const isBlank = score >= threshold;
-          const attributes = {
-            'bk.rum.blank_screen.score': score,
-            'bk.rum.blank_screen.threshold': threshold,
-            'bk.rum.blank_screen.root': rootSelector,
-            'bk.rum.blank_screen.detected': isBlank,
-            'bk.rum.blank_screen.center_element': getElementSelector(
-              document.elementFromPoint(window.innerWidth / 2, window.innerHeight / 2),
-            ),
-            'bk.rum.blank_screen.dom_node_count': document.body?.getElementsByTagName('*').length ?? 0,
-          };
-
-          if (isBlank) {
-            counter.add(
-              1,
-              context.applyRedact({
-                // 仅放进低基数维度，center_element 等高基数字段只走 log
-                'bk.rum.blank_screen.root': rootSelector,
-              }),
-            );
-            context.emitLog({
-              severityNumber: SeverityNumber.ERROR,
-              severityText: 'ERROR',
-              body: 'browser.blank_screen',
-              attributes,
-            });
-          }
-        }, checkDelay);
-      });
-    },
-    shutdown() {
-      if (timer !== undefined && typeof window !== 'undefined') {
-        window.clearTimeout(timer);
-      }
-    },
-  };
-};

package/src/plugins/common.ts

@@ -1,131 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/naming-convention */
-/*
- * 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 Instrumentation, registerInstrumentations } from '@opentelemetry/instrumentation';
-
-import { shouldIgnoreUrl, shouldPropagateTraceHeader } from '../core/url';
-
-import type { BkOTInstrumentationsConfig } from '../core/config';
-import type { BkOTPlugin, BkOTRuntimeContext } from '../core/plugin';
-
-const URL_KEYS = ['http.url', 'url.full'];
-
-// OTel 官方 instrumentation 内部对每个 URL 调用 matcher.test(url)，
-// 这里把"用户函数 + 自身 endpoint 过滤"包装成具备 .test 的对象，是与 OTel 一致的扩展用法
-const toUrlPredicateMatcher = (predicate: (url: string) => boolean): RegExp =>
-  ({ test: predicate }) as unknown as RegExp;
-
-// 对官方 instrumentation 创建的 span，统一附加 page attributes 与 URL 脱敏
-const decorateSpan = (
-  context: BkOTRuntimeContext,
-  span: {
-    attributes?: Record<string, any>;
-    setAttribute: (key: string, value: any) => void;
-    setAttributes: (attrs: Record<string, any>) => void;
-  },
-) => {
-  span.setAttributes(context.applyRedact(context.config.getPageAttributes()));
-  for (const key of URL_KEYS) {
-    const value = span.attributes?.[key];
-    if (typeof value === 'string') {
-      const redactedAttributes = context.applyRedact({ [key]: context.config.redactUrl(value) });
-      const redactedUrl = redactedAttributes[key];
-      if (typeof redactedUrl === 'string') {
-        span.setAttribute(key, redactedUrl);
-      }
-    }
-  }
-};
-
-export const createCommonInstrumentationsPlugin = (option: BkOTInstrumentationsConfig): BkOTPlugin => {
-  const instrumentations: Instrumentation[] = [];
-
-  return {
-    name: 'official-instrumentations',
-    enabled: Boolean(option.documentLoad || option.fetch || option.xhr || option.userInteraction),
-    async init(context) {
-      const loadedInstrumentations: Instrumentation[] = [];
-      const ignoreUrls = [toUrlPredicateMatcher(url => shouldIgnoreUrl(context.config, url))];
-      const propagateTraceHeaderCorsUrls = [
-        toUrlPredicateMatcher(url => shouldPropagateTraceHeader(context.config, url)),
-      ];
-
-      if (option.documentLoad) {
-        const { DocumentLoadInstrumentation } = await import('@opentelemetry/instrumentation-document-load');
-        loadedInstrumentations.push(
-          new DocumentLoadInstrumentation({
-            semconvStabilityOptIn: 'http',
-          }),
-        );
-      }
-
-      if (option.fetch) {
-        const { FetchInstrumentation } = await import('@opentelemetry/instrumentation-fetch');
-        loadedInstrumentations.push(
-          new FetchInstrumentation({
-            applyCustomAttributesOnSpan: span => decorateSpan(context, span as any),
-            ignoreUrls,
-            propagateTraceHeaderCorsUrls,
-            semconvStabilityOptIn: 'http',
-            ignoreNetworkEvents: false,
-          }),
-        );
-      }
-
-      if (option.xhr) {
-        const { XMLHttpRequestInstrumentation } = await import('@opentelemetry/instrumentation-xml-http-request');
-        loadedInstrumentations.push(
-          new XMLHttpRequestInstrumentation({
-            applyCustomAttributesOnSpan: span => decorateSpan(context, span as any),
-            ignoreUrls,
-            propagateTraceHeaderCorsUrls,
-            semconvStabilityOptIn: 'http',
-            ignoreNetworkEvents: false,
-          }),
-        );
-      }
-
-      if (option.userInteraction) {
-        const { UserInteractionInstrumentation } = await import('@opentelemetry/instrumentation-user-interaction');
-        const userInteractionConfig =
-          typeof option.userInteraction === 'object'
-            ? { eventNames: option.userInteraction.eventNames as Array<keyof HTMLElementEventMap> }
-            : undefined;
-        loadedInstrumentations.push(new UserInteractionInstrumentation(userInteractionConfig));
-      }
-
-      instrumentations.push(...loadedInstrumentations);
-      registerInstrumentations({ instrumentations: loadedInstrumentations });
-    },
-    shutdown() {
-      while (instrumentations.length) {
-        instrumentations.pop()?.disable?.();
-      }
-    },
-  };
-};

package/src/plugins/csp-violation.ts

@@ -1,74 +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 { SeverityNumber } from '@opentelemetry/api-logs';
-
-import type { BkOTRumConfig } from '../core/config';
-import type { BkOTPlugin } from '../core/plugin';
-
-/**
- * 监听 CSP 违规事件并以 log 形式上报，便于排查脚本/资源被 CSP 拦截的问题。
- */
-export const createCspViolationPlugin = (enabled: BkOTRumConfig['cspViolation']): BkOTPlugin => {
-  let teardown: (() => void) | undefined;
-
-  return {
-    name: 'csp-violation',
-    enabled: Boolean(enabled),
-    init(context) {
-      if (typeof window === 'undefined' || typeof document === 'undefined') {
-        return;
-      }
-
-      const handler = (event: SecurityPolicyViolationEvent) => {
-        context.emitLog({
-          severityNumber: SeverityNumber.WARN,
-          severityText: 'WARN',
-          body: 'csp.violation',
-          attributes: {
-            ...context.config.getPageAttributes(),
-            'csp.blocked_uri': context.config.redactUrl(event.blockedURI || ''),
-            'csp.violated_directive': event.violatedDirective,
-            'csp.effective_directive': event.effectiveDirective,
-            'csp.original_policy': event.originalPolicy,
-            'csp.disposition': event.disposition,
-            'csp.source_file': context.config.redactUrl(event.sourceFile || ''),
-            'csp.line_number': event.lineNumber,
-            'csp.column_number': event.columnNumber,
-            'csp.status_code': event.statusCode,
-          },
-        });
-      };
-
-      document.addEventListener('securitypolicyviolation', handler);
-      teardown = () => document.removeEventListener('securitypolicyviolation', handler);
-    },
-    shutdown() {
-      teardown?.();
-      teardown = undefined;
-    },
-  };
-};

package/src/plugins/device.ts

@@ -1,91 +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';
-
-// 复用旧 session 插件的 storageKey，避免升级后丢失现网累计的设备标识
-const DEFAULT_DEVICE_STORAGE_KEY = 'bk_ot_session_id';
-
-const createId = () => {
-  if (typeof crypto !== 'undefined' && typeof crypto.randomUUID === 'function') {
-    return crypto.randomUUID();
-  }
-  return `device-${Date.now()}-${Math.random().toString(16).slice(2)}`;
-};
-
-const readDeviceId = (storageKey: string) => {
-  try {
-    const existed = window.localStorage.getItem(storageKey);
-    if (existed) {
-      return existed;
-    }
-    const deviceId = createId();
-    window.localStorage.setItem(storageKey, deviceId);
-    return deviceId;
-  } catch {
-    return createId();
-  }
-};
-
-const getViewportAttributes = (): Attributes => {
-  if (typeof window === 'undefined') {
-    return {};
-  }
-  const connection = (
-    navigator as Navigator & {
-      connection?: { effectiveType?: string; type?: string };
-    }
-  ).connection;
-
-  return {
-    'browser.viewport.width': window.innerWidth,
-    'browser.viewport.height': window.innerHeight,
-    'browser.screen.width': window.screen?.width,
-    'browser.screen.height': window.screen?.height,
-    'network.effective_type': connection?.effectiveType ?? connection?.type,
-  };
-};
-
-/**
- * 设备级永久标识 + 视口 / 网络元数据。
- * 与 session 插件区分：device 跨会话持久，session 有过期与续期。
- */
-export const createDevicePlugin = (option: BkOTRumConfig['device']): BkOTPlugin => ({
-  name: 'device',
-  enabled: Boolean(option),
-  init(context) {
-    const storageKey =
-      typeof option === 'object' ? (option.storageKey ?? DEFAULT_DEVICE_STORAGE_KEY) : DEFAULT_DEVICE_STORAGE_KEY;
-    const deviceId = typeof window === 'undefined' ? createId() : readDeviceId(storageKey);
-
-    context.setRuntimeAttributes({
-      'device.id': deviceId,
-      ...getViewportAttributes(),
-    });
-  },
-});