@ogcio/o11y-sdk-node 0.4.2 → 0.6.0

package/dist/lib/internals/redaction/redactors/ip.js

@@ -1,54 +0,0 @@
-import { _getPIICounterRedactionMetric } from "../../shared-metrics.js";
-// Generous IP address matchers (might match some invalid addresses like 192.168.01.1)
-const IPV4_REGEX = /(?<!\d)(?:%[0-9A-Fa-f]{2})?(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}(?:%[0-9A-Fa-f]{2})?(?!\d)/gi;
-const IPV6_REGEX = /(?<![0-9a-f:])(?:%[0-9A-Fa-f]{2})?((?:[0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4}|(?:[0-9A-Fa-f]{1,4}:){1,7}:|:(?::[0-9A-Fa-f]{1,4}){1,7}|(?:[0-9A-Fa-f]{1,4}:){1,6}:[0-9A-Fa-f]{1,4}|(?:[0-9A-Fa-f]{1,4}:){1,5}(?::[0-9A-Fa-f]{1,4}){1,2}|(?:[0-9A-Fa-f]{1,4}:){1,4}(?::[0-9A-Fa-f]{1,4}){1,3}|(?:[0-9A-Fa-f]{1,4}:){1,3}(?::[0-9A-Fa-f]{1,4}){1,4}|(?:[0-9A-Fa-f]{1,4}:){1,2}(?::[0-9A-Fa-f]{1,4}){1,5}|[0-9A-Fa-f]{1,4}:(?::[0-9A-Fa-f]{1,4}){1,6}|:(?::[0-9A-Fa-f]{1,4}){1,7}:?|(?:[0-9A-Fa-f]{1,4}:){1,4}:(?:25[0-5]|2[0-4]\d|1\d\d|\d{1,2})(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|\d{1,2})){3})(?:%[0-9A-Fa-f]{2})?(?![0-9a-f:])/gi;
-/**
- * Redacts all ip addresses in the input string and collects metadata.
- *
- * @param {string} value The input string potentially containing ip addresses.
- * @returns {{
- *   redacted: string,
- *   count: number,
- *   domains: Record<string, number>
- * }}
- *
- * An object containing:
- *   - `redacted`: the string with IP addresses replaced by `[REDACTED IPV*]`
- *   - `counters`: total number of addresses redacted by IPv* type
- *   - `domains`: a map of domain names to the number of times they were redacted
- */
-function _redactIps(value) {
-    const counters = {};
-    const redacted = value
-        .replace(IPV4_REGEX, () => {
-        counters["IPv4"] = (counters["IPv4"] || 0) + 1;
-        return "[REDACTED IPV4]";
-    })
-        .replace(IPV6_REGEX, () => {
-        counters["IPv4"] = (counters["IPv4"] || 0) + 1;
-        return "[REDACTED IPV6]";
-    });
-    return { redacted, counters };
-}
-/**
- * Redacts provided input and collects metadata metrics about redacted IPs,
- * data source and kind.
- *
- * @param {string} value The input string potentially containing IP addresses.
- * @param {string} source The source of the attribute being redacted (log, span, metric).
- * @param {string} kind The type of the data structure containing the PII
- * @returns {string} the redacted value
- */
-export const ipRedactor = (value, source, kind) => {
-    const { redacted, counters } = _redactIps(value);
-    Object.entries(counters).forEach(([type, counter]) => {
-        if (counter > 0) {
-            _getPIICounterRedactionMetric().add(counter, {
-                pii_type: type,
-                redaction_source: source,
-                pii_format: kind,
-            });
-        }
-    });
-    return redacted;
-};

package/dist/lib/internals/shared-metrics.d.ts

@@ -1,7 +0,0 @@
-import { Attributes, Counter } from "@opentelemetry/api";
-/**
- * Returns a singleton OpenTelemetry counter metric used to record occurrences of PII redactions.
- *
- * @returns {Counter} The singleton OpenTelemetry counter metric for PII redactions.
- */
-export declare function _getPIICounterRedactionMetric(): Counter<Attributes>;

package/dist/lib/internals/shared-metrics.js

