@blueking/open-telemetry 0.0.21 → 0.0.22

package/dist/core/config.d.ts

@@ -1,7 +1,6 @@
 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 { BkOTSessionConfig } from '../plugins/session';
 import type { BkOTPlugin } from './plugin';
@@ -20,7 +19,6 @@ export interface BkOTApplicationConfig {
 export interface BkOTAttributesConfig {
     custom?: () => Attributes;
     error?: () => Attributes;
-    metric?: () => Attributes;
     page?: () => Attributes;
 }
 export type BkOTAttributeValue = boolean | number | string;
@@ -33,7 +31,7 @@ export interface BkOTBatchConfig {
 export interface BkOTBeforeSendEvent {
     attributes: Record<string, unknown>;
     name: string;
-    signal: 'log' | 'span';
+    signal: 'span';
 }
 export interface BkOTContextConfig {
     attributes?: BkOTAttributesConfig;
@@ -68,25 +66,8 @@ export interface BkOTPrivacyConfig {
     /** 所有写入 attribute 的 URL 都会先经过此函数。 */
     redactUrl?: (url: string) => string;
 }
-export interface BkOTRequestBodyConfig {
-    allowedContentTypes?: Array<RegExp | string>;
-    capture?: 'all' | 'errors';
-    maxSize?: number;
-    redact: (payload: BkOTRequestBodyRedactPayload) => string | undefined;
-}
-export interface BkOTRequestBodyRedactPayload {
-    body: string;
-    contentType?: string;
-    kind: 'request' | 'response';
-    method?: string;
-    statusCode?: number;
-    truncated: boolean;
-    type: 'fetch' | 'xhr';
-    url?: string;
-}
 export interface BkOTRequestConfig {
     allowedTracingUrls?: BkOTUrlMatcher | BkOTUrlMatcher[];
-    body?: BkOTRequestBodyConfig;
     excludedUrls?: BkOTUrlMatcher | BkOTUrlMatcher[];
     beforeSend?: (event: BkOTRequestEvent, context: BkOTRequestContext) => boolean | void;
 }
@@ -96,7 +77,6 @@ export type BkOTRequestContext = {
     response?: Response;
     type: 'fetch';
 } | {
-    requestBody?: Document | null | XMLHttpRequestBodyInit;
     type: 'xhr';
     xhr: XMLHttpRequest;
 };
@@ -116,7 +96,7 @@ export interface BkOTTrackingConfig {
     blankScreen?: BkOTBlankScreenPluginOptions | boolean;
     cspViolation?: boolean;
     device?: BkOTDevicePluginOptions | boolean;
-    error?: BkOTErrorPluginOptions | boolean;
+    error?: boolean;
     longTask?: BkOTLongTaskPluginOptions | boolean;
     request?: BkOTRequestConfig | boolean;
     resource?: boolean;
@@ -127,9 +107,12 @@ export interface BkOTTrackingConfig {
 }
 export type BkOTTrackingConsent = 'granted' | 'not-granted';
 export interface BkOTTransportConfig {
-    endpoint?: string;
+    batch?: BkOTBatchConfig;
+    concurrencyLimit?: number;
+    endpoint: string;
     headers?: Record<string, string>;
-    signals?: SignalExportersInputConfig;
+    processor?: BkOTSpanProcessorMode;
+    timeoutMillis?: number;
     token?: string;
 }
 export type BkOTUrlMatcher = ((url: string) => boolean) | RegExp | string;
@@ -142,9 +125,6 @@ export interface BkOTViewConfig {
     /** 返回低基数路由分组，例如 `/trace/:id`。 */
     getPathGroup?: (url: string) => string | undefined;
 }
-export interface MetricExporterInputConfig extends SignalExporterInputConfig {
-    intervalMillis?: number;
-}
 export interface ResolvedApplicationConfig {
     environment: string;
     name: string;
@@ -157,7 +137,6 @@ export interface ResolvedBkOTConfig {
     enabled: boolean;
     extensions: BkOTExtensionsConfig;
     hooks: ResolvedConfigHooks;
-    metricIntervalMillis: number;
     resourceAttributes: Attributes;
     session: ResolvedSessionConfig;
     spanBatch?: BkOTBatchConfig;
@@ -172,7 +151,6 @@ export interface ResolvedConfigHooks {
     beforeSend?: (event: BkOTBeforeSendEvent) => boolean | void;
     getCustomAttributes: () => Attributes;
     getErrorAttributes: () => Attributes;
-    getMetricAttributes: () => Attributes;
     getPageAttributes: () => Attributes;
     getViewPathGroup: (url: string) => string;
     redactAttributes: (attributes: Attributes) => Attributes;
@@ -182,30 +160,14 @@ export interface ResolvedSessionConfig extends BkOTSessionConfig {
     sampleRate: number;
 }
 export interface ResolvedTransportConfig {
+    concurrencyLimit?: number;
     endpoint: string;
-    logs: false | SignalExporterConfig;
-    metrics: false | SignalExporterConfig;
-    traces: false | SignalExporterConfig;
+    headers?: Record<string, string>;
+    timeoutMillis?: number;
 }
 export interface ResolvedViewConfig {
     excludedActivityUrls?: BkOTUrlMatcher | BkOTUrlMatcher[];
     loadingTime: boolean;
     tracking: 'auto' | 'manual';
 }
-export interface SignalExporterConfig {
-    concurrencyLimit?: number;
-    endpoint: string;
-    headers?: Record<string, string>;
-    timeoutMillis?: number;
-}
-export type SignalExporterInputConfig = Partial<SignalExporterConfig>;
-export interface SignalExportersInputConfig {
-    logs?: false | SignalExporterInputConfig;
-    metrics?: false | MetricExporterInputConfig;
-    traces?: false | TraceExporterInputConfig;
-}
-export interface TraceExporterInputConfig extends SignalExporterInputConfig {
-    batch?: BkOTBatchConfig;
-    processor?: BkOTSpanProcessorMode;
-}
 export declare const resolveConfig: (config: BkOTOptions) => ResolvedBkOTConfig;

package/dist/core/hash.d.ts

@@ -0,0 +1,2 @@
+/** 非密码学稳定 hash，仅用于生成浏览器本地 storage key。 */
+export declare const hashString: (input: string) => string;

package/dist/core/plugin.d.ts

@@ -1,8 +1,7 @@
 import type { BkOTActivityEvent } from './action-activity';
 import type { ResolvedBkOTConfig } from './config';
 import type { BkOTSessionLifecycleEvent, BkOTUserContext, BkOTViewCommand, BkOTViewContext } from './runtime-context';
-import type { Attributes, Meter, Span, SpanKind, TimeInput, Tracer } from '@opentelemetry/api';
-import type { Logger, LogRecord } from '@opentelemetry/api-logs';
+import type { Attributes, Span, SpanKind, TimeInput, Tracer } from '@opentelemetry/api';
 import type { Instrumentation } from '@opentelemetry/instrumentation';
 export interface BkOTPlugin {
     enabled?: ((config: ResolvedBkOTConfig) => boolean) | boolean;
@@ -13,13 +12,9 @@ export interface BkOTPlugin {
 }
 export interface BkOTRuntimeContext {
     config: ResolvedBkOTConfig;
-    logger: Logger;
-    meter: Meter;
     tracer: Tracer;
     /** 对外提供的属性脱敏入口，所有插件在 emit 前都应过一次 */
     applyRedact: (attributes: Attributes) => Attributes;
-    /** 包装 logger.emit，自动应用 redact 与 runtime attributes */
-    emitLog: (record: LogRecord) => void;
     flush: () => Promise<void>;
     getRuntimeAttributes: () => Attributes;
     getRuntimeAttributesAt: (timestamp: number) => Attributes;
@@ -36,7 +31,7 @@ export interface BkOTRuntimeContext {
     setRuntimeAttributes: (attributes: Attributes, changedAt?: number) => void;
     /** 更新用户上下文；user.id 由接入方传入，SDK 原样透传 */
     setUser: (user: BkOTUserContext) => void;
-    /** 更新当前 View 上下文，后续 span/log 会自动带上 view.* 关联字段 */
+    /** 更新当前 View 上下文，后续 span 会自动带上 view.* 关联字段 */
     setView: (view: BkOTViewContext, changedAt?: number) => void;
     startSpan: (name: string, attributes?: Attributes, options?: BkOTStartSpanOptions) => Span;
 }

package/dist/core/processor.d.ts

@@ -1,19 +1,7 @@
-import { AggregationTemporality } from '@opentelemetry/sdk-metrics';
 import type { ResolvedBkOTConfig } from './config';
 import type { Attributes, Context } from '@opentelemetry/api';
-import type { LogRecordProcessor, SdkLogRecord } from '@opentelemetry/sdk-logs';
-import type { InstrumentType, PushMetricExporter, ResourceMetrics } from '@opentelemetry/sdk-metrics';
 import type { ReadableSpan, Span, SpanProcessor } from '@opentelemetry/sdk-trace-base';
 export declare const REQUEST_DISCARD_ATTRIBUTE = "bk.rum.request.discard";
-export declare class FilteringLogRecordProcessor implements LogRecordProcessor {
-    private readonly inner;
-    private readonly config?;
-    constructor(inner: LogRecordProcessor, config?: ResolvedBkOTConfig | undefined);
-    enabled(options: Parameters<NonNullable<LogRecordProcessor['enabled']>>[0]): boolean;
-    forceFlush(): Promise<void>;
-    onEmit(logRecord: SdkLogRecord, context?: Context): void;
-    shutdown(): Promise<void>;
-}
 /**
  * 给所有 span 固化创建时的运行时上下文，并在 onEnd 阶段过滤自身上报请求和无 RUM 上下文 span。
  */
@@ -27,11 +15,3 @@ export declare class FilteringSpanProcessor implements SpanProcessor {
     onStart(span: Span, parentContext: Context): void;
     shutdown(): Promise<void>;
 }
-export declare class FilteringMetricExporter implements PushMetricExporter {
-    private readonly inner;
-    constructor(inner: PushMetricExporter);
-    export(metrics: ResourceMetrics, resultCallback: Parameters<PushMetricExporter['export']>[1]): void;
-    forceFlush(): Promise<void>;
-    selectAggregationTemporality(instrumentType: InstrumentType): AggregationTemporality;
-    shutdown(): Promise<void>;
-}

package/dist/core/runtime-context.d.ts

@@ -43,7 +43,7 @@ export interface BkOTViewContext {
  * 管理 SDK 运行期公共属性快照。
  *
  * 这里仅保存“后续事件都需要带上”的低成本上下文，Session/View/用户切换时更新快照，
- * 插件发 span/log 时读取当前快照即可，避免每个插件重复维护公共字段。
+ * 插件发 Span 时读取当前快照即可，避免每个插件重复维护公共字段。
  */
 export declare class RumRuntimeContext {
     private readonly actionHistory;

package/dist/core/sdk.d.ts

@@ -1,9 +1,8 @@
 import { type Attributes, type Span } from '@opentelemetry/api';
-import { type Instrumentation } from '@opentelemetry/instrumentation';
 import { type BkOTActionEventPayload, type BkOTCustomEventPayload, type BkOTOptions, type BkOTTrackingConsent, type ResolvedBkOTConfig } from './config';
 import { type BkOTPlugin, type BkOTRuntimeContext, type BkOTStartSpanOptions } from './plugin';
 import { type BkOTSessionLifecycleEvent, type BkOTStartViewOptions, type BkOTUserContext } from './runtime-context';
-import type { LogRecord } from '@opentelemetry/api-logs';
+import type { Instrumentation } from '@opentelemetry/instrumentation';
 export interface BkOTInstance extends Omit<BkOTRuntimeContext, 'notifyActivity' | 'onActivity' | 'onViewChange' | 'onViewCommand' | 'registerInstrumentations' | 'setView'> {
     flush: () => Promise<void>;
     reportAction: (payload: BkOTActionEventPayload) => void;
@@ -20,13 +19,11 @@ export interface BkOTInstance extends Omit<BkOTRuntimeContext, 'notifyActivity'
 }
 /**
  * 浏览器 RUM SDK 的生命周期入口。Provider 在构造时创建，插件和全局 patch 则随 start、授权变更和
- * shutdown 安装或卸载；Session 决定统一作用于 trace、metric、log 三类信号。
+ * shutdown 安装或卸载；Session 决定统一作用于所有 RUM span。
  */
 export declare class BkOpenTelemetry implements BkOTInstance {
     private readonly activityObserver;
     private readonly flushProviders;
-    private readonly loggerProvider;
-    private readonly meterProvider;
     private phase;
     private pluginManager?;
     private readonly registeredInstrumentations;
@@ -42,15 +39,12 @@ export declare class BkOpenTelemetry implements BkOTInstance {
     private createPluginManager;
     readonly applyRedact: (attributes: Attributes) => Attributes;
     readonly config: ResolvedBkOTConfig;
-    readonly emitLog: (record: LogRecord) => void;
     readonly flush: () => Promise<void>;
     readonly getRuntimeAttributes: () => Attributes;
     readonly getRuntimeAttributesAt: (timestamp: number) => Attributes;
     readonly isSampled: () => boolean;
     readonly isSessionActive: () => boolean;
     readonly isViewActive: () => boolean;
-    readonly logger: BkOTRuntimeContext['logger'];
-    readonly meter: BkOTRuntimeContext['meter'];
     readonly notifySessionLifecycle: (event: BkOTSessionLifecycleEvent) => void;
     readonly onSessionLifecycle: (listener: (event: BkOTSessionLifecycleEvent) => void) => () => boolean;
     readonly registerInstrumentations: (instrumentations: Instrumentation[]) => void;

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

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

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-export { type BkOTActionEventPayload, type BkOTApplicationConfig, type BkOTAttributesConfig, type BkOTAttributeValue, type BkOTBatchConfig, type BkOTBeforeSendEvent, type BkOTContextConfig, type BkOTCustomEventPayload, type BkOTExtensionsConfig, type BkOTOptions, type BkOTPrivacyConfig, type BkOTRequestBodyConfig, type BkOTRequestBodyRedactPayload, type BkOTRequestConfig, type BkOTRequestContext, type BkOTRequestEvent, type BkOTTrackingConfig, type BkOTTrackingConsent, type BkOTTransportConfig, type BkOTUrlMatcher, type BkOTViewConfig, type MetricExporterInputConfig, resolveConfig, type ResolvedApplicationConfig, type ResolvedBkOTConfig, type ResolvedConfigHooks, type ResolvedTransportConfig, type ResolvedViewConfig, type SignalExporterConfig, type SignalExportersInputConfig, type TraceExporterInputConfig, } from './core/config';
+export { type BkOTActionEventPayload, type BkOTApplicationConfig, type BkOTAttributesConfig, type BkOTAttributeValue, type BkOTBatchConfig, type BkOTBeforeSendEvent, type BkOTContextConfig, type BkOTCustomEventPayload, type BkOTExtensionsConfig, type BkOTOptions, type BkOTPrivacyConfig, type BkOTRequestConfig, type BkOTRequestContext, type BkOTRequestEvent, type BkOTTrackingConfig, type BkOTTrackingConsent, type BkOTTransportConfig, type BkOTUrlMatcher, type BkOTViewConfig, resolveConfig, type ResolvedApplicationConfig, type ResolvedBkOTConfig, type ResolvedConfigHooks, type ResolvedTransportConfig, type ResolvedViewConfig, } from './core/config';
 export { type BkOTPlugin, type BkOTRuntimeContext, createPlugin, type PluginManager } from './core/plugin';
-export { FilteringLogRecordProcessor, FilteringMetricExporter, FilteringSpanProcessor } from './core/processor';
+export { FilteringSpanProcessor } from './core/processor';
 export { type BkOTSessionLifecycleEvent, type BkOTStartViewOptions, type BkOTUserContext, type BkOTViewContext, RumRuntimeContext, } from './core/runtime-context';
 export { BkOpenTelemetry, type BkOTInstance } from './core/sdk';
 export { type BkOTActionPluginOptions, createActionPlugin } from './plugins/action';
@@ -9,7 +9,7 @@ export { type BkOTBlankScreenPluginOptions, createBlankScreenPlugin } from './pl
 export { createCommonInstrumentationsPlugin } from './plugins/common';
 export { createCspViolationPlugin } from './plugins/csp-violation';
 export { type BkOTDevicePluginOptions, createDevicePlugin } from './plugins/device';
-export { type BkOTErrorPluginOptions, createErrorPlugin } from './plugins/error';
+export { createErrorPlugin } from './plugins/error';
 export { type BkOTLongTaskPluginOptions, createLongTaskPlugin } from './plugins/long-task';
 export { createResourcePlugin } from './plugins/resource';
 export { type BkOTSessionConfig, createSessionPlugin } from './plugins/session';