@nocobase/telemetry 1.3.0-alpha.20240710084543 → 1.3.0-alpha.20240710141659

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+export * from './telemetry';

package/lib/index.js

@@ -0,0 +1,30 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+module.exports = __toCommonJS(src_exports);
+__reExport(src_exports, require("./telemetry"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./telemetry")
+});

package/lib/metric.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Registry } from '@nocobase/utils';
+import { MetricReader, MeterProvider, View } from '@opentelemetry/sdk-metrics';
+import { Resource } from '@opentelemetry/resources';
+export type MetricOptions = {
+    meterName?: string;
+    version?: string;
+    readerName?: string | string[];
+};
+type GetMetricReader = () => MetricReader;
+export declare class Metric {
+    meterName: string;
+    version: string;
+    readerName: string | string[];
+    readers: Registry<GetMetricReader>;
+    provider: MeterProvider;
+    views: View[];
+    constructor(options?: MetricOptions);
+    init(resource: Resource): void;
+    registerReader(name: string, reader: GetMetricReader): void;
+    getReader(name: string): GetMetricReader;
+    addView(...view: View[]): void;
+    getMeter(name?: string, version?: string): import("@opentelemetry/api").Meter;
+    start(): void;
+    shutdown(): Promise<void>;
+}
+export {};

package/lib/metric.js

@@ -0,0 +1,100 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var metric_exports = {};
+__export(metric_exports, {
+  Metric: () => Metric
+});
+module.exports = __toCommonJS(metric_exports);
+var import_utils = require("@nocobase/utils");
+var import_sdk_metrics = require("@opentelemetry/sdk-metrics");
+var import_api = __toESM(require("@opentelemetry/api"));
+const _Metric = class _Metric {
+  meterName;
+  version;
+  readerName;
+  readers = new import_utils.Registry();
+  provider;
+  views = [];
+  constructor(options) {
+    const { meterName, readerName, version } = options || {};
+    this.readerName = readerName || "console";
+    this.meterName = meterName || "nocobase-meter";
+    this.version = version || "";
+    this.registerReader(
+      "console",
+      () => new import_sdk_metrics.PeriodicExportingMetricReader({
+        exporter: new import_sdk_metrics.ConsoleMetricExporter()
+      })
+    );
+  }
+  init(resource) {
+    this.provider = new import_sdk_metrics.MeterProvider({ resource, views: this.views });
+    import_api.default.metrics.setGlobalMeterProvider(this.provider);
+  }
+  registerReader(name, reader) {
+    this.readers.register(name, reader);
+  }
+  getReader(name) {
+    return this.readers.get(name);
+  }
+  addView(...view) {
+    this.views.push(...view);
+  }
+  getMeter(name, version) {
+    return this.provider.getMeter(name || this.meterName, version || this.version);
+  }
+  start() {
+    let readerName = this.readerName;
+    if (typeof readerName === "string") {
+      readerName = readerName.split(",");
+    }
+    readerName.forEach((name) => {
+      const reader = this.getReader(name)();
+      this.provider.addMetricReader(reader);
+    });
+  }
+  shutdown() {
+    return this.provider.shutdown();
+  }
+};
+__name(_Metric, "Metric");
+let Metric = _Metric;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Metric
+});

package/lib/telemetry.d.ts

@@ -0,0 +1,30 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { InstrumentationOption } from '@opentelemetry/instrumentation';
+import { Metric, MetricOptions } from './metric';
+import { Trace, TraceOptions } from './trace';
+export interface TelemetryOptions {
+    serviceName?: string;
+    version?: string;
+    trace?: TraceOptions;
+    metric?: MetricOptions;
+}
+export declare class Telemetry {
+    serviceName: string;
+    version: string;
+    instrumentations: InstrumentationOption[];
+    trace: Trace;
+    metric: Metric;
+    started: boolean;
+    constructor(options?: TelemetryOptions);
+    init(): void;
+    start(): void;
+    shutdown(): Promise<void>;
+    addInstrumentation(...instrumentation: InstrumentationOption[]): void;
+}

package/lib/telemetry.js