@@ -1,18 +0,0 @@
-import { getMetric } from "../metrics.js";
-// Cached singleton instance of the redaction counter metric
-let _redactedCounter;
-/**
- * Returns a singleton OpenTelemetry counter metric used to record occurrences of PII redactions.
- *
- * @returns {Counter} The singleton OpenTelemetry counter metric for PII redactions.
- */
-export function _getPIICounterRedactionMetric() {
-    if (_redactedCounter) {
-        return _redactedCounter;
-    }
-    _redactedCounter = getMetric("counter", {
-        meterName: "o11y",
-        metricName: "o11y_pii_redaction",
-    });
-    return _redactedCounter;
-}

package/dist/package.json

@@ -1,59 +0,0 @@
-{
-    "name": "@ogcio/o11y-sdk-node",
-    "version": "0.4.2",
-    "description": "Opentelemetry standard instrumentation SDK for NodeJS based project",
-    "main": "dist/index.js",
-    "type": "module",
-    "scripts": {
-        "build": "rm -rf dist && tsc -p tsconfig.json",
-        "test": "vitest",
-        "prepublishOnly": "pnpm i && pnpm build",
-        "test:unit": "vitest --project unit",
-        "test:integration": "pnpm --filter @ogcio/o11y run prepare:integration && vitest --project integration",
-        "test:integration:dryrun": "vitest --project integration"
-    },
-    "exports": {
-        ".": "./dist/index.js",
-        "./*": "./dist/*.js"
-    },
-    "keywords": [
-        "observability",
-        "o11y",
-        "opentelemetry",
-        "node",
-        "nodejs",
-        "ogcio"
-    ],
-    "author": "team:ogcio/observability",
-    "license": "ISC",
-    "dependencies": {
-        "@grpc/grpc-js": "^1.13.4",
-        "@opentelemetry/api": "^1.9.0",
-        "@opentelemetry/api-logs": "^0.203.0",
-        "@opentelemetry/auto-instrumentations-node": "^0.62.1",
-        "@opentelemetry/core": "^2.0.1",
-        "@opentelemetry/exporter-logs-otlp-grpc": "^0.203.0",
-        "@opentelemetry/exporter-logs-otlp-http": "^0.203.0",
-        "@opentelemetry/exporter-metrics-otlp-grpc": "^0.203.0",
-        "@opentelemetry/exporter-metrics-otlp-http": "^0.203.0",
-        "@opentelemetry/exporter-trace-otlp-grpc": "^0.203.0",
-        "@opentelemetry/exporter-trace-otlp-http": "^0.203.0",
-        "@opentelemetry/instrumentation": "^0.203.0",
-        "@opentelemetry/otlp-exporter-base": "^0.203.0",
-        "@opentelemetry/resources": "^2.0.1",
-        "@opentelemetry/sdk-logs": "^0.203.0",
-        "@opentelemetry/sdk-metrics": "^2.0.1",
-        "@opentelemetry/sdk-node": "^0.203.0",
-        "@opentelemetry/sdk-trace-base": "^2.0.1"
-    },
-    "devDependencies": {
-        "@types/node": "^24.3.0",
-        "@vitest/coverage-v8": "^3.2.4",
-        "tsx": "^4.20.5",
-        "typescript": "^5.8.3",
-        "vitest": "^3.2.4"
-    },
-    "engines": {
-        "node": ">=20.6.0"
-    }
-}

package/dist/vitest.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;

package/dist/vitest.config.js

@@ -1,45 +0,0 @@
-import { defineConfig } from "vitest/config";
-export default defineConfig({
-    test: {
-        globals: true,
-        watch: false,
-        exclude: ["**/fixtures/**", "**/dist/**"],
-        poolOptions: {
-            threads: {
-                maxThreads: 8,
-            },
-        },
-        clearMocks: true,
-        testTimeout: 30_000,
-        coverage: {
-            enabled: true,
-            provider: "v8",
-            reportsDirectory: "coverage",
-            reporter: ["lcov", "cobertura"],
-            clean: true,
-        },
-        reporters: ["default", ["junit", { outputFile: "test-report.xml" }]],
-        environment: "node",
-        pool: "threads",
-        projects: [
-            {
-                test: {
-                    include: [
-                        "**/test/*.test.ts",
-                        "**/test/processor/**/*.test.ts",
-                        "**/test/traces/**/*.test.ts",
-                        "**/test/internals/**/*.test.ts",
-                        "**/test/exporter/**/*.test.ts",
-                    ],
-                    name: "unit",
-                },
-            },
-            {
-                test: {
-                    include: ["**/test/integration/**/*.test.ts"],
-                    name: "integration",
-                },
-            },
-        ],
-    },
-});

