loggily 0.4.2 → 0.5.1

package/README.md

@@ -18,7 +18,7 @@ npm install loggily
 
 | Requirement   | Version                                           |
 | ------------- | ------------------------------------------------- |
-| Node.js       | 18+                                               |
+| Node.js       | >= 23.6                                           |
 | Bun           | 1.0+                                              |
 | TypeScript    | 5.2+ (for `using`; `.end()` works on any version) |
 | Module format | ESM-only                                          |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "loggily",
-  "version": "0.4.2",
+  "version": "0.5.1",
   "description": "TypeScript logger with debug-style namespaces, structured JSON output, and lightweight spans. Disabled logs skip argument evaluation via optional chaining.",
   "keywords": [
     "browser",
@@ -32,7 +32,6 @@
     "src"
   ],
   "type": "module",
-  "module": "src/index.ts",
   "types": "./src/index.ts",
   "exports": {
     ".": {
@@ -55,6 +54,10 @@
     "./tracing": {
       "types": "./src/tracing.ts",
       "default": "./src/tracing.ts"
+    },
+    "./metrics": {
+      "types": "./src/metrics.ts",
+      "default": "./src/metrics.ts"
     }
   },
   "publishConfig": {
@@ -71,6 +74,8 @@
   "devDependencies": {
     "@types/node": "^25.5.0",
     "vitepress": "^1.6.4",
+    "vitepress-enrich": "^0.4.0",
+    "vitepress-plugin-llms": "^1.12.0",
     "vitest": "^4.1.1"
   },
   "engines": {

package/src/core.ts

@@ -27,6 +27,29 @@
 
 import { colors as pc } from "./colors.js"
 
+// ============ Metrics ============
+
+/** Data passed to span recorders on disposal */
+export interface SpanRecord {
+  readonly name: string
+  readonly durationMs: number
+}
+
+/** Interface for span duration recording — implemented by createMetricsCollector() in metrics.ts */
+export interface SpanRecorder {
+  recordSpan(data: SpanRecord): void
+}
+
+/**
+ * Ambient span recorder — auto-records when TRACE is active.
+ * Set by metrics.ts on import; can be replaced for testing.
+ * @internal
+ */
+export let _ambientRecorder: SpanRecorder | null = null
+export function _setAmbientRecorder(recorder: SpanRecorder | null): void {
+  _ambientRecorder = recorder
+}
+
 // ============ Runtime Detection ============
 
 /** Cached process reference — undefined in browser/edge runtimes */
@@ -57,6 +80,9 @@ export type LogLevel = OutputLogLevel | "silent"
 /** Message can be a string or a lazy function that returns a string */
 export type LazyMessage = string | (() => string)
 
+/** Span props can be an object or a lazy function (skipped entirely via ?. when tracing is off) */
+export type LazyProps = Record<string, unknown> | (() => Record<string, unknown>)
+
 /** Span data accessible via logger.spanData */
 export interface SpanData {
   readonly id: string
@@ -90,8 +116,8 @@ export interface Logger {
   // Create children
   /** Create child logger (extends namespace, inherits props) */
   logger(namespace?: string, props?: Record<string, unknown>): Logger
-  /** Create child span (extends namespace, inherits props, adds timing) */
-  span(namespace?: string, props?: Record<string, unknown>): SpanLogger
+  /** Create child span (extends namespace, inherits props, adds timing). Props can be lazy. */
+  span(namespace?: string, props?: LazyProps): SpanLogger
 
   /** Create child logger with context fields merged into every message */
   child(context: Record<string, unknown>): Logger
@@ -631,9 +657,10 @@ function createLoggerImpl(
       return createLoggerImpl(childName, mergedProps, null, parentSpanId, traceId, traceSampled)
     },
 
-    span(namespace?: string, childProps?: Record<string, unknown>): SpanLogger {
+    span(namespace?: string, childProps?: LazyProps): SpanLogger {
       const childName = namespace ? `${name}:${namespace}` : name
-      const mergedProps = { ...props, ...childProps }
+      const resolvedChildProps = typeof childProps === "function" ? childProps() : childProps
+      const mergedProps = { ...props, ...resolvedChildProps }
       const newSpanId = generateSpanId()
 
       // Resolve parent from context propagation if not explicitly set
@@ -704,6 +731,9 @@ function createLoggerImpl(
         // Exit span context (restore previous context snapshot)
         _exitContext?.(newSpanId)
 
+        // Record to ambient recorder (auto-active when TRACE is on, set by metrics.ts)
+        _ambientRecorder?.recordSpan({ name: childName, durationMs: newSpanData.duration })
+
         // Only emit span if sampled
         if (sampled) {
           writeSpan(childName, newSpanData.duration, {
@@ -797,7 +827,7 @@ export interface ConditionalLogger {
   }
 
   logger(namespace?: string, props?: Record<string, unknown>): Logger
-  span(namespace?: string, props?: Record<string, unknown>): SpanLogger
+  span(namespace?: string, props?: LazyProps): SpanLogger
   child(context: Record<string, unknown>): Logger
   child(context: string): Logger
   end(): void

package/src/metrics.ts

@@ -0,0 +1,201 @@
+/**
+ * Metrics collection for loggily spans.
+ *
+ * Two modes:
+ * - **Ambient**: import this module → spans auto-record when TRACE is active
+ * - **Explicit**: `withMetrics(collector?)(logger)` for custom collection
+ *
+ * @example
+ * ```typescript
+ * import { spanStats } from "loggily/metrics"
+ * // TRACE=myapp bun run app
+ * // → on exit: spanStats() returns aggregated p50/p95/p99
+ *
+ * // Custom collector:
+ * import { withMetrics, createMetricsCollector } from "loggily/metrics"
+ * const log = withMetrics()(createLogger("myapp"))
+ * ```
+ */
+
+import {
+  type SpanRecorder,
+  type SpanRecord,
+  type ConditionalLogger,
+  type Logger,
+  type LazyProps,
+  type SpanLogger,
+  _setAmbientRecorder,
+  spansAreEnabled,
+} from "./core.js"
+
+export type { SpanRecorder, SpanRecord }
+
+// ============ Stats ============
+
+export interface SpanStats {
+  count: number
+  min: number
+  max: number
+  mean: number
+  p50: number
+  p95: number
+  p99: number
+  total: number
+}
+
+function percentile(sorted: number[], p: number): number {
+  if (sorted.length === 0) return 0
+  const idx = Math.min(Math.floor(sorted.length * p), sorted.length - 1)
+  return sorted[idx]!
+}
+
+function computeStats(durations: number[]): SpanStats {
+  const sorted = [...durations].sort((a, b) => a - b)
+  const total = sorted.reduce((sum, d) => sum + d, 0)
+  return {
+    count: sorted.length,
+    min: sorted[0] ?? 0,
+    max: sorted[sorted.length - 1] ?? 0,
+    mean: sorted.length > 0 ? total / sorted.length : 0,
+    p50: percentile(sorted, 0.5),
+    p95: percentile(sorted, 0.95),
+    p99: percentile(sorted, 0.99),
+    total,
+  }
+}
+
+// ============ Collector ============
+
+export interface MetricsCollector extends SpanRecorder {
+  /** Get stats for a specific span namespace */
+  stats(name: string): SpanStats | undefined
+  /** Get stats for all recorded namespaces */
+  all(): Map<string, SpanStats>
+  /** Format a human-readable summary */
+  summary(): string
+  /** Reset all collected data */
+  reset(): void
+}
+
+export function createMetricsCollector(maxEntries = 1000): MetricsCollector {
+  const store = new Map<string, number[]>()
+
+  return {
+    recordSpan(data: SpanRecord): void {
+      let arr = store.get(data.name)
+      if (!arr) {
+        arr = []
+        store.set(data.name, arr)
+      }
+      arr.push(data.durationMs)
+      // Bound memory: keep last N entries per namespace
+      if (arr.length > maxEntries) arr.shift()
+    },
+
+    stats(name: string): SpanStats | undefined {
+      const arr = store.get(name)
+      if (!arr || arr.length === 0) return undefined
+      return computeStats(arr)
+    },
+
+    all(): Map<string, SpanStats> {
+      const result = new Map<string, SpanStats>()
+      for (const [name, durations] of store) {
+        if (durations.length > 0) result.set(name, computeStats(durations))
+      }
+      return result
+    },
+
+    summary(): string {
+      const entries = [...this.all().entries()]
+      if (entries.length === 0) return "(no span data)"
+      const lines = entries.map(
+        ([name, s]) =>
+          `${name}: ${s.count} spans, mean=${s.mean.toFixed(1)}ms, p50=${s.p50.toFixed(1)}ms, p95=${s.p95.toFixed(1)}ms, p99=${s.p99.toFixed(1)}ms`,
+      )
+      return lines.join("\n")
+    },
+
+    reset(): void {
+      store.clear()
+    },
+  }
+}
+
+// ============ Ambient Collector ============
+
+const _ambient = createMetricsCollector()
+
+// Auto-activate ambient recording.
+// Always set — the cost is one ?.recordSpan() call per span (negligible).
+// The TRACE gate already controls whether spans are *created* at all.
+_setAmbientRecorder(_ambient)
+
+/** Get aggregated span stats (from ambient collector). */
+export function spanStats(): Map<string, SpanStats> {
+  return _ambient.all()
+}
+
+/** Get the ambient collector's formatted summary. */
+export function spanSummary(): string {
+  return _ambient.summary()
+}
+
+/** Reset the ambient collector. */
+export function resetSpanStats(): void {
+  _ambient.reset()
+}
+
+// ============ withMetrics ============
+
+/**
+ * Compose a logger with a metrics collector.
+ * Returns a curried wrapper: `withMetrics(collector?)(logger)`
+ *
+ * - No arg: uses the built-in ambient collector
+ * - Custom collector: records to your collector
+ * - Stackable: `withMetrics(a)(withMetrics(b)(logger))` fans out to both
+ *
+ * @example
+ * ```typescript
+ * const log = withMetrics()(createLogger("myapp"))
+ * const log = withMetrics(myCollector)(createLogger("myapp"))
+ * ```
+ */
+export function withMetrics(collector?: SpanRecorder): (logger: ConditionalLogger) => ConditionalLogger {
+  const recorder = collector ?? _ambient
+
+  return (logger: ConditionalLogger): ConditionalLogger => {
+    // Wrap the logger's span method to intercept disposal
+    return new Proxy(logger, {
+      get(target, prop: string | symbol) {
+        if (prop === "span") {
+          const originalSpan = target.span
+          if (!originalSpan) return undefined // TRACE off — preserve ?.  behavior
+          return (namespace?: string, props?: LazyProps): SpanLogger => {
+            const span = originalSpan.call(target, namespace, props)
+            // Wrap disposal to record to our collector
+            const originalDispose = (span as unknown as { [Symbol.dispose]: () => void })[Symbol.dispose]
+            ;(span as unknown as { [Symbol.dispose]: () => void })[Symbol.dispose] = () => {
+              originalDispose.call(span)
+              // After original disposal computed duration, record it
+              if (span.spanData?.duration != null) {
+                recorder.recordSpan({ name: span.name, durationMs: span.spanData.duration })
+              }
+            }
+            return span
+          }
+        }
+        if (prop === "logger") {
+          // Child loggers inherit the metrics wrapper
+          return (namespace?: string, childProps?: Record<string, unknown>): Logger => {
+            const child = target.logger(namespace, childProps)
+            // Re-wrap the child — withMetrics(recorder) applied recursively
+            return withMetrics(recorder)(child as unknown as ConditionalLogger) as unknown as Logger
+          }
+        }
+        return (target as unknown as Record<string | symbol, unknown>)[prop]
+      },
+    })
+  }
+}