@xylabs/telemetry-exporter 5.0.83 → 5.0.86

package/README.md

@@ -15,6 +15,8 @@
 
 Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
+
+
 ## Reference
 
 **@xylabs/telemetry-exporter**
@@ -23,11 +25,15 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ## Classes
 
-- [XyConsoleSpanExporter](#classes/XyConsoleSpanExporter)
+| Class | Description |
+| ------ | ------ |
+| [XyConsoleSpanExporter](#classes/XyConsoleSpanExporter) | A console span exporter that formats spans with color-coded durations using chalk. Spans are filtered by a configurable log level based on their duration. |
 
 ## Functions
 
-- [spanDurationInMillis](#functions/spanDurationInMillis)
+| Function | Description |
+| ------ | ------ |
+| [spanDurationInMillis](#functions/spanDurationInMillis) | Calculates the duration of a span in milliseconds from its high-resolution time tuple. |
 
 ### classes
 
@@ -37,6 +43,9 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 
 ***
 
+A console span exporter that formats spans with color-coded durations using chalk.
+Spans are filtered by a configurable log level based on their duration.
+
 ## Extends
 
 - `ConsoleSpanExporter`
@@ -46,18 +55,15 @@ Base functionality used throughout XY Labs TypeScript/JavaScript libraries
 ### Constructor
 
 ```ts
-new XyConsoleSpanExporter(logLevel?, logger?): XyConsoleSpanExporter;
+new XyConsoleSpanExporter(logLevel?: number, logger?: Logger): XyConsoleSpanExporter;
 ```
 
 ### Parameters
 
-#### logLevel?
-
-`number` = `0`
-
-#### logger?
-
-`Logger` = `console`
+| Parameter | Type | Default value |
+| ------ | ------ | ------ |
+| `logLevel` | `number` | `0` |
+| `logger` | `Logger` | `console` |
 
 ### Returns
 
@@ -71,27 +77,11 @@ ConsoleSpanExporter.constructor
 
 ## Properties
 
-### durationToLogLevel
-
-```ts
-readonly static durationToLogLevel: number[];
-```
-
-***
-
-### logLevelToChalkColor
-
-```ts
-readonly static logLevelToChalkColor: ChalkInstance[];
-```
-
-***
-
-### logger
-
-```ts
-logger: Logger;
-```
+| Property | Modifier | Type | Description |
+| ------ | ------ | ------ | ------ |
+| <a id="durationtologlevel"></a> `durationToLogLevel` | `readonly` | `number`[] | Duration thresholds (in ms) that map to increasing log levels. |
+| <a id="logleveltochalkcolor"></a> `logLevelToChalkColor` | `readonly` | `ChalkInstance`[] | Chalk color functions corresponding to each log level. |
+| <a id="logger"></a> `logger` | `public` | `Logger` | - |
 
 ## Accessors
 
@@ -103,6 +93,8 @@ logger: Logger;
 get logLevel(): number;
 ```
 
+The minimum log level required for a span to be exported.
+
 #### Returns
 
 `number`
@@ -112,16 +104,16 @@ get logLevel(): number;
 ### export()
 
 ```ts
-export(spans): void;
+export(spans: ReadableSpan[]): void;
 ```
 
 Export spans.
 
 ### Parameters
 
-#### spans
-
-`ReadableSpan`[]
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `spans` | `ReadableSpan`[] | - |
 
 ### Returns
 
@@ -138,37 +130,45 @@ ConsoleSpanExporter.export
 ### logColor()
 
 ```ts
-logColor(level): ChalkInstance;
+logColor(level: number): ChalkInstance;
 ```
 
-### Parameters
+Returns the chalk color function for the given log level.
 
-#### level
+### Parameters
 
-`number`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `level` | `number` | The log level index. |
 
 ### Returns
 
 `ChalkInstance`
 
+A chalk color function.
+
 ***
 
 ### spanLevel()
 
 ```ts
-spanLevel(span): number;
+spanLevel(span: ReadableSpan): number;
 ```
 
-### Parameters
+Determines the log level of a span based on its duration.
 
-#### span
+### Parameters
 
-`ReadableSpan`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `span` | `ReadableSpan` | The span to evaluate. |
 
 ### Returns
 
 `number`
 
+The numeric log level (index into durationToLogLevel).
+
 ### functions
 
   ### <a id="spanDurationInMillis"></a>spanDurationInMillis
@@ -178,19 +178,23 @@ spanLevel(span): number;
 ***
 
 ```ts
-function spanDurationInMillis(span): number;
+function spanDurationInMillis(span: ReadableSpan): number;
 ```
 
-## Parameters
+Calculates the duration of a span in milliseconds from its high-resolution time tuple.
 
-### span
+## Parameters
 
-`ReadableSpan`
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `span` | `ReadableSpan` | The span to measure. |
 
 ## Returns
 
 `number`
 
+The span duration in milliseconds.
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/neutral/XyConsoleSpanExporter.d.ts

@@ -1,16 +1,38 @@
 import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
 import { ConsoleSpanExporter } from '@opentelemetry/sdk-trace-base';
 import type { Logger } from '@xylabs/logger';
+/**
+ * Calculates the duration of a span in milliseconds from its high-resolution time tuple.
+ * @param span - The span to measure.
+ * @returns The span duration in milliseconds.
+ */
 export declare function spanDurationInMillis(span: ReadableSpan): number;
+/**
+ * A console span exporter that formats spans with color-coded durations using chalk.
+ * Spans are filtered by a configurable log level based on their duration.
+ */
 export declare class XyConsoleSpanExporter extends ConsoleSpanExporter {
+    /** Duration thresholds (in ms) that map to increasing log levels. */
     static readonly durationToLogLevel: number[];
+    /** Chalk color functions corresponding to each log level. */
     static readonly logLevelToChalkColor: import("chalk").ChalkInstance[];
     logger: Logger;
     private _logLevel;
     constructor(logLevel?: number, logger?: Logger);
+    /** The minimum log level required for a span to be exported. */
     get logLevel(): number;
     export(spans: ReadableSpan[]): void;
+    /**
+     * Returns the chalk color function for the given log level.
+     * @param level - The log level index.
+     * @returns A chalk color function.
+     */
     logColor(level: number): import("chalk").ChalkInstance;
+    /**
+     * Determines the log level of a span based on its duration.
+     * @param span - The span to evaluate.
+     * @returns The numeric log level (index into durationToLogLevel).
+     */
     spanLevel(span: ReadableSpan): number;
 }
 //# sourceMappingURL=XyConsoleSpanExporter.d.ts.map

package/dist/neutral/XyConsoleSpanExporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XyConsoleSpanExporter.d.ts","sourceRoot":"","sources":["../../src/XyConsoleSpanExporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAG5C,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,UAEtD;AAED,qBAAa,qBAAsB,SAAQ,mBAAmB;IAC5D,MAAM,CAAC,QAAQ,CAAC,kBAAkB,WAMjC;IAED,MAAM,CAAC,QAAQ,CAAC,oBAAoB,kCAMnC;IAED,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,SAAS,CAAQ;gBAEb,QAAQ,SAAI,EAAE,MAAM,GAAE,MAAgB;IAMlD,IAAI,QAAQ,WAEX;IAEQ,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,IAAI;IAe5C,QAAQ,CAAC,KAAK,EAAE,MAAM;IAItB,SAAS,CAAC,IAAI,EAAE,YAAY;CAW7B"}
+{"version":3,"file":"XyConsoleSpanExporter.d.ts","sourceRoot":"","sources":["../../src/XyConsoleSpanExporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAA;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAG5C;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,YAAY,UAEtD;AAED;;;GAGG;AACH,qBAAa,qBAAsB,SAAQ,mBAAmB;IAC5D,qEAAqE;IACrE,MAAM,CAAC,QAAQ,CAAC,kBAAkB,WAMjC;IAED,6DAA6D;IAC7D,MAAM,CAAC,QAAQ,CAAC,oBAAoB,kCAMnC;IAED,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,SAAS,CAAQ;gBAEb,QAAQ,SAAI,EAAE,MAAM,GAAE,MAAgB;IAMlD,gEAAgE;IAChE,IAAI,QAAQ,WAEX;IAEQ,MAAM,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,IAAI;IAe5C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAItB;;;;OAIG;IACH,SAAS,CAAC,IAAI,EAAE,YAAY;CAW7B"}

package/dist/neutral/index.mjs

@@ -5,6 +5,7 @@ function spanDurationInMillis(span) {
   return span.duration[0] * 1e3 + span.duration[1] / 1e6;
 }
 var XyConsoleSpanExporter = class _XyConsoleSpanExporter extends ConsoleSpanExporter {
+  /** Duration thresholds (in ms) that map to increasing log levels. */
   static durationToLogLevel = [
     0,
     1,
@@ -12,6 +13,7 @@ var XyConsoleSpanExporter = class _XyConsoleSpanExporter extends ConsoleSpanExpo
     100,
     1e3
   ];
+  /** Chalk color functions corresponding to each log level. */
   static logLevelToChalkColor = [
     chalk.grey,
     chalk.white,
@@ -26,6 +28,7 @@ var XyConsoleSpanExporter = class _XyConsoleSpanExporter extends ConsoleSpanExpo
     this._logLevel = logLevel;
     this.logger = logger;
   }
+  /** The minimum log level required for a span to be exported. */
   get logLevel() {
     return this._logLevel;
   }
@@ -43,9 +46,19 @@ var XyConsoleSpanExporter = class _XyConsoleSpanExporter extends ConsoleSpanExpo
       ].join(", ")));
     }
   }
+  /**
+   * Returns the chalk color function for the given log level.
+   * @param level - The log level index.
+   * @returns A chalk color function.
+   */
   logColor(level) {
     return _XyConsoleSpanExporter.logLevelToChalkColor[level] ?? chalk.magenta;
   }
+  /**
+   * Determines the log level of a span based on its duration.
+   * @param span - The span to evaluate.
+   * @returns The numeric log level (index into durationToLogLevel).
+   */
   spanLevel(span) {
     let logLevel = 0;
     const duration = spanDurationInMillis(span);

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/XyConsoleSpanExporter.ts"],"sourcesContent":["import type { ReadableSpan } from '@opentelemetry/sdk-trace-base'\nimport { ConsoleSpanExporter } from '@opentelemetry/sdk-trace-base'\nimport type { Logger } from '@xylabs/logger'\nimport chalk from 'chalk'\n\nexport function spanDurationInMillis(span: ReadableSpan) {\n  return span.duration[0] * 1000 + span.duration[1] / 1e6\n}\n\nexport class XyConsoleSpanExporter extends ConsoleSpanExporter {\n  static readonly durationToLogLevel = [\n    0,\n    1,\n    10,\n    100,\n    1000,\n  ]\n\n  static readonly logLevelToChalkColor = [\n    chalk.grey,\n    chalk.white,\n    chalk.green,\n    chalk.yellow,\n    chalk.red,\n  ]\n\n  logger: Logger\n  private _logLevel: number\n\n  constructor(logLevel = 0, logger: Logger = console) {\n    super()\n    this._logLevel = logLevel\n    this.logger = logger\n  }\n\n  get logLevel() {\n    return this._logLevel\n  }\n\n  override export(spans: ReadableSpan[]): void {\n    for (const span of spans) {\n      const spanLevel = this.spanLevel(span)\n      if (spanLevel < this.logLevel) {\n        continue\n      }\n      const duration = spanDurationInMillis(span)\n      this.logger.log(chalk.grey([\n        `Span [${span.name}]`,\n        this.logColor(spanLevel)(`${duration}ms`),\n        `TraceId: ${span.spanContext().traceId}`,\n      ].join(', ')))\n    }\n  }\n\n  logColor(level: number) {\n    return XyConsoleSpanExporter.logLevelToChalkColor[level] ?? chalk.magenta\n  }\n\n  spanLevel(span: ReadableSpan) {\n    let logLevel = 0\n    const duration = spanDurationInMillis(span)\n    for (let x = XyConsoleSpanExporter.durationToLogLevel.length - 1; x >= 0; x--) {\n      if (duration > XyConsoleSpanExporter.durationToLogLevel[x]) {\n        logLevel = x\n        break\n      }\n    }\n    return logLevel\n  }\n}\n"],"mappings":";AACA,SAAS,2BAA2B;AAEpC,OAAO,WAAW;AAEX,SAAS,qBAAqB,MAAoB;AACvD,SAAO,KAAK,SAAS,CAAC,IAAI,MAAO,KAAK,SAAS,CAAC,IAAI;AACtD;AAEO,IAAM,wBAAN,MAAM,+BAA8B,oBAAoB;AAAA,EAC7D,OAAgB,qBAAqB;AAAA,IACnC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA,EAEA,OAAgB,uBAAuB;AAAA,IACrC,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,EACR;AAAA,EAEA;AAAA,EACQ;AAAA,EAER,YAAY,WAAW,GAAG,SAAiB,SAAS;AAClD,UAAM;AACN,SAAK,YAAY;AACjB,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,IAAI,WAAW;AACb,WAAO,KAAK;AAAA,EACd;AAAA,EAES,OAAO,OAA6B;AAC3C,eAAW,QAAQ,OAAO;AACxB,YAAM,YAAY,KAAK,UAAU,IAAI;AACrC,UAAI,YAAY,KAAK,UAAU;AAC7B;AAAA,MACF;AACA,YAAM,WAAW,qBAAqB,IAAI;AAC1C,WAAK,OAAO,IAAI,MAAM,KAAK;AAAA,QACzB,SAAS,KAAK,IAAI;AAAA,QAClB,KAAK,SAAS,SAAS,EAAE,GAAG,QAAQ,IAAI;AAAA,QACxC,YAAY,KAAK,YAAY,EAAE,OAAO;AAAA,MACxC,EAAE,KAAK,IAAI,CAAC,CAAC;AAAA,IACf;AAAA,EACF;AAAA,EAEA,SAAS,OAAe;AACtB,WAAO,uBAAsB,qBAAqB,KAAK,KAAK,MAAM;AAAA,EACpE;AAAA,EAEA,UAAU,MAAoB;AAC5B,QAAI,WAAW;AACf,UAAM,WAAW,qBAAqB,IAAI;AAC1C,aAAS,IAAI,uBAAsB,mBAAmB,SAAS,GAAG,KAAK,GAAG,KAAK;AAC7E,UAAI,WAAW,uBAAsB,mBAAmB,CAAC,GAAG;AAC1D,mBAAW;AACX;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;","names":[]}
+{"version":3,"sources":["../../src/XyConsoleSpanExporter.ts"],"sourcesContent":["import type { ReadableSpan } from '@opentelemetry/sdk-trace-base'\nimport { ConsoleSpanExporter } from '@opentelemetry/sdk-trace-base'\nimport type { Logger } from '@xylabs/logger'\nimport chalk from 'chalk'\n\n/**\n * Calculates the duration of a span in milliseconds from its high-resolution time tuple.\n * @param span - The span to measure.\n * @returns The span duration in milliseconds.\n */\nexport function spanDurationInMillis(span: ReadableSpan) {\n  return span.duration[0] * 1000 + span.duration[1] / 1e6\n}\n\n/**\n * A console span exporter that formats spans with color-coded durations using chalk.\n * Spans are filtered by a configurable log level based on their duration.\n */\nexport class XyConsoleSpanExporter extends ConsoleSpanExporter {\n  /** Duration thresholds (in ms) that map to increasing log levels. */\n  static readonly durationToLogLevel = [\n    0,\n    1,\n    10,\n    100,\n    1000,\n  ]\n\n  /** Chalk color functions corresponding to each log level. */\n  static readonly logLevelToChalkColor = [\n    chalk.grey,\n    chalk.white,\n    chalk.green,\n    chalk.yellow,\n    chalk.red,\n  ]\n\n  logger: Logger\n  private _logLevel: number\n\n  constructor(logLevel = 0, logger: Logger = console) {\n    super()\n    this._logLevel = logLevel\n    this.logger = logger\n  }\n\n  /** The minimum log level required for a span to be exported. */\n  get logLevel() {\n    return this._logLevel\n  }\n\n  override export(spans: ReadableSpan[]): void {\n    for (const span of spans) {\n      const spanLevel = this.spanLevel(span)\n      if (spanLevel < this.logLevel) {\n        continue\n      }\n      const duration = spanDurationInMillis(span)\n      this.logger.log(chalk.grey([\n        `Span [${span.name}]`,\n        this.logColor(spanLevel)(`${duration}ms`),\n        `TraceId: ${span.spanContext().traceId}`,\n      ].join(', ')))\n    }\n  }\n\n  /**\n   * Returns the chalk color function for the given log level.\n   * @param level - The log level index.\n   * @returns A chalk color function.\n   */\n  logColor(level: number) {\n    return XyConsoleSpanExporter.logLevelToChalkColor[level] ?? chalk.magenta\n  }\n\n  /**\n   * Determines the log level of a span based on its duration.\n   * @param span - The span to evaluate.\n   * @returns The numeric log level (index into durationToLogLevel).\n   */\n  spanLevel(span: ReadableSpan) {\n    let logLevel = 0\n    const duration = spanDurationInMillis(span)\n    for (let x = XyConsoleSpanExporter.durationToLogLevel.length - 1; x >= 0; x--) {\n      if (duration > XyConsoleSpanExporter.durationToLogLevel[x]) {\n        logLevel = x\n        break\n      }\n    }\n    return logLevel\n  }\n}\n"],"mappings":";AACA,SAAS,2BAA2B;AAEpC,OAAO,WAAW;AAOX,SAAS,qBAAqB,MAAoB;AACvD,SAAO,KAAK,SAAS,CAAC,IAAI,MAAO,KAAK,SAAS,CAAC,IAAI;AACtD;AAMO,IAAM,wBAAN,MAAM,+BAA8B,oBAAoB;AAAA;AAAA,EAE7D,OAAgB,qBAAqB;AAAA,IACnC;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAAA;AAAA,EAGA,OAAgB,uBAAuB;AAAA,IACrC,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,IACN,MAAM;AAAA,EACR;AAAA,EAEA;AAAA,EACQ;AAAA,EAER,YAAY,WAAW,GAAG,SAAiB,SAAS;AAClD,UAAM;AACN,SAAK,YAAY;AACjB,SAAK,SAAS;AAAA,EAChB;AAAA;AAAA,EAGA,IAAI,WAAW;AACb,WAAO,KAAK;AAAA,EACd;AAAA,EAES,OAAO,OAA6B;AAC3C,eAAW,QAAQ,OAAO;AACxB,YAAM,YAAY,KAAK,UAAU,IAAI;AACrC,UAAI,YAAY,KAAK,UAAU;AAC7B;AAAA,MACF;AACA,YAAM,WAAW,qBAAqB,IAAI;AAC1C,WAAK,OAAO,IAAI,MAAM,KAAK;AAAA,QACzB,SAAS,KAAK,IAAI;AAAA,QAClB,KAAK,SAAS,SAAS,EAAE,GAAG,QAAQ,IAAI;AAAA,QACxC,YAAY,KAAK,YAAY,EAAE,OAAO;AAAA,MACxC,EAAE,KAAK,IAAI,CAAC,CAAC;AAAA,IACf;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS,OAAe;AACtB,WAAO,uBAAsB,qBAAqB,KAAK,KAAK,MAAM;AAAA,EACpE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,UAAU,MAAoB;AAC5B,QAAI,WAAW;AACf,UAAM,WAAW,qBAAqB,IAAI;AAC1C,aAAS,IAAI,uBAAsB,mBAAmB,SAAS,GAAG,KAAK,GAAG,KAAK;AAC7E,UAAI,WAAW,uBAAsB,mBAAmB,CAAC,GAAG;AAC1D,mBAAW;AACX;AAAA,MACF;AAAA,IACF;AACA,WAAO;AAAA,EACT;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/telemetry-exporter",
-  "version": "5.0.83",
+  "version": "5.0.86",
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "keywords": [
     "hex",
@@ -43,13 +43,13 @@
   ],
   "dependencies": {
     "@opentelemetry/sdk-trace-base": "^2.6.0",
-    "@xylabs/logger": "~5.0.83",
+    "@xylabs/logger": "~5.0.86",
     "chalk": "~5.6.2"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
     "typescript": "~5.9.3",
     "vitest": "^4.0.18"
   },