package/index.ts

@@ -1,9 +0,0 @@
-import type { NodeSDK } from "@opentelemetry/sdk-node";
-import buildNodeInstrumentation from "./lib/instrumentation.node.js";
-
-export type * from "./lib/index.js";
-export type { NodeSDK };
-export { buildNodeInstrumentation as instrumentNode };
-
-export * from "./lib/metrics.js";
-export * from "./lib/traces.js";

package/lib/config-manager.ts

@@ -1,12 +0,0 @@
-import { NodeSDKConfig } from "./index.js";
-
-let nodeSDKConfig: NodeSDKConfig;
-
-export const setNodeSdkConfig = (config: NodeSDKConfig) => {
-  nodeSDKConfig = config;
-};
-
-export const getNodeSdkConfig = (): NodeSDKConfig | undefined => {
-  // Ensure getters do not edit config.
-  return nodeSDKConfig ? JSON.parse(JSON.stringify(nodeSDKConfig)) : undefined;
-};

package/lib/exporter/console.ts

@@ -1,33 +0,0 @@
-import {
-  ConsoleLogRecordExporter,
-  SimpleLogRecordProcessor,
-} from "@opentelemetry/sdk-logs";
-import { metrics } from "@opentelemetry/sdk-node";
-import {
-  ConsoleSpanExporter,
-  SimpleSpanProcessor,
-} from "@opentelemetry/sdk-trace-base";
-import { NodeSDKConfig } from "../index.js";
-import {
-  _logsProcessorConfig,
-  _spansProcessorConfig,
-} from "./processor-config.js";
-import { Exporters } from "./index.js";
-
-export default function buildConsoleExporters(
-  config: NodeSDKConfig,
-): Exporters {
-  return {
-    spans: [
-      new SimpleSpanProcessor(new ConsoleSpanExporter()),
-      ..._spansProcessorConfig(config),
-    ],
-    metrics: new metrics.PeriodicExportingMetricReader({
-      exporter: new metrics.ConsoleMetricExporter(),
-    }),
-    logs: [
-      ..._logsProcessorConfig(config),
-      new SimpleLogRecordProcessor(new ConsoleLogRecordExporter()),
-    ],
-  };
-}

package/lib/exporter/grpc.ts

@@ -1,65 +0,0 @@
-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 { NodeSDKConfig } from "../index.js";
-import { LogRecordProcessorMap, SpanProcessorMap } from "../utils.js";
-import {
-  _logsProcessorConfig,
-  _spansProcessorConfig,
-} from "./processor-config.js";
-import { Exporters } from "./index.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({
-    waitForReady: true,
-  });
-}
-
-export default async function buildGrpcExporters(
-  config: NodeSDKConfig,
-): Promise<Exporters> {
-  return {
-    spans: [
-      new SpanProcessorMap[config.collectorMode ?? "batch"](
-        new PIIExporterDecorator(
-          new OTLPTraceExporter({
-            url: `${config.collectorUrl}`,
-            compression: CompressionAlgorithm.GZIP,
-            metadata: config.grpcMetadata ?? (await defaultMetadata()),
-          }),
-          getNodeSdkConfig(),
-        ),
-      ),
-      ..._spansProcessorConfig(config),
-    ],
-    metrics: new metrics.PeriodicExportingMetricReader({
-      exporter: new PIIExporterDecorator(
-        new OTLPMetricExporter({
-          url: `${config.collectorUrl}`,
-          compression: CompressionAlgorithm.GZIP,
-          metadata: config.grpcMetadata ?? (await defaultMetadata()),
-        }),
-        getNodeSdkConfig(),
-      ),
-    }),
-    logs: [
-      ..._logsProcessorConfig(config),
-      new LogRecordProcessorMap[config.collectorMode ?? "batch"](
-        new PIIExporterDecorator(
-          new OTLPLogExporter({
-            url: `${config.collectorUrl}`,
-            compression: CompressionAlgorithm.GZIP,
-            metadata: config.grpcMetadata ?? (await defaultMetadata()),
-          }),
-          getNodeSdkConfig(),
-        ),
-      ),
-    ],
-  };
-}