@@ -0,0 +1,85 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var telemetry_exports = {};
+__export(telemetry_exports, {
+  Telemetry: () => Telemetry
+});
+module.exports = __toCommonJS(telemetry_exports);
+var import_semantic_conventions = require("@opentelemetry/semantic-conventions");
+var import_resources = require("@opentelemetry/resources");
+var import_instrumentation = require("@opentelemetry/instrumentation");
+var import_metric = require("./metric");
+var import_trace = require("./trace");
+const _Telemetry = class _Telemetry {
+  serviceName;
+  version;
+  instrumentations = [];
+  trace;
+  metric;
+  started = false;
+  constructor(options) {
+    const { trace, metric, serviceName, version } = options || {};
+    this.trace = new import_trace.Trace({ tracerName: `${serviceName}-trace`, version, ...trace });
+    this.metric = new import_metric.Metric({ meterName: `${serviceName}-meter`, version, ...metric });
+    this.serviceName = serviceName || "nocobase";
+    this.version = version || "";
+  }
+  init() {
+    (0, import_instrumentation.registerInstrumentations)({
+      instrumentations: this.instrumentations
+    });
+    const resource = import_resources.Resource.default().merge(
+      new import_resources.Resource({
+        [import_semantic_conventions.SemanticResourceAttributes.SERVICE_NAME]: this.serviceName,
+        [import_semantic_conventions.SemanticResourceAttributes.SERVICE_VERSION]: this.version
+      })
+    );
+    this.trace.init(resource);
+    this.metric.init(resource);
+  }
+  start() {
+    if (!this.started) {
+      this.trace.start();
+      this.metric.start();
+    }
+    this.started = true;
+  }
+  async shutdown() {
+    await Promise.all([this.trace.shutdown(), this.metric.shutdown()]);
+    this.started = false;
+  }
+  addInstrumentation(...instrumentation) {
+    this.instrumentations.push(...instrumentation);
+  }
+};
+__name(_Telemetry, "Telemetry");
+let Telemetry = _Telemetry;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Telemetry
+});

package/lib/trace.d.ts

@@ -0,0 +1,33 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Registry } from '@nocobase/utils';
+import { SpanProcessor } from '@opentelemetry/sdk-trace-base';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+import { Resource } from '@opentelemetry/resources';
+export type TraceOptions = {
+    tracerName?: string;
+    version?: string;
+    processorName?: string | string[];
+};
+type GetSpanProcessor = () => SpanProcessor;
+export declare class Trace {
+    processorName: string | string[];
+    processors: Registry<GetSpanProcessor>;
+    tracerName: string;
+    version: string;
+    provider: NodeTracerProvider;
+    constructor(options?: TraceOptions);
+    init(resource: Resource): void;
+    registerProcessor(name: string, processor: GetSpanProcessor): void;
+    getProcessor(name: string): GetSpanProcessor;
+    getTracer(name?: string, version?: string): import("@opentelemetry/sdk-trace-base").Tracer;
+    start(): void;
+    shutdown(): Promise<void>;
+}
+export {};

package/lib/trace.js

@@ -0,0 +1,83 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var trace_exports = {};
+__export(trace_exports, {
+  Trace: () => Trace
+});
+module.exports = __toCommonJS(trace_exports);
+var import_utils = require("@nocobase/utils");
+var import_sdk_trace_base = require("@opentelemetry/sdk-trace-base");
+var import_sdk_trace_node = require("@opentelemetry/sdk-trace-node");
+const _Trace = class _Trace {
+  processorName;
+  processors = new import_utils.Registry();
+  tracerName;
+  version;
+  provider;
+  constructor(options) {
+    const { processorName, tracerName, version } = options || {};
+    this.processorName = processorName || "console";
+    this.tracerName = tracerName || "nocobase-trace";
+    this.version = version || "";
+    this.registerProcessor("console", () => new import_sdk_trace_base.BatchSpanProcessor(new import_sdk_trace_base.ConsoleSpanExporter()));
+  }
+  init(resource) {
+    this.provider = new import_sdk_trace_node.NodeTracerProvider({
+      resource
+    });
+    this.provider.register();
+  }
+  registerProcessor(name, processor) {
+    this.processors.register(name, processor);
+  }
+  getProcessor(name) {
+    return this.processors.get(name);
+  }
+  getTracer(name, version) {
+    return this.provider.getTracer(name || this.tracerName, version || this.version);
+  }
+  start() {
+    let processorName = this.processorName;
+    if (typeof processorName === "string") {
+      processorName = processorName.split(",");
+    }
+    processorName.forEach((name) => {
+      const processor = this.getProcessor(name)();
+      this.provider.addSpanProcessor(processor);
+    });
+  }
+  shutdown() {
+    return this.provider.shutdown();
+  }
+};
+__name(_Trace, "Trace");
+let Trace = _Trace;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Trace
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nocobase/telemetry",
-  "version": "1.3.0-alpha.20240710084543",
+  "version": "1.3.0-alpha.20240710141659",
   "description": "nocobase telemetry library",
   "license": "AGPL-3.0",
   "main": "./lib/index.js",
@@ -11,7 +11,7 @@
     "directory": "packages/telemetry"
   },
   "dependencies": {
-    "@nocobase/utils": "1.3.0-alpha.20240710084543",
+    "@nocobase/utils": "1.3.0-alpha.20240710141659",
     "@opentelemetry/api": "^1.7.0",
     "@opentelemetry/instrumentation": "^0.46.0",
     "@opentelemetry/resources": "^1.19.0",
@@ -20,5 +20,5 @@
     "@opentelemetry/sdk-trace-node": "^1.19.0",
     "@opentelemetry/semantic-conventions": "^1.19.0"
   },
-  "gitHead": "07a8b596fc64a9779a194cb9b0dc2ca7570ed9d4"
+  "gitHead": "cb8b234443034da0dfa57dd5d6cca1f3b3db6f08"
 }