@ryanzeng/nest-observe 0.1.4 → 0.1.5

package/README.md

@@ -1,4 +1,4 @@
-# @ryanzeng/nest-observe
+![header](https://capsule-render.vercel.app/api?type=waving&color=gradient&height=220&section=header&text=nest-observe&fontSize=48&fontColor=ffffff&animation=fadeIn)
 
 面向 NestJS 的零配置、Vendor Neutral Observability SDK。基于 OpenTelemetry，通过标准 OTLP 同时发送 Traces、Metrics 和 Logs，可连接 OpenObserve、Grafana、Jaeger、Datadog、Elastic 等兼容后端。
 
@@ -166,8 +166,10 @@ Traces：
 Logs：
 
 - 默认 Nest `Logger` 的 `verbose/debug/log/warn/error/fatal`
+- 遵循 Nest `ConsoleLogger` 的重载解析语义，保留 `error(message, stack?, context?)`、附加消息和结构化参数
+- `Error` 或显式 stack 会映射为 OTLP `exception.type`、`exception.message`、`exception.stacktrace` 属性
 - 尊重 Nest 11+ 的实例级日志级别过滤（`logLevels` / `setLogLevels` / `Logger.overrideLogger`），上传内容与控制台输出一致
-- 对象和数组消息会在脱敏后保持结构化 body，由观测后端或查询侧决定如何展开、展示或序列化
+- 对象和数组消息会在脱敏后保持结构化 body；附加的结构化参数会展开为 OTLP attributes，同时保持首个 message 为 body
 - OTLP severity、`nestjs.context`、`trace_id`、`span_id`
 - `service.name`、`service.version`、`deployment.environment.name`
 

package/dist/index.d.mts

@@ -1,10 +1,10 @@
 import { LogRecordExporter, LoggerProvider } from '@opentelemetry/sdk-logs';
 import { MetricReader, MeterProvider } from '@opentelemetry/sdk-metrics';
 import { SpanExporter, SpanProcessor, ReadableSpan } from '@opentelemetry/sdk-trace-base';
-import { Attributes, Meter, Tracer, Span, Context } from '@opentelemetry/api';
-import { Logger } from '@opentelemetry/api-logs';
+import { LogAttributes, Logger } from '@opentelemetry/api-logs';
 import { InstrumentationConfig, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
 import { NestInstrumentation } from '@opentelemetry/instrumentation-nestjs-core';
+import { Meter, Tracer, Span, Context } from '@opentelemetry/api';
 import { IncomingMessage, ServerResponse } from 'node:http';
 import { NestInterceptor, ExecutionContext, CallHandler, DynamicModule } from '@nestjs/common';
 import { Observable } from 'rxjs';
@@ -109,7 +109,7 @@ declare function Trace(nameOrOptions?: string | TraceOptions): TraceDecorator;
 interface StructuredLogRecord {
     body: unknown;
     severityText: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'FATAL';
-    attributes: Attributes;
+    attributes: LogAttributes;
     timestamp?: number;
 }
 interface StructuredLogEmitter {

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { LogRecordExporter, LoggerProvider } from '@opentelemetry/sdk-logs';
 import { MetricReader, MeterProvider } from '@opentelemetry/sdk-metrics';
 import { SpanExporter, SpanProcessor, ReadableSpan } from '@opentelemetry/sdk-trace-base';
-import { Attributes, Meter, Tracer, Span, Context } from '@opentelemetry/api';
-import { Logger } from '@opentelemetry/api-logs';
+import { LogAttributes, Logger } from '@opentelemetry/api-logs';
 import { InstrumentationConfig, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
 import { NestInstrumentation } from '@opentelemetry/instrumentation-nestjs-core';
+import { Meter, Tracer, Span, Context } from '@opentelemetry/api';
 import { IncomingMessage, ServerResponse } from 'node:http';
 import { NestInterceptor, ExecutionContext, CallHandler, DynamicModule } from '@nestjs/common';
 import { Observable } from 'rxjs';
@@ -109,7 +109,7 @@ declare function Trace(nameOrOptions?: string | TraceOptions): TraceDecorator;
 interface StructuredLogRecord {
     body: unknown;
     severityText: 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'FATAL';
-    attributes: Attributes;
+    attributes: LogAttributes;
     timestamp?: number;
 }
 interface StructuredLogEmitter {

package/dist/index.js

@@ -347,6 +347,71 @@ function bodyValue(message) {
     return redactText(message.stack ?? `${message.name}: ${message.message}`);
   return redact(message);
 }
+function isPlainObject(value) {
+  if (value === null || typeof value !== "object") return false;
+  const prototype = Object.getPrototypeOf(value);
+  if (prototype === null) return true;
+  const constructor = Object.prototype.hasOwnProperty.call(prototype, "constructor") ? prototype.constructor : void 0;
+  return typeof constructor === "function" && constructor instanceof constructor && Function.prototype.toString.call(constructor) === Function.prototype.toString.call(Object);
+}
+function isStackFormat(value) {
+  return typeof value === "string" && /^(.)+\n\s+at .+:\d+:\d+/.test(value);
+}
+function fallbackMessages(logger, values) {
+  if (values.length <= 1) return { messages: values, context: logger.context };
+  const lastValue = values.at(-1);
+  const contextName = typeof lastValue === "string" ? lastValue : logger.context;
+  const remaining = typeof lastValue === "string" ? values.slice(0, -1) : values;
+  if (logger.options?.structuredParams === false) {
+    return { messages: remaining, context: contextName };
+  }
+  const messages = [remaining[0]];
+  const structuredParams = [];
+  for (const value of remaining.slice(1)) {
+    if (isPlainObject(value)) structuredParams.push(value);
+    else messages.push(value);
+  }
+  const params = structuredParams.length > 0 ? Object.assign({}, ...structuredParams) : void 0;
+  return { messages, context: contextName, ...params ? { params } : {} };
+}
+function fallbackError(logger, values) {
+  if (values.length === 2) {
+    if (isStackFormat(values[1])) {
+      return { messages: [values[0]], stack: values[1], context: logger.context };
+    }
+    return fallbackMessages(logger, values);
+  }
+  const trailingValue = values.at(-1);
+  if (isStackFormat(trailingValue)) {
+    return { ...fallbackMessages(logger, values.slice(0, -1)), stack: trailingValue };
+  }
+  const parsed = fallbackMessages(logger, values);
+  if (parsed.messages.length <= 1) return parsed;
+  const possibleStack = parsed.messages.at(-1);
+  if (typeof possibleStack !== "string" && possibleStack !== void 0) return parsed;
+  return {
+    ...parsed,
+    messages: parsed.messages.slice(0, -1),
+    ...possibleStack === void 0 ? {} : { stack: possibleStack }
+  };
+}
+function parseLogCall(logger, method, message, args) {
+  const values = [message, ...args];
+  const nestParser = method === "error" ? logger.getContextAndStackAndMessagesToPrint : logger.getContextAndMessagesToPrint;
+  if (typeof nestParser === "function") return nestParser.call(logger, values);
+  return method === "error" ? fallbackError(logger, values) : fallbackMessages(logger, values);
+}
+function exceptionAttributes(message, stack) {
+  const error = message instanceof Error ? message : void 0;
+  const stacktrace = stack ?? error?.stack;
+  return {
+    ...error ? {
+      "exception.type": error.name,
+      "exception.message": redactText(error.message)
+    } : {},
+    ...stacktrace ? { "exception.stacktrace": redactText(stacktrace) } : {}
+  };
+}
 var NestLoggerInstrumentation = class {
   constructor(emitter, resourceAttributes = {}) {
     this.emitter = emitter;
@@ -373,17 +438,25 @@ var NestLoggerInstrumentation = class {
             return original.call(this, message, ...args);
           }
           const spanContext = import_api3.trace.getActiveSpan()?.spanContext();
-          const contextName = this.context ?? (typeof args.at(-1) === "string" ? String(args.at(-1)) : void 0);
-          const attributes = { ...resourceAttributes };
-          if (contextName) attributes["nestjs.context"] = contextName;
-          if (spanContext?.traceId) attributes.trace_id = spanContext.traceId;
-          if (spanContext?.spanId) attributes.span_id = spanContext.spanId;
-          emitter.emit({
-            body: bodyValue(message),
-            severityText: SEVERITY[method],
-            attributes,
-            timestamp: Date.now()
-          });
+          const parsed = parseLogCall(this, method, message, args);
+          const timestamp = Date.now();
+          for (const parsedMessage of parsed.messages) {
+            const params = parsed.params ? redact(parsed.params) : {};
+            const attributes = {
+              ...params,
+              ...resourceAttributes,
+              ...exceptionAttributes(parsedMessage, parsed.stack)
+            };
+            if (parsed.context) attributes["nestjs.context"] = parsed.context;
+            if (spanContext?.traceId) attributes.trace_id = spanContext.traceId;
+            if (spanContext?.spanId) attributes.span_id = spanContext.spanId;
+            emitter.emit({
+              body: bodyValue(parsedMessage),
+              severityText: SEVERITY[method],
+              attributes,
+              timestamp
+            });
+          }
         } catch {
         }
         return original.call(this, message, ...args);