package/lib/exporter/http.ts

@@ -1,56 +0,0 @@
-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 { NodeSDKConfig } from "../index.js";
-import { LogRecordProcessorMap, SpanProcessorMap } from "../utils.js";
-import {
-  _logsProcessorConfig,
-  _spansProcessorConfig,
-} from "./processor-config.js";
-import { Exporters } from "./index.js";
-import { getNodeSdkConfig } from "../config-manager.js";
-import { PIIExporterDecorator } from "./pii-exporter-decorator.js";
-
-export default function buildHttpExporters(config: NodeSDKConfig): Exporters {
-  if (config.collectorUrl.endsWith("/")) {
-    config.collectorUrl = config.collectorUrl.slice(0, -1);
-  }
-
-  return {
-    spans: [
-      new SpanProcessorMap[config.collectorMode ?? "batch"](
-        new PIIExporterDecorator(
-          new OTLPTraceExporter({
-            url: `${config.collectorUrl}/v1/traces`,
-            compression: CompressionAlgorithm.GZIP,
-          }),
-          getNodeSdkConfig(),
-        ),
-      ),
-      ..._spansProcessorConfig(config),
-    ],
-    metrics: new metrics.PeriodicExportingMetricReader({
-      exporter: new PIIExporterDecorator(
-        new OTLPMetricExporter({
-          url: `${config.collectorUrl}/v1/metrics`,
-          compression: CompressionAlgorithm.GZIP,
-        }),
-        getNodeSdkConfig(),
-      ),
-    }),
-    logs: [
-      ..._logsProcessorConfig(config),
-      new LogRecordProcessorMap[config.collectorMode ?? "batch"](
-        new PIIExporterDecorator(
-          new OTLPLogExporter({
-            url: `${config.collectorUrl}/v1/logs`,
-            compression: CompressionAlgorithm.GZIP,
-          }),
-          getNodeSdkConfig(),
-        ),
-      ),
-    ],
-  };
-}

package/lib/exporter/index.ts

@@ -1,9 +0,0 @@
-import { LogRecordProcessor } from "@opentelemetry/sdk-logs";
-import type { metrics } from "@opentelemetry/sdk-node";
-import { SpanProcessor } from "@opentelemetry/sdk-trace-base";
-
-export type Exporters = {
-  spans: SpanProcessor[];
-  metrics: metrics.MetricReader;
-  logs: LogRecordProcessor[];
-};

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

