@ogcio/o11y-sdk-node 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,67 @@
 # Changelog
 
+## [0.3.0](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.2.0...@ogcio/o11y-sdk-node@v0.3.0) (2025-07-28)
+
+
+### Features
+
+* add custom log processor for span enrich ([#102](https://github.com/ogcio/o11y/issues/102)) ([bbf8334](https://github.com/ogcio/o11y/commit/bbf83340940ed651dff63bbe7aaa52881d1e8c8c))
+* add opentelemetry sampler ([#66](https://github.com/ogcio/o11y/issues/66)) ([48a1761](https://github.com/ogcio/o11y/commit/48a1761d68fbccf7b63e4232a62376caecf01fbc))
+* april depedency upgrade AB[#27200](https://github.com/ogcio/o11y/issues/27200) ([#116](https://github.com/ogcio/o11y/issues/116)) ([d792fe5](https://github.com/ogcio/o11y/commit/d792fe5a783b0b495912b5bef2babfe11ef5e01d))
+* june deps update ([#147](https://github.com/ogcio/o11y/issues/147)) ([b365a40](https://github.com/ogcio/o11y/commit/b365a4099cdfd8533ffa4948620d29f0044bbd70))
+* late june deps update ([#154](https://github.com/ogcio/o11y/issues/154)) ([a772622](https://github.com/ogcio/o11y/commit/a7726225a59b2dbcd4326919323d935843b2f93f))
+* may deps update ([#136](https://github.com/ogcio/o11y/issues/136)) ([3edd8b1](https://github.com/ogcio/o11y/commit/3edd8b1d823740d555fc4d93be427e9dc1438a95))
+* o11y sdk repo setup ([#15](https://github.com/ogcio/o11y/issues/15)) ([c5816ba](https://github.com/ogcio/o11y/commit/c5816baff1454353f12539949959e84964ed6401))
+* o11y showcase AB[#25895](https://github.com/ogcio/o11y/issues/25895) ([#84](https://github.com/ogcio/o11y/issues/84)) ([f8f10af](https://github.com/ogcio/o11y/commit/f8f10af97d9f5c188e3e65f7d62d5c673edce25a))
+* remove pnpm test on prepublishOnly script ([#68](https://github.com/ogcio/o11y/issues/68)) ([41f6f57](https://github.com/ogcio/o11y/commit/41f6f57fa415c4f7adc29f49f983539274ef7320))
+* **sdk-node:** add span customization AB[#25358](https://github.com/ogcio/o11y/issues/25358) ([46ba97b](https://github.com/ogcio/o11y/commit/46ba97bac4004ff326a954592f45213ce0e4d683))
+* **sdk-node:** custom metrics ([#53](https://github.com/ogcio/o11y/issues/53)) ([3cb40b1](https://github.com/ogcio/o11y/commit/3cb40b1add3d80615c8d123d233724094559c7ff))
+* **sdk-node:** pii detection on traces and logs ([#176](https://github.com/ogcio/o11y/issues/176)) ([3d72f94](https://github.com/ogcio/o11y/commit/3d72f941b1854278105e7c6d4c4c20248037ecd3))
+* **sdk-node:** renaming MetricsParams interface properties AB[#26188](https://github.com/ogcio/o11y/issues/26188) ([#96](https://github.com/ogcio/o11y/issues/96)) ([244aee0](https://github.com/ogcio/o11y/commit/244aee01ae6e7f319ae7f9fdeff27eb40ee3c863))
+* **sdk-node:** traces and span wrapping utility AB[#29532](https://github.com/ogcio/o11y/issues/29532) ([#175](https://github.com/ogcio/o11y/issues/175)) ([22398d8](https://github.com/ogcio/o11y/commit/22398d8663519e7b2152ebc8766c64bf36a709e7))
+* update AWS secrets manager connection AB[#29565](https://github.com/ogcio/o11y/issues/29565) ([#166](https://github.com/ogcio/o11y/issues/166)) ([962c03d](https://github.com/ogcio/o11y/commit/962c03de2da4060a81aa603c355f3d60cafe3c30))
+* upgrade to opentelemetry 2 AB[#25863](https://github.com/ogcio/o11y/issues/25863) ([#106](https://github.com/ogcio/o11y/issues/106)) ([3ff0314](https://github.com/ogcio/o11y/commit/3ff0314fef9f4d7b5db76da3b94e9035801384c7))
+
+
+### Bug Fixes
+
+* add readme file inside submodule ([#27](https://github.com/ogcio/o11y/issues/27)) ([dc518d5](https://github.com/ogcio/o11y/commit/dc518d5dde573368443bc0f8619e80e331880c78))
+* default attributes in resource ([#112](https://github.com/ogcio/o11y/issues/112)) ([f0f0b9d](https://github.com/ogcio/o11y/commit/f0f0b9d555ef321d31f7171e25dc4b8a5b044522))
+* improve getMetric attributes types ([#76](https://github.com/ogcio/o11y/issues/76)) ([243649c](https://github.com/ogcio/o11y/commit/243649c4bfe750687a729fbd836772cce16e0cb1))
+* prepublishOnly hook ([#60](https://github.com/ogcio/o11y/issues/60)) ([9fbd3ad](https://github.com/ogcio/o11y/commit/9fbd3ad0b45a1604cf2eccc26b2f8855640417a1))
+* **sdk-node:** add waitForReady for grpc-client to handle transient init connection errors AB[#28329](https://github.com/ogcio/o11y/issues/28329) ([#144](https://github.com/ogcio/o11y/issues/144)) ([6f260da](https://github.com/ogcio/o11y/commit/6f260da15fcbcd2c629ec6d4bb9fb3592803f399))
+* **sdk-node:** allow graceful shutdown of instrumentation on SIGTERM AB[#28329](https://github.com/ogcio/o11y/issues/28329) ([#151](https://github.com/ogcio/o11y/issues/151)) ([991ee15](https://github.com/ogcio/o11y/commit/991ee1559898b721823cb9d1e0490e2ad82e6d0a))
+* **sdk-node:** update sdk init examples AB[#28329](https://github.com/ogcio/o11y/issues/28329) ([#146](https://github.com/ogcio/o11y/issues/146)) ([81de295](https://github.com/ogcio/o11y/commit/81de2957a7bef7430a46c6677f3c876255ef7c88))
+
+
+### Miscellaneous Chores
+
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.10 ([#113](https://github.com/ogcio/o11y/issues/113)) ([5474a1d](https://github.com/ogcio/o11y/commit/5474a1dd715dcfcd1da7ec46ea17da3b369529ac))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.11 ([#137](https://github.com/ogcio/o11y/issues/137)) ([90e42ba](https://github.com/ogcio/o11y/commit/90e42ba5b76d7bd89cbffd011f5a2fda1b3e4fe0))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.12 ([#148](https://github.com/ogcio/o11y/issues/148)) ([d495182](https://github.com/ogcio/o11y/commit/d495182d04312a62298b3e5fb18d55c32743c14e))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.13 ([#152](https://github.com/ogcio/o11y/issues/152)) ([5903e22](https://github.com/ogcio/o11y/commit/5903e22c7da8219661c6b9f78a2b3c330bc51823))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.3 ([#30](https://github.com/ogcio/o11y/issues/30)) ([842da9b](https://github.com/ogcio/o11y/commit/842da9b6500c03b0c3a11165a78168724bd0a0f5))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.4 ([#61](https://github.com/ogcio/o11y/issues/61)) ([770873e](https://github.com/ogcio/o11y/commit/770873e7c7d08289e7a8ab46bc801294e9d055bf))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.5 ([#67](https://github.com/ogcio/o11y/issues/67)) ([8ffc453](https://github.com/ogcio/o11y/commit/8ffc45380b76cf59dcbdd86c6f0501b4526948e7))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.6 ([#70](https://github.com/ogcio/o11y/issues/70)) ([32308de](https://github.com/ogcio/o11y/commit/32308de75b80db1b2def63d2b5fcf80328278712))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.7 ([#75](https://github.com/ogcio/o11y/issues/75)) ([5598269](https://github.com/ogcio/o11y/commit/55982690a5a21a18120572a8760f6630aeda2bd1))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.8 ([#86](https://github.com/ogcio/o11y/issues/86)) ([c0956d4](https://github.com/ogcio/o11y/commit/c0956d4eceabb415d72addf5e2b6f5efd5423f62))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.1.0-beta.9 ([#105](https://github.com/ogcio/o11y/issues/105)) ([51e854e](https://github.com/ogcio/o11y/commit/51e854e55753bcca33bdc5bc489e9abe2bdee21c))
+* **auto-release:** release  @ogcio/o11y-sdk-node 0.2.0-beta.13 ([#155](https://github.com/ogcio/o11y/issues/155)) ([a918198](https://github.com/ogcio/o11y/commit/a91819823da965d160dc0a9a302cd0fea88e68d2))
+* **deps-dev:** bump @types/node to `24` AB[#29294](https://github.com/ogcio/o11y/issues/29294) ([3c74c28](https://github.com/ogcio/o11y/commit/3c74c28af41af8403220368ac72a90e40c3e15ae))
+* **deps-dev:** bump the root-deps group across 1 directory with 3 updates ([#150](https://github.com/ogcio/o11y/issues/150)) ([9d574d1](https://github.com/ogcio/o11y/commit/9d574d1af0964fc4af991d677b443015921d93f6))
+* **deps:** bump the root-deps group across 1 directory with 6 updates ([#31](https://github.com/ogcio/o11y/issues/31)) ([591e15f](https://github.com/ogcio/o11y/commit/591e15fcfd8f633f7809de7ca0bfe179251609e7))
+* **deps:** bump the root-deps group across 3 directories with 10 updates ([#64](https://github.com/ogcio/o11y/issues/64)) ([bde04e3](https://github.com/ogcio/o11y/commit/bde04e3d67a6b860a11eca0229dc76e7bbaad13a))
+* **deps:** bump the root-deps group across 3 directories with 28 updates ([#74](https://github.com/ogcio/o11y/issues/74)) ([b67190c](https://github.com/ogcio/o11y/commit/b67190c18c175770c1661c1c70dcf9990c9cb275))
+* dx improvements ([#22](https://github.com/ogcio/o11y/issues/22)) ([1698662](https://github.com/ogcio/o11y/commit/1698662cb2a96220f36959c30480db06a1be2e61))
+* migrate from node:test to vitest ([#20](https://github.com/ogcio/o11y/issues/20)) ([fd1300b](https://github.com/ogcio/o11y/commit/fd1300b1a72c5fac972ccd42b7b05ad125d6e33e))
+* packages updates ([#44](https://github.com/ogcio/o11y/issues/44)) ([11ecc75](https://github.com/ogcio/o11y/commit/11ecc75e7a4e8983dd0f8a9f499e8cb8c21b00ee))
+* **release:** release @ogcio/o11y-sdk-node 0.1.0-beta.1 ([#25](https://github.com/ogcio/o11y/issues/25)) ([0c17f98](https://github.com/ogcio/o11y/commit/0c17f980cf782ab02e1b5243a50e5d37772a590d))
+* **release:** release @ogcio/o11y-sdk-node 0.1.0-beta.2 ([#28](https://github.com/ogcio/o11y/issues/28)) ([1468e48](https://github.com/ogcio/o11y/commit/1468e4832ad757a733e54d2f110d85345904ec50))
+* removed deprecated dep is-url from react-sdk ([#77](https://github.com/ogcio/o11y/issues/77)) ([4ef27d3](https://github.com/ogcio/o11y/commit/4ef27d3a5d01323ea1abdd7659900d4a2a31adce))
+* update dependencies ([#91](https://github.com/ogcio/o11y/issues/91)) ([a16a8cd](https://github.com/ogcio/o11y/commit/a16a8cd1b072f7f6906f8a77b9bab2a4dad9fdee))
+* update integration tests and docs ([#171](https://github.com/ogcio/o11y/issues/171)) ([d03b2a5](https://github.com/ogcio/o11y/commit/d03b2a54d1832aa160b9e8ed3cc28fc72005475c))
+
 ## [0.2.0](https://github.com/ogcio/o11y/compare/@ogcio/o11y-sdk-node@v0.1.0-beta.13...@ogcio/o11y-sdk-node@v0.2.0) (2025-06-24)
 
 

package/README.md

@@ -56,6 +56,8 @@ Or setup inside your package.json
 }
 ```
 
+# Traces
+
 ## Span Customization
 
 It is possible to customize spans such as traces and logs globally or in a single code statement using predefined functions.
@@ -85,27 +87,170 @@ instrumentNode({
 });
 ```
 
-### Edit Active Span
+### PII Detection
+
+By default the sdk detect and redact email PII from traces and logs
+
+example:
 
-Using `getActiveSpan` function, you can access to current transaction span and customize it.
+```
+input: user access: name.lastname@domain.com
+output: user access: [REDACTED EMAIL]
+```
 
-You can use the function everywhere in your code, and set some custom attributes that are enabled for that single span
+You can disable PII detection with `detection` object inside `NodeSDKConfig`
 
 ```typescript
-import { getActiveSpan } from "@ogcio/o11y-sdk-node";
+instrumentNode({
+  detection: {
+    email: false,
+  },
+});
+```
 
-async function routes(app: FastifyInstance) {
-  app.get("/", async (req, reply) => {
-    // validation and business logic
+### PII Detection
 
-    // set span attribute
-    getActiveSpan()?.setAttribute("business.info", "dummy");
+By default the sdk detect and redact email PII from traces and logs
 
-    reply.status(200).send(response);
-  });
-}
+example:
+
+```
+input: user acces: name.lastname@domain.com
+output: user access: [REDACTED EMAIL]
+```
+
+You can disable PII detection with `detection` object inside `NodeSDKConfig`
+
+```typescript
+instrumentNode({
+  detection: {
+    email: false,
+  },
+});
 ```
 
+## Utils:
+
+- ## `withSpan`:
+
+  ### Key Features
+  - **Automatic Span Management**: Spans are automatically started, ended, and their status is set based on execution success or failure
+    - **Exception Recording**: Errors are automatically recorded with proper span status codes
+    - **Flexible Configuration**: Support for custom tracer names, span options, and attributes
+    - **Promise Support**: Works seamlessly with both synchronous and asynchronous functions
+    - **Nested Tracing**: Spans created within existing trace contexts automatically become child spans
+
+  ### Usage:
+
+  ```ts
+  import { SpanOptions } from "@opentelemetry/api";
+
+  export type WithSpanParams<T> = {
+    /**
+     * The name of the trace the span should belong to.
+     * NOTE: If you want the new span to belong to an already existing trace, you should provide the same tracer name
+     */
+    traceName?: string;
+    spanName: string;
+    spanOptions?: SpanOptions;
+    /** A function defining the task you want to be wrapped by this span */
+    fn: (span: Span) => T | Promise<T>;
+  };
+  ```
+
+  ### examples:
+
+  ### **Creating a Top-Level Trace (e.g. Worker Job)**
+
+  Use to create a top-level trace for background jobs, workers, or any standalone operations: `withSpan`
+
+  ```ts
+  import { withSpan } from "@ogcio/o11y-sdk-node";
+
+  async function processEmailQueue() {
+    return withSpan({
+      traceName: "email-worker",
+      spanName: "process-email-queue",
+      fn: async (span) => {
+        // Your worker logic here
+        const emails = await fetchPendingEmails();
+        span.setAttributes({
+          "email.count": emails.length,
+          "worker.batch.id": generateBatchId(),
+        });
+
+        for (const email of emails) {
+          await sendEmail(email);
+        }
+
+        return { processed: emails.length };
+      },
+    });
+  }
+  ```
+
+  ### **Nesting Spans Inside Existing Traces**
+
+  Create child spans within existing trace contexts to provide detailed operation breakdown:
+
+  ```typescript
+  async function orderProcessing(orderId: string) {
+    return withSpan({
+      spanName: "process-order",
+      fn: async (parentSpan) => {
+        // Child span for validation
+        const validation = await withSpan({
+          spanName: "validate-order",
+          fn: async (span) => {
+            span.setAttribute("order.id", orderId);
+            return await validateOrder(orderId);
+          },
+        });
+        // Child span for payment
+        const payment = await withSpan({
+          spanName: "process-payment",
+          fn: async (span) => {
+            span.setAttribute("payment.amount", validation.amount);
+            return await processPayment(orderId, validation.amount);
+          },
+        });
+
+        parentSpan.setAttributes({
+          "order.status": "completed",
+          "order.total": payment.amount,
+        });
+
+        return { orderId, status: "completed" };
+      },
+    });
+  }
+  ```
+
+- ## `getActiveSpan`:
+
+  Using `getActiveSpan` function, you can access to current transaction span and customize it.
+
+  ### Examples:
+
+  ### **Edit Active Span**
+
+  You can use the function everywhere in your code, and set some custom attributes that are enabled for that single span
+
+  ```typescript
+  import { getActiveSpan } from "@ogcio/o11y-sdk-node";
+
+  async function routes(app: FastifyInstance) {
+    app.get("/", async (req, reply) => {
+      // validation and business logic
+
+      // set span attribute
+      getActiveSpan()?.setAttribute("business.info", "dummy");
+
+      reply.status(200).send(response);
+    });
+  }
+  ```
+
 ## Sending Custom Metrics
 
 This package gives the possibility to send custom metrics and define them as desired in the code, you can choose between sync metrics and observable async metrics.
@@ -199,7 +344,7 @@ protocol is a string parameter used to define how to send signals to observabili
 
 #### Shared Types
 
-```ts
+```typescript
 export type SDKLogLevel =
   | "NONE"
   | "ERROR"

package/dist/lib/config-manager.d.ts

@@ -0,0 +1,3 @@
+import { NodeSDKConfig } from "./index.js";
+export declare const setNodeSdkConfig: (config: NodeSDKConfig) => void;
+export declare const getNodeSdkConfig: () => NodeSDKConfig;

package/dist/lib/config-manager.js

@@ -0,0 +1,11 @@
+let nodeSDKConfig;
+export const setNodeSdkConfig = (config) => {
+    nodeSDKConfig = config;
+};
+export const getNodeSdkConfig = () => {
+    if (!nodeSDKConfig) {
+        throw new Error("Node SDK Config was not initialized.");
+    }
+    // Ensure getters do not edit config.
+    return JSON.parse(JSON.stringify(nodeSDKConfig));
+};

package/dist/lib/exporter/console.js

@@ -1,19 +1,18 @@
 import { ConsoleLogRecordExporter, SimpleLogRecordProcessor, } from "@opentelemetry/sdk-logs";
 import { metrics } from "@opentelemetry/sdk-node";
 import { ConsoleSpanExporter, SimpleSpanProcessor, } from "@opentelemetry/sdk-trace-base";
-import { EnrichSpanProcessor } from "../processor/enrich-span-processor.js";
-import { EnrichLogProcessor } from "../processor/enrich-logger-processor.js";
+import { _logsProcessorConfig, _spansProcessorConfig, } from "./processor-config.js";
 export default function buildConsoleExporters(config) {
     return {
         spans: [
             new SimpleSpanProcessor(new ConsoleSpanExporter()),
-            new EnrichSpanProcessor(config.spanAttributes),
+            ..._spansProcessorConfig(config),
         ],
         metrics: new metrics.PeriodicExportingMetricReader({
             exporter: new metrics.ConsoleMetricExporter(),
         }),
         logs: [
-            new EnrichLogProcessor(config.spanAttributes),
+            ..._logsProcessorConfig(config),
             new SimpleLogRecordProcessor(new ConsoleLogRecordExporter()),
         ],
     };

package/dist/lib/exporter/grpc.js

@@ -1,11 +1,12 @@
-import { metrics } from "@opentelemetry/sdk-node";
-import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
 import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
 import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
+import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
+import { metrics } from "@opentelemetry/sdk-node";
 import { LogRecordProcessorMap, SpanProcessorMap } from "../utils.js";
-import { EnrichSpanProcessor } from "../processor/enrich-span-processor.js";
-import { EnrichLogProcessor } from "../processor/enrich-logger-processor.js";
+import { _logsProcessorConfig, _spansProcessorConfig, } from "./processor-config.js";
+import { getNodeSdkConfig } from "../config-manager.js";
+import { PIIExporterDecorator } from "./pii-exporter-decorator.js";
 async function defaultMetadata() {
     const { Metadata } = await import("@grpc/grpc-js");
     return new Metadata({
@@ -15,27 +16,27 @@ async function defaultMetadata() {
 export default async function buildGrpcExporters(config) {
     return {
         spans: [
-            new SpanProcessorMap[config.collectorMode ?? "batch"](new OTLPTraceExporter({
+            new SpanProcessorMap[config.collectorMode ?? "batch"](new PIIExporterDecorator(new OTLPTraceExporter({
                 url: `${config.collectorUrl}`,
                 compression: CompressionAlgorithm.GZIP,
                 metadata: config.grpcMetadata ?? (await defaultMetadata()),
-            })),
-            new EnrichSpanProcessor(config.spanAttributes),
+            }), getNodeSdkConfig())),
+            ..._spansProcessorConfig(config),
         ],
         metrics: new metrics.PeriodicExportingMetricReader({
-            exporter: new OTLPMetricExporter({
+            exporter: new PIIExporterDecorator(new OTLPMetricExporter({
                 url: `${config.collectorUrl}`,
                 compression: CompressionAlgorithm.GZIP,
                 metadata: config.grpcMetadata ?? (await defaultMetadata()),
-            }),
+            }), getNodeSdkConfig()),
         }),
         logs: [
-            new EnrichLogProcessor(config.spanAttributes),
-            new LogRecordProcessorMap[config.collectorMode ?? "batch"](new OTLPLogExporter({
+            ..._logsProcessorConfig(config),
+            new LogRecordProcessorMap[config.collectorMode ?? "batch"](new PIIExporterDecorator(new OTLPLogExporter({
                 url: `${config.collectorUrl}`,
                 compression: CompressionAlgorithm.GZIP,
                 metadata: config.grpcMetadata ?? (await defaultMetadata()),
-            })),
+            }), getNodeSdkConfig())),
         ],
     };
 }

package/dist/lib/exporter/http.d.ts

@@ -1,3 +1,3 @@
-import { Exporters } from "./index.js";
 import { NodeSDKConfig } from "../index.js";
+import { Exporters } from "./index.js";
 export default function buildHttpExporters(config: NodeSDKConfig): Exporters;

package/dist/lib/exporter/http.js

@@ -1,35 +1,36 @@
-import { metrics } from "@opentelemetry/sdk-node";
-import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
 import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
 import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
+import { metrics } from "@opentelemetry/sdk-node";
 import { LogRecordProcessorMap, SpanProcessorMap } from "../utils.js";
-import { EnrichSpanProcessor } from "../processor/enrich-span-processor.js";
-import { EnrichLogProcessor } from "../processor/enrich-logger-processor.js";
+import { _logsProcessorConfig, _spansProcessorConfig, } from "./processor-config.js";
+import { getNodeSdkConfig } from "../config-manager.js";
+import { PIIExporterDecorator } from "./pii-exporter-decorator.js";
 export default function buildHttpExporters(config) {
     if (config.collectorUrl.endsWith("/")) {
         config.collectorUrl = config.collectorUrl.slice(0, -1);
     }
     return {
         spans: [
-            new SpanProcessorMap[config.collectorMode ?? "batch"](new OTLPTraceExporter({
+            new SpanProcessorMap[config.collectorMode ?? "batch"](new PIIExporterDecorator(new OTLPTraceExporter({
                 url: `${config.collectorUrl}/v1/traces`,
                 compression: CompressionAlgorithm.GZIP,
-            })),
-            new EnrichSpanProcessor(config.spanAttributes),
+            }), getNodeSdkConfig())),
+            ..._spansProcessorConfig(config),
         ],
         metrics: new metrics.PeriodicExportingMetricReader({
-            exporter: new OTLPMetricExporter({
+            exporter: new PIIExporterDecorator(new OTLPMetricExporter({
                 url: `${config.collectorUrl}/v1/metrics`,
                 compression: CompressionAlgorithm.GZIP,
-            }),
+            }), getNodeSdkConfig()),
         }),
         logs: [
-            new EnrichLogProcessor(config.spanAttributes),
-            new LogRecordProcessorMap[config.collectorMode ?? "batch"](new OTLPLogExporter({
+            ..._logsProcessorConfig(config),
+            new LogRecordProcessorMap[config.collectorMode ?? "batch"](new PIIExporterDecorator(new OTLPLogExporter({
                 url: `${config.collectorUrl}/v1/logs`,
                 compression: CompressionAlgorithm.GZIP,
-            })),
+            }), getNodeSdkConfig())),
         ],
     };
 }

package/dist/lib/exporter/pii-exporter-decorator.d.ts

@@ -0,0 +1,20 @@
+import { ExportResult } from "@opentelemetry/core";
+import { OTLPExporterBase } from "@opentelemetry/otlp-exporter-base";
+import { ReadableLogRecord } from "@opentelemetry/sdk-logs";
+import { ReadableSpan, SpanExporter } from "@opentelemetry/sdk-trace-base";
+import { NodeSDKConfig } from "../index.js";
+import { PushMetricExporter, ResourceMetrics } from "@opentelemetry/sdk-metrics";
+export declare class PIIExporterDecorator extends OTLPExporterBase<(ReadableSpan | ReadableLogRecord)[] | ResourceMetrics> implements SpanExporter, PushMetricExporter {
+    private readonly _exporter;
+    private readonly _config;
+    constructor(exporter: OTLPExporterBase<(ReadableSpan | ReadableLogRecord)[] | ResourceMetrics>, config: NodeSDKConfig);
+    forceFlush(): Promise<void>;
+    shutdown(): Promise<void>;
+    export(items: (ReadableSpan | ReadableLogRecord)[] | ResourceMetrics, resultCallback: (result: ExportResult) => void): void;
+    private _isReadableSpan;
+    private _isReadableLogRecord;
+    private _isResourceMetrics;
+    private _redactSpan;
+    private _redactLogRecord;
+    private _redactResourceMetrics;
+}

package/dist/lib/exporter/pii-exporter-decorator.js

@@ -0,0 +1,103 @@
+import { OTLPExporterBase } from "@opentelemetry/otlp-exporter-base";
+import { _cleanLogBodyPII, _cleanObjectPII, _cleanStringPII, } from "../internals/pii-detection.js";
+export class PIIExporterDecorator extends OTLPExporterBase {
+    _exporter;
+    _config;
+    constructor(exporter, config) {
+        super(exporter["_delegate"]);
+        this._exporter = exporter;
+        this._config = config;
+    }
+    forceFlush() {
+        return this._exporter.forceFlush();
+    }
+    shutdown() {
+        return this._exporter.shutdown();
+    }
+    export(items, resultCallback) {
+        if (!this._config.detection?.email) {
+            this._exporter.export(items, resultCallback);
+            return;
+        }
+        if (Array.isArray(items)) {
+            const redactedItem = items.map((item) => {
+                if (this._isReadableSpan(item)) {
+                    this._redactSpan(item);
+                }
+                else if (this._isReadableLogRecord(item)) {
+                    this._redactLogRecord(item);
+                }
+                return item;
+            });
+            this._exporter.export(redactedItem, resultCallback);
+            return;
+        }
+        if (this._isResourceMetrics(items)) {
+            this._redactResourceMetrics(items);
+            this._exporter.export(items, resultCallback);
+        }
+    }
+    _isReadableSpan(span) {
+        return (typeof span === "object" &&
+            span !== null &&
+            "name" in span &&
+            "kind" in span &&
+            "spanContext" in span &&
+            "attributes" in span);
+    }
+    _isReadableLogRecord(span) {
+        return (typeof span === "object" &&
+            span !== null &&
+            "body" in span &&
+            "attributes" in span &&
+            "severityText" in span &&
+            "severityNumber" in span);
+    }
+    _isResourceMetrics(obj) {
+        return (typeof obj === "object" &&
+            obj !== null &&
+            !Array.isArray(obj) &&
+            "resource" in obj &&
+            "scopeMetrics" in obj);
+    }
+    _redactSpan(span) {
+        Object.assign(span, {
+            name: _cleanStringPII(span.name, "trace"),
+            attributes: span.attributes && _cleanObjectPII(span.attributes, "trace"),
+            resource: {
+                attributes: span?.resource?.attributes &&
+                    _cleanObjectPII(span.resource.attributes, "trace"),
+            },
+            links: span?.links?.map((link) => {
+                Object.assign(link, {
+                    attributes: link?.attributes && _cleanObjectPII(link.attributes, "trace"),
+                });
+            }),
+            events: span?.events?.map((event) => {
+                Object.assign(event, {
+                    name: _cleanStringPII(event.name, "trace"),
+                    attributes: event?.attributes && _cleanObjectPII(event.attributes, "trace"),
+                });
+                return event;
+            }),
+        });
+    }
+    _redactLogRecord(log) {
+        Object.assign(log, {
+            body: _cleanLogBodyPII(log.body),
+            attributes: log.attributes && _cleanObjectPII(log.attributes, "log"),
+            resource: {
+                attributes: log?.resource?.attributes &&
+                    _cleanObjectPII(log.resource.attributes, "log"),
+            },
+        });
+    }
+    _redactResourceMetrics(metric) {
+        Object.assign(metric, {
+            resource: {
+                attributes: metric?.resource?.attributes &&
+                    _cleanObjectPII(metric.resource.attributes, "metric"),
+            },
+        });
+    }
+}

package/dist/lib/exporter/processor-config.d.ts

@@ -0,0 +1,5 @@
+import { NodeSDKConfig } from "../index.js";
+import { EnrichLogProcessor } from "../processor/enrich-logger-processor.js";
+import { EnrichSpanProcessor } from "../processor/enrich-span-processor.js";
+export declare function _spansProcessorConfig(config: NodeSDKConfig): EnrichSpanProcessor[];
+export declare function _logsProcessorConfig(config: NodeSDKConfig): EnrichLogProcessor[];

package/dist/lib/exporter/processor-config.js

@@ -0,0 +1,16 @@
+import { EnrichLogProcessor } from "../processor/enrich-logger-processor.js";
+import { EnrichSpanProcessor } from "../processor/enrich-span-processor.js";
+export function _spansProcessorConfig(config) {
+    const _processor = [];
+    if (config.spanAttributes) {
+        _processor.push(new EnrichSpanProcessor(config.spanAttributes));
+    }
+    return _processor;
+}
+export function _logsProcessorConfig(config) {
+    const _processor = [];
+    if (config.spanAttributes) {
+        _processor.push(new EnrichLogProcessor(config.spanAttributes));
+    }
+    return _processor;
+}

package/dist/lib/index.d.ts

@@ -2,14 +2,18 @@ import type { Metadata } from "@grpc/grpc-js";
 export interface NodeSDKConfig {
     /**
      * The opentelemetry collector entrypoint GRPC url.
-     * If the collectoUrl is null or undefined, the instrumentation will not be activated.
+     * If the collectorUrl is null or undefined, the instrumentation will not be activated.
      * @example http://alloy:4317
      */
     collectorUrl: string;
     /**
-     * Name of your application used for the collector to group logs
+     * Name of your application used for the collector to group logs and naming traces
      */
     serviceName?: string;
+    /**
+     * Version of your application used for the collector to group logs and naming traces
+     */
+    serviceVersion?: string;
     /**
      * Diagnostic log level for the internal runtime instrumentation
      *
@@ -19,7 +23,7 @@ export interface NodeSDKConfig {
     diagLogLevel?: SDKLogLevel;
     /**
      * Collector signals processing mode.
-     * signle: makes an http/grpc request for each signal and it is immediately processed inside grafana
+     * single: makes an http/grpc request for each signal, and it is immediately processed inside grafana
      * batch: sends multiple signals within a time window, optimized to reduce http/grpc calls in production
      *
      * @type string
@@ -34,7 +38,7 @@ export interface NodeSDKConfig {
      */
     ignoreUrls?: SamplerCondition[];
     /**
-     * Object containing static properties or functions used to evaluate custom attributes for every logs and traces.
+     * Object containing static properties or functions used to evaluate custom attributes for all logs and traces.
      */
     spanAttributes?: Record<string, SignalAttributeValue | (() => SignalAttributeValue)>;
     /**
@@ -65,6 +69,16 @@ export interface NodeSDKConfig {
      * @default { waitForReady: true }
      */
     grpcMetadata?: Metadata;
+    /**
+     * Enable/Disable PII detection for GDPR data
+     */
+    detection?: {
+        /**
+         * Redact email address
+         * @default true
+         */
+        email?: boolean;
+    };
 }
 export interface SamplerCondition {
     type: "endsWith" | "includes" | "equals";