@lark-apaas/observable-web 1.0.0-alpha.2 → 1.0.0-alpha.4

package/dist/lib/const.d.ts

@@ -0,0 +1,11 @@
+declare const defaultResourceAttr: {
+    sdk_version: string;
+    sdk_lang: string;
+    sdk_type: string;
+};
+declare enum AppEnv {
+    Dev = "preview",
+    Prod = "runtime"
+}
+
+export { AppEnv, defaultResourceAttr };

package/dist/lib/const.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/lib/core/instrumentation/PvInstrumentation.d.ts

@@ -0,0 +1,17 @@
+import { Meter } from '@opentelemetry/api';
+
+declare class PvInstrumentation {
+    private meter;
+    private lastUrl;
+    constructor(meter: Meter);
+    /**
+     * 开启自动采集
+     */
+    enable(): void;
+    /**
+     * Monkey Patch 历史记录 API
+     */
+    private patchHistory;
+}
+
+export { PvInstrumentation };

package/dist/lib/core/instrumentation/PvInstrumentation.js

@@ -1,8 +1,8 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -16,7 +16,6 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 var PvInstrumentation_exports = {};
 __export(PvInstrumentation_exports, {
   PvInstrumentation: () => PvInstrumentation
@@ -25,15 +24,13 @@ module.exports = __toCommonJS(PvInstrumentation_exports);
 var import_getDeviceID = require("../../utils/getDeviceID");
 class PvInstrumentation {
   constructor(meter) {
-    __publicField(this, "meter");
-    __publicField(this, "lastUrl");
     this.meter = meter;
   }
   /**
    * 开启自动采集
    */
   enable() {
-    const pvCounter = this.meter.createCounter("page_view", {
+    const pvCounter = this.meter.createCounter("apaas_internal_metrics_pv_uv", {
       description: "Count of page views"
     });
     const reportPv = () => {

package/dist/lib/core/log-exporter.d.ts

@@ -0,0 +1,25 @@
+import { LogRecordExporter, ReadableLogRecord } from '@opentelemetry/sdk-logs';
+import { ExportResult } from '@opentelemetry/core';
+import { AppEnv } from '../const.js';
+
+interface CustomExporterConfig {
+    url: string;
+    /** 环境标识 */
+    env: AppEnv;
+    /** 自定义请求头 (例如鉴权 Token) */
+    headers?: Record<string, string>;
+}
+declare class CustomWebLogExporter implements LogRecordExporter {
+    private url;
+    private headers;
+    private appEnv;
+    constructor(config: CustomExporterConfig);
+    export(logs: ReadableLogRecord[], resultCallback: (result: ExportResult) => void): void;
+    /**
+     * 封装 Fetch 逻辑
+     */
+    private sendWithFetch;
+    shutdown(): Promise<void>;
+}
+
+export { type CustomExporterConfig, CustomWebLogExporter };

package/dist/lib/core/log-exporter.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -29,7 +30,6 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -62,9 +62,6 @@ var import_generateUUID = require("../utils/generateUUID");
 var import_const = require("../const");
 class CustomWebLogExporter {
   constructor(config) {
-    __publicField(this, "url");
-    __publicField(this, "headers");
-    __publicField(this, "appEnv");
     this.url = config.url;
     this.appEnv = config.env;
     this.headers = config.headers || {};

package/dist/lib/core/metric-exporter.d.ts

@@ -0,0 +1,42 @@
+import { PushMetricExporter, ResourceMetrics, AggregationTemporality } from '@opentelemetry/sdk-metrics';
+import { ExportResult } from '@opentelemetry/core';
+
+interface CustomExporterConfig {
+    url: string;
+    headers?: Record<string, string>;
+}
+declare class CustomWebMetricExporter implements PushMetricExporter {
+    private url;
+    private headers;
+    private _shutdown;
+    constructor(config: CustomExporterConfig);
+    export(metrics: ResourceMetrics, resultCallback: (result: ExportResult) => void): void;
+    /**
+     * 将 OTel ResourceMetrics 转换为目标 MetricsData
+     */
+    private transform;
+    /**
+     * 转换数值型数据点 (Sum / Gauge)
+     */
+    private transformNumberDataPoints;
+    /**
+     * 转换直方图数据点
+     */
+    private transformHistogramDataPoints;
+    /**
+     * 映射聚合时间枚举
+     */
+    private mapTemporality;
+    /**
+     * 强制使用 DELTA 模式 (Web 端通常推荐)
+     */
+    forceFlush(): Promise<void>;
+    selectAggregationTemporality(_instrumentType: any): AggregationTemporality;
+    shutdown(): Promise<void>;
+    /**
+     * 发送逻辑
+     */
+    private send;
+}
+
+export { type CustomExporterConfig, CustomWebMetricExporter };

package/dist/lib/core/metric-exporter.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -29,7 +30,6 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -62,9 +62,7 @@ var import_convertAllAttrIntoString = require("../utils/convertAllAttrIntoString
 var import_hrTimeToNanoNumber = require("../utils/hrTimeToNanoNumber");
 class CustomWebMetricExporter {
   constructor(config) {
-    __publicField(this, "url");
-    __publicField(this, "headers");
-    __publicField(this, "_shutdown", false);
+    this._shutdown = false;
     this.url = config.url;
     this.headers = config.headers || {};
   }

package/dist/lib/core/resource-detector.d.ts

@@ -0,0 +1,21 @@
+import { ResourceDetector, ResourceDetectionConfig, DetectedResource } from '@opentelemetry/resources';
+
+declare global {
+    interface Window {
+        appId: string;
+        tenantID: string;
+        userId: string;
+    }
+}
+/**
+ * 自定义 Web 环境探测器
+ */
+declare class CustomWebDetector implements ResourceDetector {
+    /**
+     * 核心探测方法
+     * @param config 探测配置（通常用不到，但接口要求）
+     */
+    detect(config?: ResourceDetectionConfig): DetectedResource;
+}
+
+export { CustomWebDetector };

package/dist/lib/core/resource-detector.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/lib/core/sdk.d.ts

@@ -0,0 +1,33 @@
+import { AppEnv } from '../const.js';
+
+interface WebSdkConfig {
+    serviceName: string;
+    env: AppEnv;
+    collectorUrl: {
+        log: string;
+        metric: string;
+    };
+    headers?: Record<string, string>;
+}
+declare class WebObservableSdk {
+    private static _instance;
+    private loggerProvider;
+    private meterProvider;
+    private logger;
+    private meter;
+    private resource;
+    private config;
+    private isStarted;
+    constructor();
+    static get instance(): WebObservableSdk;
+    start(config: WebSdkConfig): void;
+    private initLogs;
+    private initMetrics;
+    private initAutoPv;
+    log(level: 'INFO' | 'ERROR' | 'WARN', message: string, attributes?: Record<string, any>): void;
+    addCount(name: string, value?: number, attributes?: Record<string, any>): void;
+    shutdown(): Promise<void>;
+}
+declare const observable: WebObservableSdk;
+
+export { WebObservableSdk, type WebSdkConfig, observable };

package/dist/lib/core/sdk.js

@@ -1,8 +1,8 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -16,7 +16,6 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
 var __async = (__this, __arguments, generator) => {
   return new Promise((resolve, reject) => {
     var fulfilled = (value) => {
@@ -50,19 +49,13 @@ var import_sdk_metrics = require("@opentelemetry/sdk-metrics");
 var import_resource_detector = require("./resource-detector");
 var import_metric_exporter = require("./metric-exporter");
 var import_PvInstrumentation = require("./instrumentation/PvInstrumentation");
-const _WebObservableSdk = class _WebObservableSdk {
+class WebObservableSdk {
   constructor() {
-    __publicField(this, "loggerProvider");
-    __publicField(this, "meterProvider");
-    __publicField(this, "logger");
-    __publicField(this, "meter");
-    __publicField(this, "resource");
-    __publicField(this, "config");
-    __publicField(this, "isStarted", false);
+    this.isStarted = false;
   }
   static get instance() {
     if (!this._instance) {
-      this._instance = new _WebObservableSdk();
+      this._instance = new WebObservableSdk();
     }
     return this._instance;
   }
@@ -123,7 +116,7 @@ const _WebObservableSdk = class _WebObservableSdk {
   }
   initAutoPv() {
     var _a;
-    const meter = (_a = this.meterProvider) == null ? void 0 : _a.getMeter("web-sdk-pv-instrumentation");
+    const meter = (_a = this.meterProvider) == null ? void 0 : _a.getMeter("apaas_internal_metrics_pv_uv");
     if (!meter) return;
     const pvTracker = new import_PvInstrumentation.PvInstrumentation(meter);
     pvTracker.enable();
@@ -153,7 +146,5 @@ const _WebObservableSdk = class _WebObservableSdk {
       ]);
     });
   }
-};
-__publicField(_WebObservableSdk, "_instance");
-let WebObservableSdk = _WebObservableSdk;
+}
 const observable = WebObservableSdk.instance;

package/dist/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { observable } from './core/sdk.js';
+export { AppEnv } from './const.js';

package/dist/lib/index.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/lib/types.d.ts

@@ -0,0 +1,336 @@
+declare enum AggregationTemporality {
+    AGGREGATION_TEMPORALITY_UNSPECIFIED = 0,//未指定（禁止使用）
+    AGGREGATION_TEMPORALITY_DELTA = 1,//增量聚合（自上次报告以来的变化）
+    AGGREGATION_TEMPORALITY_CUMULATIVE = 2
+}
+interface Buckets {
+    /**
+     *桶偏移量（必选）
+     */
+    offset?: number;
+    /**
+     *桶计数列表（必选）
+     */
+    bucketCounts?: number[];
+}
+interface CollectMetricsRequest {
+    metricsData: MetricsData;
+}
+interface Exemplar {
+    /**
+     *过滤后的属性（必选）
+     */
+    filteredAttributes?: Record<string, string>;
+    /**
+     *样本时间戳（纳秒级 Unix 时间，必选）
+     */
+    timeUnixNano?: number;
+    /**
+     *浮点型样本值（与 AsInt 二选一）
+     */
+    asDouble?: number;
+    /**
+     *整型样本值（与 AsDouble 二选一）
+     */
+    asInt?: number;
+    /**
+     *关联的追踪 ID（16 字节，可选）
+     */
+    traceID?: string;
+    /**
+     *关联的跨度 ID（8 字节，可选）
+     */
+    spanID?: string;
+}
+interface ExponentialHistogram {
+    /**
+     *数据点列表（至少为空列表，必选）
+     */
+    dataPoints?: ExponentialHistogramDataPoint[];
+    /**
+     *聚合时间特性（必选）
+     */
+    aggregationTemporality?: AggregationTemporality;
+}
+interface ExponentialHistogramDataPoint {
+    /**
+     *数据点属性（键唯一，可选）
+     */
+    attributes?: Record<string, string>;
+    /**
+     *起始时间戳（纳秒级，可选，强烈建议设置）
+     */
+    startTimeUnixNano?: number;
+    /**
+     *结束时间戳（纳秒级，必选）
+     */
+    timeUnixNano?: number;
+    /**
+     *样本总数（非负，必选）
+     */
+    count?: number;
+    /**
+     *样本总和（可选，count 为 0 时必须为 0）
+     */
+    sum?: number;
+    /**
+     *分辨率缩放因子（必选）
+     */
+    scale?: number;
+    /**
+     *零值样本数（必选）
+     */
+    zeroCount?: number;
+    /**
+     *正数值桶计数（可选）
+     */
+    positive?: Buckets;
+    /**
+     *负数值桶计数（可选）
+     */
+    negative?: Buckets;
+    /**
+     *标志位（参考 DataPointFlags，可选）
+     */
+    flags?: number;
+    /**
+     *样本列表（可选）
+     */
+    exemplars?: Exemplar[];
+    /**
+     *最小值（可选）
+     */
+    min?: number;
+    /**
+     *最大值（可选）
+     */
+    max?: number;
+    /**
+     *零值阈值（可选）
+     */
+    zeroThreshold?: number;
+}
+interface Gauge {
+    /**
+     *数据点列表（至少为空列表，必选）
+     */
+    dataPoints?: NumberDataPoint[];
+}
+interface Histogram {
+    /**
+     *数据点列表（至少为空列表，必选）
+     */
+    dataPoints?: HistogramDataPoint[];
+    /**
+     *聚合时间特性（必选）
+     */
+    aggregationTemporality?: AggregationTemporality;
+}
+interface HistogramDataPoint {
+    /**
+     *数据点属性（键唯一，可选）
+     */
+    attributes?: Record<string, string>;
+    /**
+     *起始时间戳（纳秒级，可选，强烈建议设置）
+     */
+    startTimeUnixNano?: number;
+    /**
+     *结束时间戳（纳秒级，必选）
+     */
+    timeUnixNano?: number;
+    /**
+     *样本总数（非负，必选）
+     */
+    count?: number;
+    /**
+     *样本总和（可选，count 为 0 时必须为 0）
+     */
+    sum?: number;
+    /**
+     *每个桶的样本数（可选）
+     */
+    bucketCounts?: number[];
+    /**
+     *桶的边界值（可选）
+     */
+    explicitBounds?: number[];
+    /**
+     *最小值（可选）
+     */
+    min?: number;
+    /**
+     *最大值（可选）
+     */
+    max?: number;
+    /**
+     *样本列表（可选）
+     */
+    exemplars?: Exemplar[];
+    /**
+     *标志位（参考 DataPointFlags，可选）
+     */
+    flags?: number;
+}
+interface Metric {
+    /**
+     *指标名称（必选）
+     */
+    name?: string;
+    /**
+     *指标描述（可选）
+     */
+    description?: string;
+    /**
+     *指标单位（遵循 UCUM 格式，可选）
+     */
+    unit?: string;
+    /**
+     *gauge 类型数据（与其他数据类型互斥）
+     */
+    gauge?: Gauge;
+    /**
+     *sum 类型数据（与其他数据类型互斥）
+     */
+    sum?: Sum;
+    /**
+     *直方图类型数据（与其他数据类型互斥）
+     */
+    histogram?: Histogram;
+    /**
+     *指数直方图类型数据（与其他数据类型互斥）
+     */
+    exponentialHistogram?: ExponentialHistogram;
+    /**
+     *摘要类型数据（与其他数据类型互斥）
+     */
+    summary?: Summary;
+    /**
+     *附加元数据（非标识性，可选）
+     */
+    metadata?: Record<string, string>;
+    /**
+     *指标范围名称（可选）
+     */
+    scopeName?: string;
+}
+interface MetricsData {
+    /**
+     *资源信息（可选，未设置表示未知）
+     */
+    resource?: Resource;
+    /**
+     *范围指标列表（至少为空列表，语义必填）
+     */
+    metrics?: Metric[];
+    /**
+     *资源数据遵循的 schema URL（可选）
+     */
+    schemaURL?: string;
+}
+interface NumberDataPoint {
+    /**
+     *起始时间戳（纳秒级，可选，强烈建议设置）
+     */
+    startTimeUnixNano?: number;
+    /**
+     *结束时间戳（纳秒级，必选）
+     */
+    timeUnixNano?: number;
+    /**
+     *浮点值（与 AsInt 二选一，必选其一）
+     */
+    asDouble?: number;
+    /**
+     *样本列表（可选）
+     */
+    exemplars?: Exemplar[];
+    /**
+     *整数值（与 AsDouble 二选一，必选其一）
+     */
+    asInt?: number;
+    /**
+     *数据点属性（键唯一，可选）
+     */
+    attributes?: Record<string, string>;
+    /**
+     *标志位（参考 DataPointFlags，可选）
+     */
+    flags?: number;
+}
+interface Resource {
+    /**
+     *资源属性列表，键必须唯一
+     */
+    attributes?: Record<string, string>;
+    /**
+     *被丢弃的属性数量，默认 0
+     */
+    droppedAttributesCount?: number;
+    /**
+     *资源数据遵循的 schema URL
+     */
+    schemaURL?: string;
+}
+interface Sum {
+    /**
+     *数据点列表（至少为空列表，必选）
+     */
+    dataPoints?: NumberDataPoint[];
+    /**
+     *聚合时间特性（必选）
+     */
+    aggregationTemporality?: AggregationTemporality;
+    /**
+     *是否单调递增（必选）
+     */
+    isMonotonic?: boolean;
+}
+interface Summary {
+    /**
+     *数据点列表（至少为空列表，必选）
+     */
+    dataPoints?: SummaryDataPoint[];
+}
+interface SummaryDataPoint {
+    /**
+     *数据点属性（键唯一，可选）
+     */
+    attributes?: Record<string, string>;
+    /**
+     *起始时间戳（纳秒级，可选，强烈建议设置）
+     */
+    startTimeUnixNano?: number;
+    /**
+     *结束时间戳（纳秒级，必选）
+     */
+    timeUnixNano?: number;
+    /**
+     *样本总数（非负，必选）
+     */
+    count?: number;
+    /**
+     *样本总和（必选）
+     */
+    sum?: number;
+    /**
+     *分位数对应的数值（必选）
+     */
+    quantileValues?: ValueAtQuantile[];
+    /**
+     *标志位（参考 DataPointFlags，可选）
+     */
+    flags?: number;
+}
+interface ValueAtQuantile {
+    /**
+     *分位数（0 ≤ quantile ≤ 1，必选）
+     */
+    quantile?: number;
+    /**
+     *分位数值（必选）
+     */
+    value?: number;
+}
+
+export { AggregationTemporality, type Buckets, type CollectMetricsRequest, type Exemplar, type ExponentialHistogram, type ExponentialHistogramDataPoint, type Gauge, type Histogram, type HistogramDataPoint, type Metric, type MetricsData, type NumberDataPoint, type Resource, type Sum, type Summary, type SummaryDataPoint, type ValueAtQuantile };

package/dist/lib/types.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/lib/utils/convertAllAttrIntoString.d.ts

@@ -0,0 +1,3 @@
+declare function convertAttributesToString(attributes: Record<string, unknown>): Record<string, string>;
+
+export { convertAttributesToString };

package/dist/lib/utils/convertAllAttrIntoString.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/lib/utils/generateUUID.d.ts

@@ -0,0 +1,3 @@
+declare const generateUUID: () => string;
+
+export { generateUUID };

package/dist/lib/utils/generateUUID.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/lib/utils/getDeviceID.d.ts

@@ -0,0 +1,3 @@
+declare const getDeviceId: () => string;
+
+export { getDeviceId };

package/dist/lib/utils/getDeviceID.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/dist/lib/utils/hrTimeToNanoNumber.d.ts

@@ -0,0 +1,10 @@
+import { HrTime } from '@opentelemetry/api';
+
+/**
+ * 将 HrTime 转换为纳秒数字
+ * 注意：JavaScript Number 类型只能精确表示整数到 2^53，对于超过此范围的纳秒值会丢失精度
+ * 此实现不使用 BigInt，具有更好的浏览器兼容性
+*/
+declare function hrTimeToNanosNumber(hrTime: HrTime): number;
+
+export { hrTimeToNanosNumber };

package/dist/lib/utils/hrTimeToNanoNumber.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/observable-web",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.4",
   "description": "Observable SDK For Web",
   "main": "./dist/lib/index.js",
   "files": [