@@ -1,187 +0,0 @@
-import { ExportResult } from "@opentelemetry/core";
-import { OTLPExporterBase } from "@opentelemetry/otlp-exporter-base";
-import { ReadableLogRecord } from "@opentelemetry/sdk-logs";
-import {
-  PushMetricExporter,
-  ResourceMetrics,
-} from "@opentelemetry/sdk-metrics";
-import { ReadableSpan, SpanExporter } from "@opentelemetry/sdk-trace-base";
-import { NodeSDKConfig } from "../index.js";
-import {
-  _cleanStringPII,
-  _recursiveObjectClean,
-} from "../internals/redaction/pii-detection.js";
-import {
-  Redactor,
-  RedactorKeys,
-  redactors,
-} from "../internals/redaction/redactors/index.js";
-
-export class PIIExporterDecorator
-  extends OTLPExporterBase<
-    (ReadableSpan | ReadableLogRecord)[] | ResourceMetrics
-  >
-  implements SpanExporter, PushMetricExporter
-{
-  private readonly _exporter;
-  private readonly _config;
-  private readonly _redactors;
-
-  constructor(
-    exporter: OTLPExporterBase<
-      (ReadableSpan | ReadableLogRecord)[] | ResourceMetrics
-    >,
-    config: NodeSDKConfig | undefined,
-  ) {
-    super(exporter["_delegate"]);
-    this._exporter = exporter;
-    this._config = config;
-    this._redactors = this._buildRedactors(config?.detection);
-  }
-
-  forceFlush(): Promise<void> {
-    return this._exporter.forceFlush();
-  }
-
-  shutdown(): Promise<void> {
-    return this._exporter.shutdown();
-  }
-
-  export(
-    items: (ReadableSpan | ReadableLogRecord)[] | ResourceMetrics,
-    resultCallback: (result: ExportResult) => void,
-  ): void {
-    if (this._redactors.length === 0) {
-      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)) {
-          item = this._redactLogRecord(item);
-        }
-        return item;
-      });
-
-      this._exporter.export(redactedItem, resultCallback);
-      return;
-    }
-
-    if (this._isResourceMetrics(items)) {
-      this._redactResourceMetrics(items);
-      this._exporter.export(items, resultCallback);
-    }
-  }
-
-  private _isReadableSpan(span: unknown): span is ReadableSpan {
-    return (
-      typeof span === "object" &&
-      span !== null &&
-      "name" in span &&
-      "kind" in span &&
-      "spanContext" in span &&
-      "attributes" in span
-    );
-  }
-
-  private _isReadableLogRecord(span: unknown): span is ReadableLogRecord {
-    return (
-      typeof span === "object" &&
-      span !== null &&
-      "body" in span &&
-      "attributes" in span &&
-      "severityText" in span &&
-      "severityNumber" in span
-    );
-  }
-
-  private _isResourceMetrics(obj: unknown): obj is ResourceMetrics {
-    return (
-      typeof obj === "object" &&
-      obj !== null &&
-      !Array.isArray(obj) &&
-      "resource" in obj &&
-      "scopeMetrics" in obj
-    );
-  }
-
-  private _redactSpan(span: ReadableSpan): void {
-    Object.assign(span, {
-      name: _cleanStringPII(span.name, "trace", this._redactors),
-      attributes:
-        span.attributes &&
-        _recursiveObjectClean(span.attributes, "trace", this._redactors),
-      resource: {
-        attributes:
-          span?.resource?.attributes &&
-          _recursiveObjectClean(
-            span.resource.attributes,
-            "trace",
-            this._redactors,
-          ),
-      },
-      links: span?.links?.map((link) => {
-        Object.assign(link, {
-          attributes:
-            link?.attributes &&
-            _recursiveObjectClean(link.attributes, "trace", this._redactors),
-        });
-      }),
-      events: span?.events?.map((event) => {
-        Object.assign(event, {
-          name: _cleanStringPII(event.name, "trace", this._redactors),
-          attributes:
-            event?.attributes &&
-            _recursiveObjectClean(event.attributes, "trace", this._redactors),
-        });
-        return event;
-      }),
-    });
-  }
-
-  private _redactLogRecord(log: ReadableLogRecord): ReadableLogRecord {
-    return {
-      ...log,
-      body: _recursiveObjectClean(log.body, "log", this._redactors),
-      attributes:
-        log.attributes &&
-        _recursiveObjectClean(log.attributes, "log", this._redactors),
-      resource: log.resource && {
-        ...log.resource,
-        attributes: _recursiveObjectClean(
-          log.resource.attributes,
-          "log",
-          this._redactors,
-        ),
-      },
-    };
-  }
-
-  private _redactResourceMetrics(metric: ResourceMetrics): void {
-    Object.assign(metric, {
-      resource: {
-        attributes:
-          metric?.resource?.attributes &&
-          _recursiveObjectClean(
-            metric.resource.attributes,
-            "metric",
-            this._redactors,
-          ),
-      },
-    });
-  }
-
-  // Default opt-in every redactor available, excluding only those explicitly configured to false
-  private _buildRedactors(
-    redactorsConfig: NodeSDKConfig["detection"] = {},
-  ): Redactor[] {
-    return Object.entries(redactors)
-      .filter(([key]) => {
-        return redactorsConfig[key as RedactorKeys] !== false;
-      })
-      .map(([_, value]) => value);
-  }
-}

package/lib/exporter/processor-config.ts

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