@blueking/open-telemetry 0.0.7 → 0.0.9

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,6 +51,7 @@ export interface BkOTHttpBodyRedactPayload {
     url: string;
 }
 export interface BkOTInstrumentationsConfig {
+    custom?: Instrumentation[];
     documentLoad?: boolean;
     fetch?: boolean;
     userInteraction?: boolean | {
@@ -58,17 +65,32 @@ 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;
@@ -80,43 +102,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 +123,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 +142,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/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 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';