@logtape/otel 0.2.0 → 0.3.0

package/README.md

@@ -151,6 +151,20 @@ needed.
 Changelog
 ---------
 
+### Version 0.3.0
+
+Released on February 26, 2025.
+
+ -  Now you can customize the body formatter.  [[#1] by Hyeseong Kim]
+
+     -  Added `BodyFormatter` type.
+     -  Changed the type of `OpenTelemetrySinkOptions.messageType` to
+        `"string" | "array" | BodyFormatter | undefined` (was
+        `"string" | "array" | undefined`).
+
+[#1]: https://github.com/dahlia/logtape-otel/pull/1
+
+
 ### Version 0.2.0
 
 Released on August 26, 2024.

package/esm/deno.js

@@ -1,6 +1,6 @@
 export default {
     "name": "@logtape/otel",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "license": "MIT",
     "exports": {
         ".": "./mod.ts"

package/esm/mod.js

@@ -49,13 +49,14 @@ export function getOpenTelemetrySink(options = {}) {
         const severityNumber = mapLevelToSeverityNumber(level);
         const attributes = convertToAttributes(properties, objectRenderer);
         attributes["category"] = [...category];
-        const body = convertMessageToBody(message, objectRenderer);
         logger.emit({
             severityNumber,
             severityText: level,
-            body: options.messageType === "array"
-                ? body
-                : body.map((v) => v === undefined ? "undefined" : v === null ? "null" : v).join(""),
+            body: typeof options.messageType === "function"
+                ? convertMessageToCustomBodyFormat(message, objectRenderer, options.messageType)
+                : options.messageType === "array"
+                    ? convertMessageToArray(message, objectRenderer)
+                    : convertMessageToString(message, objectRenderer),
             attributes,
             timestamp: new Date(timestamp),
         });
@@ -124,7 +125,7 @@ function convertToString(value, objectRenderer) {
     else
         return JSON.stringify(value);
 }
-function convertMessageToBody(message, objectRenderer) {
+function convertMessageToArray(message, objectRenderer) {
     const body = [];
     for (let i = 0; i < message.length; i += 2) {
         const msg = message[i];
@@ -136,6 +137,23 @@ function convertMessageToBody(message, objectRenderer) {
     }
     return body;
 }
+function convertMessageToString(message, objectRenderer) {
+    let body = "";
+    for (let i = 0; i < message.length; i += 2) {
+        const msg = message[i];
+        body += msg;
+        if (message.length <= i + 1)
+            break;
+        const val = message[i + 1];
+        const extra = convertToString(val, objectRenderer);
+        body += extra ?? JSON.stringify(extra);
+    }
+    return body;
+}
+function convertMessageToCustomBodyFormat(message, objectRenderer, bodyFormatter) {
+    const body = message.map((msg) => convertToString(msg, objectRenderer));
+    return bodyFormatter(body);
+}
 /**
  * A platform-specific inspect function.  In Deno, this is {@link Deno.inspect},
  * and in Node.js/Bun it is {@link util.inspect}.  If neither is available, it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/otel",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "LogTape OpenTelemetry Sink",
   "keywords": [
     "LogTape",

package/script/deno.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = {
     "name": "@logtape/otel",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "license": "MIT",
     "exports": {
         ".": "./mod.ts"

package/script/mod.js

@@ -78,13 +78,14 @@ function getOpenTelemetrySink(options = {}) {
         const severityNumber = mapLevelToSeverityNumber(level);
         const attributes = convertToAttributes(properties, objectRenderer);
         attributes["category"] = [...category];
-        const body = convertMessageToBody(message, objectRenderer);
         logger.emit({
             severityNumber,
             severityText: level,
-            body: options.messageType === "array"
-                ? body
-                : body.map((v) => v === undefined ? "undefined" : v === null ? "null" : v).join(""),
+            body: typeof options.messageType === "function"
+                ? convertMessageToCustomBodyFormat(message, objectRenderer, options.messageType)
+                : options.messageType === "array"
+                    ? convertMessageToArray(message, objectRenderer)
+                    : convertMessageToString(message, objectRenderer),
             attributes,
             timestamp: new Date(timestamp),
         });
@@ -153,7 +154,7 @@ function convertToString(value, objectRenderer) {
     else
         return JSON.stringify(value);
 }
-function convertMessageToBody(message, objectRenderer) {
+function convertMessageToArray(message, objectRenderer) {
     const body = [];
     for (let i = 0; i < message.length; i += 2) {
         const msg = message[i];
@@ -165,6 +166,23 @@ function convertMessageToBody(message, objectRenderer) {
     }
     return body;
 }
+function convertMessageToString(message, objectRenderer) {
+    let body = "";
+    for (let i = 0; i < message.length; i += 2) {
+        const msg = message[i];
+        body += msg;
+        if (message.length <= i + 1)
+            break;
+        const val = message[i + 1];
+        const extra = convertToString(val, objectRenderer);
+        body += extra ?? JSON.stringify(extra);
+    }
+    return body;
+}
+function convertMessageToCustomBodyFormat(message, objectRenderer, bodyFormatter) {
+    const body = message.map((msg) => convertToString(msg, objectRenderer));
+    return bodyFormatter(body);
+}
 /**
  * A platform-specific inspect function.  In Deno, this is {@link Deno.inspect},
  * and in Node.js/Bun it is {@link util.inspect}.  If neither is available, it

package/types/mod.d.ts

@@ -1,5 +1,5 @@
 import { type Sink } from "@logtape/logtape";
-import { type LoggerProvider as LoggerProviderBase } from "@opentelemetry/api-logs";
+import { type AnyValue, type LoggerProvider as LoggerProviderBase } from "@opentelemetry/api-logs";
 import type { OTLPExporterNodeConfigBase } from "@opentelemetry/otlp-exporter-base";
 import { type LogRecordProcessor } from "@opentelemetry/sdk-logs";
 /**
@@ -26,6 +26,12 @@ type ILoggerProvider = LoggerProviderBase & {
  * `Deno.inspect` in Deno.
  */
 export type ObjectRenderer = "json" | "inspect";
+type Message = (string | null | undefined)[];
+/**
+ * Custom `body` attribute formatter.
+ * @since 0.3.0
+ */
+export type BodyFormatter = (message: Message) => AnyValue;
 /**
  * Options for creating an OpenTelemetry sink.
  */
@@ -39,9 +45,11 @@ export interface OpenTelemetrySinkOptions {
      * the message is rendered as a single string with the values are
      * interpolated into the message.  If `"array"`, the message is
      * rendered as an array of strings.  `"string"` by default.
+     *
+     * Or even fully customizable with a {@link BodyFormatter} function.
      * @since 0.2.0
      */
-    messageType?: "string" | "array";
+    messageType?: "string" | "array" | BodyFormatter;
     /**
      * The way to render the object in the log record.  If `"json"`,
      * the object is rendered as a JSON string.  If `"inspect"`,

package/types/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,IAAI,EACV,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAEL,KAAK,cAAc,IAAI,kBAAkB,EAG1C,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAEpF,OAAO,EAEL,KAAK,kBAAkB,EAExB,MAAM,yBAAyB,CAAC;AAKjC;;GAEG;AACH,KAAK,eAAe,GAAG,kBAAkB,GAAG;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE3D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC;IAEjC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAEjC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;IAEhD;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,wBAA6B,GACrC,IAAI,CAuDN"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,IAAI,EACV,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,cAAc,IAAI,kBAAkB,EAG1C,MAAM,yBAAyB,CAAC;AAEjC,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAEpF,OAAO,EAEL,KAAK,kBAAkB,EAExB,MAAM,yBAAyB,CAAC;AAKjC;;GAEG;AACH,KAAK,eAAe,GAAG,kBAAkB,GAAG;IAC1C;;;OAGG;IACH,qBAAqB,CAAC,SAAS,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAE3D;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,CAAC;AAEhD,KAAK,OAAO,GAAG,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,EAAE,OAAO,KAAK,QAAQ,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,cAAc,CAAC,EAAE,eAAe,CAAC;IAEjC;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,aAAa,CAAC;IAEjD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,0BAA0B,CAAC;IAEhD;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,GAAE,wBAA6B,GACrC,IAAI,CA0DN"}