@blueking/open-telemetry 0.0.16 → 0.0.18

package/dist/core/config.d.ts

@@ -63,7 +63,9 @@ export interface BkOTOptions {
 export interface BkOTPrivacyConfig {
     /** 初始化时的采集授权状态；运行期可通过 setTrackingConsent 更新。 */
     trackingConsent?: BkOTTrackingConsent;
+    /** 在所有 RUM 自定义插件 emit 前统一过滤属性。 */
     redactAttributes?: (attributes: Attributes) => Attributes;
+    /** 所有写入 attribute 的 URL 都会先经过此函数。 */
     redactUrl?: (url: string) => string;
 }
 export interface BkOTRequestBodyConfig {

package/dist/core/metric.d.ts

@@ -0,0 +1,2 @@
+export declare const CLS_HISTOGRAM_BOUNDARIES: number[];
+export declare const DURATION_HISTOGRAM_BOUNDARIES: number[];

package/dist/core/sdk.d.ts

@@ -18,6 +18,10 @@ export interface BkOTInstance extends Omit<BkOTRuntimeContext, 'notifyActivity'
     use: (plugin: BkOTPlugin) => BkOTInstance;
     useInstrumentation: (instrumentation: Instrumentation) => BkOTInstance;
 }
+/**
+ * 浏览器 RUM SDK 的生命周期入口。Provider 在构造时创建，插件和全局 patch 则随 start、授权变更和
+ * shutdown 安装或卸载；Session 决定统一作用于 trace、metric、log 三类信号。
+ */
 export declare class BkOpenTelemetry implements BkOTInstance {
     private readonly activityObserver;
     private readonly flushProviders;

package/dist/core/signal.d.ts

@@ -0,0 +1,3 @@
+import type { BkOTRuntimeContext } from './plugin';
+export type BkOTSignal = 'logs' | 'metrics' | 'traces';
+export declare const shouldRecordSignal: (context: BkOTRuntimeContext, signal: BkOTSignal) => boolean;

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

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

package/dist/core/throttle.d.ts

@@ -6,12 +6,12 @@ export declare const hashString: (input: string) => string;
 export interface ThrottleResult {
     /** 是否允许本次上报 */
     allowed: boolean;
-    /** 当前窗口内同 fingerprint 的总触发次数（含本次，含被丢弃次数），便于下游感知是否被节流 */
+    /** 当前窗口内同 fingerprint 的触发序号（含本次） */
     count: number;
 }
 /**
  * 时间窗节流：同一 key 在 windowMs 窗口内最多允许 maxPerWindow 次通过；
- * 超出则被拦截，但 `count` 仍累加，便于下游感知风暴规模。
+ * 超出则被拦截，但 `count` 仍累加，供调用方维护内部统计。
  *
  * 长会话场景下避免 records 无限累积——按窗口长度节奏轻量清理一次过期 entry。
  */