@blueking/open-telemetry 0.0.8 → 0.0.10

package/dist/core/config.d.ts

@@ -1,3 +1,9 @@
+import type { BkOTActionPluginOptions } from '../plugins/action';
+import type { BkOTBlankScreenPluginOptions } from '../plugins/blank-screen';
+import type { BkOTDevicePluginOptions } from '../plugins/device';
+import type { BkOTErrorPluginOptions } from '../plugins/error';
+import type { BkOTLongTaskPluginOptions } from '../plugins/long-task';
+import type { BkOTSessionPluginOptions } from '../plugins/session';
 import type { BkOTPlugin } from './plugin';
 import type { BkOTUserContext } from './runtime-context';
 import type { Attributes } from '@opentelemetry/api';
@@ -45,8 +51,25 @@ export interface BkOTHttpBodyRedactPayload {
     url: string;
 }
 export interface BkOTInstrumentationsConfig {
+    custom?: Instrumentation[];
     documentLoad?: boolean;
     fetch?: boolean;
+    /**
+     * 控制 fetch/xhr 请求向哪些后台 API 注入 W3C `traceparent`（内含 OpenTelemetry traceId）请求头。
+     *
+     * 同源请求始终注入；该配置用于把跨域后台 API 也纳入注入范围（在同源基础上扩展）：
+     * - `'all'`：所有请求都注入（含跨域，使用前确认涉及的隐私/CORS 影响）。
+     * - `string`：URL 包含该子串即注入，例如 `'api.example.com'`。
+     * - `RegExp`：URL 匹配该正则即注入。
+     * - 以上字符串/正则的数组：命中任意一个即注入。
+     * - `(url: string) => boolean`：完全自定义判断。
+     *
+     * 注意：向跨域服务注入自定义头会触发 CORS 预检，目标服务需在
+     * `Access-Control-Allow-Headers` 中放行 `traceparent`（以及按需的 `tracestate`）。
+     *
+     * 默认未配置时仅同源请求注入，保持既有行为。
+     */
+    propagateTraceHeaderUrls?: BkOTPropagateTraceHeaderUrls;
     userInteraction?: boolean | {
         eventNames?: string[];
     };
@@ -58,21 +81,37 @@ export interface BkOTOptions {
     autoStart?: boolean;
     debug?: boolean;
     enabled?: boolean;
-    instrumentations?: Instrumentation[];
-    plugins?: BkOTPlugin[];
+    instrumentations?: BkOTInstrumentationsConfig;
+    plugins?: BkOTPluginsConfig;
     privacy?: BkOTPrivacyConfig;
     route?: BkOTRouteConfig;
-    rum?: BkOTRumOptions;
     sampling?: BkOTSamplingConfig;
     spanBatch?: BkOTBatchConfig;
     spanProcessor?: BkOTSpanProcessorMode;
     transport?: BkOTTransportConfig;
     user?: BkOTUserContext;
 }
+export interface BkOTPluginsConfig {
+    action?: BkOTActionPluginOptions | boolean;
+    blankScreen?: BkOTBlankScreenPluginOptions | boolean;
+    cspViolation?: boolean;
+    custom?: BkOTPlugin[];
+    device?: BkOTDevicePluginOptions | boolean;
+    error?: BkOTErrorPluginOptions | boolean;
+    httpBody?: BkOTHttpBodyConfig | boolean;
+    longTask?: BkOTLongTaskPluginOptions | boolean;
+    pageView?: boolean;
+    resource?: boolean;
+    routeTiming?: boolean;
+    session?: BkOTSessionPluginOptions | boolean;
+    websocket?: boolean;
+    webVitals?: boolean;
+}
 export interface BkOTPrivacyConfig {
     redactAttributes?: (attributes: Attributes) => Attributes;
     redactUrl?: (url: string) => string;
 }
+export type BkOTPropagateTraceHeaderUrls = 'all' | ((url: string) => boolean) | Array<RegExp | string> | RegExp | string;
 export interface BkOTRouteConfig {
     /**
      * 返回低基数路由分组，例如 `/trace/:id`。
@@ -80,43 +119,6 @@ export interface BkOTRouteConfig {
      */
     getPathGroup?: (url: string) => string | undefined;
 }
-export interface BkOTRumOptions {
-    instrumentations?: BkOTInstrumentationsConfig;
-    plugins?: BkOTRumPluginOptions;
-}
-export interface BkOTRumPluginOptions {
-    cspViolation?: boolean;
-    device?: boolean | {
-        storageKey?: string;
-    };
-    httpBody?: BkOTHttpBodyConfig | boolean;
-    pageView?: boolean;
-    resource?: boolean;
-    routeTiming?: boolean;
-    websocket?: boolean;
-    webVitals?: boolean;
-    action?: boolean | {
-        eventNames?: Array<'click' | 'input' | 'keydown' | 'pointerdown' | 'scroll' | 'submit'>;
-    };
-    blankScreen?: {
-        checkDelay?: number;
-        ignoreSelectors?: string[];
-        rootSelector?: string;
-        threshold?: number;
-    } | boolean;
-    error?: {
-        maxPerWindow?: number;
-        windowMs?: number;
-    } | boolean;
-    longTask?: {
-        threshold?: number;
-    } | boolean;
-    session?: {
-        inactivityMs?: number;
-        maxLifetimeMs?: number;
-        storageKey?: string;
-    } | boolean;
-}
 export interface BkOTSamplingConfig {
     rate?: number;
 }
@@ -138,11 +140,10 @@ export interface ResolvedBkOTConfig {
     debug: boolean;
     enabled: boolean;
     hooks: ResolvedConfigHooks;
-    instrumentations: Instrumentation[];
+    instrumentations: BkOTInstrumentationsConfig;
     metricIntervalMillis: number;
-    plugins: BkOTPlugin[];
+    plugins: BkOTPluginsConfig;
     resourceAttributes: Attributes;
-    rum: ResolvedRumConfig;
     sampling: ResolvedSamplingConfig;
     spanBatch?: BkOTBatchConfig;
     spanProcessor: BkOTSpanProcessorMode;
@@ -158,50 +159,6 @@ export interface ResolvedConfigHooks {
     redactAttributes: (attributes: Attributes) => Attributes;
     redactUrl: (url: string) => string;
 }
-export type ResolvedPluginOption<TConfig extends object = object> = (TConfig & {
-    enabled: true;
-}) | {
-    enabled: false;
-};
-export interface ResolvedRumConfig {
-    plugins: ResolvedRumPluginConfig;
-    instrumentations: Required<Pick<BkOTInstrumentationsConfig, 'documentLoad' | 'fetch' | 'xhr'>> & {
-        userInteraction: BkOTInstrumentationsConfig['userInteraction'];
-    };
-}
-export interface ResolvedRumPluginConfig {
-    cspViolation: ResolvedPluginOption;
-    device: ResolvedPluginOption<{
-        storageKey?: string;
-    }>;
-    error: ResolvedPluginOption<{
-        maxPerWindow: number;
-        windowMs: number;
-    }>;
-    httpBody: ResolvedPluginOption<Required<BkOTHttpBodyConfig>>;
-    longTask: ResolvedPluginOption<{
-        threshold: number;
-    }>;
-    pageView: ResolvedPluginOption;
-    resource: ResolvedPluginOption;
-    routeTiming: ResolvedPluginOption;
-    websocket: ResolvedPluginOption;
-    webVitals: ResolvedPluginOption;
-    action: ResolvedPluginOption<{
-        eventNames: Array<'click' | 'input' | 'keydown' | 'pointerdown' | 'scroll' | 'submit'>;
-    }>;
-    blankScreen: ResolvedPluginOption<{
-        checkDelay: number;
-        ignoreSelectors?: string[];
-        rootSelector?: string;
-        threshold: number;
-    }>;
-    session: ResolvedPluginOption<{
-        inactivityMs: number;
-        maxLifetimeMs: number;
-        storageKey?: string;
-    }>;
-}
 export interface ResolvedSamplingConfig {
     rate: number;
 }

package/dist/core/telemetry-attributes.d.ts

@@ -0,0 +1,3 @@
+import type { Attributes } from '@opentelemetry/api';
+export declare const getMetricViewAttributes: (runtimeAttributes: Attributes) => Attributes;
+export declare const getInstrumentationSpanRuntimeAttributes: (runtimeAttributes: Attributes, fallbackViewPathGroup?: string) => Attributes;

package/dist/core/url.d.ts

@@ -1,4 +1,4 @@
 import type { ResolvedBkOTConfig } from './config';
 export declare const isBkOTEndpoint: (config: ResolvedBkOTConfig, url: string) => boolean;
 export declare const shouldIgnoreUrl: (config: ResolvedBkOTConfig, url: string) => boolean;
-export declare const shouldPropagateTraceHeader: (_config: ResolvedBkOTConfig, url: string) => boolean;
+export declare const shouldPropagateTraceHeader: (config: ResolvedBkOTConfig, url: string) => boolean;

package/dist/index.d.ts

@@ -1,21 +1,21 @@
-export { type BkOTActionEventPayload, type BkOTAppConfig, type BkOTAttributesConfig, type BkOTAttributeValue, type BkOTBatchConfig, type BkOTCustomEventPayload, type BkOTHttpBodyConfig, type BkOTHttpBodyRedactPayload, type BkOTInstrumentationsConfig, type BkOTOptions, type BkOTPrivacyConfig, type BkOTRumOptions, type BkOTRumPluginOptions, type BkOTSamplingConfig, type BkOTTransportConfig, resolveConfig, type ResolvedBkOTConfig, type ResolvedConfigHooks, type ResolvedPluginOption, type ResolvedRumConfig, type ResolvedRumPluginConfig, type ResolvedTransportConfig, type SignalExporterConfig, type SignalExportersInputConfig, } from './core/config';
+export { type BkOTActionEventPayload, type BkOTAppConfig, type BkOTAttributesConfig, type BkOTAttributeValue, type BkOTBatchConfig, type BkOTCustomEventPayload, type BkOTHttpBodyConfig, type BkOTHttpBodyRedactPayload, type BkOTInstrumentationsConfig, type BkOTOptions, type BkOTPluginsConfig, type BkOTPrivacyConfig, type BkOTPropagateTraceHeaderUrls, type BkOTSamplingConfig, type BkOTTransportConfig, resolveConfig, type ResolvedBkOTConfig, type ResolvedConfigHooks, type ResolvedTransportConfig, type SignalExporterConfig, type SignalExportersInputConfig, } from './core/config';
 export { type BkOTPlugin, type BkOTRuntimeContext, createPlugin, type PluginManager } from './core/plugin';
 export { FilteringSpanProcessor } from './core/processor';
 export { type BkOTUserContext, type BkOTViewContext, RumRuntimeContext } from './core/runtime-context';
 export { BkOpenTelemetry, type BkOTInstance } from './core/sdk';
 export { RUM_ATTRIBUTES, type RumAttributeKey } from './schema/attributes';
 export { buildRumSpanAttributes, getDurationBucket, RUM_SPAN_RESULT, RUM_SPAN_TYPE, type RumSpanClassification, type RumSpanResult, type RumSpanType, } from './schema/span';
-export { createActionPlugin } from './plugins/action';
-export { createBlankScreenPlugin } from './plugins/blank-screen';
+export { createActionPlugin, type BkOTActionEventName, type BkOTActionPluginOptions } from './plugins/action';
+export { createBlankScreenPlugin, type BkOTBlankScreenPluginOptions } 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 { createDevicePlugin, type BkOTDevicePluginOptions } from './plugins/device';
+export { createErrorPlugin, type BkOTErrorPluginOptions } from './plugins/error';
 export { createHttpBodyPlugin } from './plugins/http-body';
-export { createLongTaskPlugin } from './plugins/long-task';
+export { createLongTaskPlugin, type BkOTLongTaskPluginOptions } from './plugins/long-task';
 export { createPageViewPlugin } from './plugins/page-view';
 export { createResourcePlugin } from './plugins/resource';
 export { createRouteTimingPlugin } from './plugins/route-timing';
-export { createSessionPlugin } from './plugins/session';
+export { createSessionPlugin, type BkOTSessionPluginOptions } from './plugins/session';
 export { createWebVitalsPlugin } from './plugins/web-vitals';
 export { createWebSocketPlugin } from './plugins/websocket';