@ogcio/o11y-sdk-node 0.1.0-beta.4 → 0.1.0-beta.7

package/test/integration/run.sh

@@ -0,0 +1,85 @@
+BUILD_ID=$1
+ROOT_PATH=$2
+
+NETWORK_NAME="${BUILD_ID}_testnetwork"
+ALLOY_CONTAINER_NAME="integrationalloy"
+NODE_CONTAINER_NAME="${BUILD_ID}_fastify_app"
+ERROR_CODE=0
+
+docker build -t ${NODE_CONTAINER_NAME}:${BUILD_ID} -f $ROOT_PATH/examples/fastify/Dockerfile $ROOT_PATH/
+
+docker network create $NETWORK_NAME
+
+docker run -d \
+    -v "$ROOT_PATH/alloy/integration-test.alloy:/etc/alloy/config.alloy:ro" \
+    --network $NETWORK_NAME \
+    --name $ALLOY_CONTAINER_NAME \
+    -p 4317:4317 \
+    -p 4318:4318 \
+    grafana/alloy \
+    run --server.http.listen-addr=0.0.0.0:12345 --stability.level=experimental /etc/alloy/config.alloy
+
+MAX_RETRIES=10
+COUNTER=0
+echo "$ALLOY_CONTAINER_NAME container status"
+until [ "$(docker inspect -f {{.State.Running}} $ALLOY_CONTAINER_NAME)" = true ]; do
+    sleep 2
+    docker inspect -f {{.State.Running}} $ALLOY_CONTAINER_NAME
+    COUNTER=$((COUNTER + 1))
+    if [ $COUNTER -ge $MAX_RETRIES ]; then
+        echo "Exceeded maximum retries. Exiting."
+        ERROR_CODE=1
+        break
+    fi
+done
+
+if [[ $ERROR_CODE -eq 0 ]]; then
+    docker run --detach \
+        --network $NETWORK_NAME \
+        --name $NODE_CONTAINER_NAME \
+        --health-cmd="curl -f http://${NODE_CONTAINER_NAME}:9091/api/health > /dev/null || exit 1" \
+        --health-start-period=1s \
+        --health-retries=10 \
+        --health-interval=1s \
+        -p 9091:9091 \
+        ${NODE_CONTAINER_NAME}:${BUILD_ID}
+
+    COUNTER=0
+    echo "$NODE_CONTAINER_NAME container status"
+    until [ "$(docker inspect -f {{.State.Health.Status}} $NODE_CONTAINER_NAME)" = "healthy" ]; do
+        sleep 1
+        docker inspect -f {{.State.Health.Status}} $NODE_CONTAINER_NAME
+        COUNTER=$((COUNTER + 1))
+        if [ $COUNTER -ge $MAX_RETRIES ]; then
+            echo "Exceeded maximum retries. Exiting."
+            ERROR_CODE=1
+            break
+        fi
+    done
+fi
+
+if [[ $ERROR_CODE -eq 0 ]]; then
+    sleep 2
+    curl -X GET -f http://localhost:9091/api/dummy -H 'Content-Type: application/json'
+    sleep 2
+    curl -X GET -f http://localhost:9091/api/dummy -H 'Content-Type: application/json'
+fi
+
+# sleep N seconds to await instrumentation flow send and receiving signals
+sleep 10
+
+# Copy logs from container to file
+docker container logs $ALLOY_CONTAINER_NAME >&$ROOT_PATH/packages/sdk-node/test/integration/logs.txt
+echo "log file at $ROOT_PATH/packages/sdk-node/test/integration/logs.txt"
+
+docker container stop $ALLOY_CONTAINER_NAME
+docker container stop $NODE_CONTAINER_NAME
+
+docker container rm -f $ALLOY_CONTAINER_NAME
+docker container rm -f $NODE_CONTAINER_NAME
+
+docker image rm ${NODE_CONTAINER_NAME}:${BUILD_ID}
+
+docker network rm $NETWORK_NAME
+
+exit $ERROR_CODE

package/test/node-config.test.ts

@@ -9,7 +9,17 @@ import { OTLPTraceExporter as HTTP_OTLPTraceExporter } from "@opentelemetry/expo
 import { OTLPMetricExporter as HTTP_OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
 import { OTLPLogExporter as HTTP_OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
 import { NodeSDKConfig } from "../lib/index.js";
-import buildHttpExporters from "../lib/http.js";
+import buildHttpExporters from "../lib/exporter/http.js";
+import {
+  BatchSpanProcessor,
+  ConsoleSpanExporter,
+  SimpleSpanProcessor,
+} from "@opentelemetry/sdk-trace-base";
+import {
+  BatchLogRecordProcessor,
+  SimpleLogRecordProcessor,
+} from "@opentelemetry/sdk-logs";
+import { EnrichSpanProcessor } from "../lib/processor/enrich-span-processor.js";
 
 describe("verify config settings", () => {
   const commonConfig = {
@@ -21,6 +31,7 @@ describe("verify config settings", () => {
     const config: NodeSDKConfig = {
       ...commonConfig,
       protocol: "grpc",
+      collectorMode: "batch",
       diagLogLevel: "NONE",
     };
 
@@ -31,20 +42,21 @@ describe("verify config settings", () => {
     const _configuration = sdk["_configuration"];
     assert.equal(_configuration.serviceName, commonConfig.serviceName);
 
-    const traceExporter = _configuration.traceExporter;
+    const logs = _configuration.logRecordProcessors;
 
-    assert.ok(traceExporter instanceof GRPC_OTLPTraceExporter);
+    assert.equal(logs.length, 1);
+    assert.ok(logs[0] instanceof BatchLogRecordProcessor);
+
+    const spans = _configuration.spanProcessors;
+
+    assert.equal(spans.length, 2);
+    assert.ok(spans[0] instanceof BatchSpanProcessor);
+    assert.ok(spans[1] instanceof EnrichSpanProcessor);
 
-    const logRecordProcessors = _configuration.logRecordProcessors;
-    assert.equal(logRecordProcessors.length, 1);
-    // assert default signals sending mode
-    assert.ok(logRecordProcessors[0] instanceof logs.BatchLogRecordProcessor);
     assert.ok(
-      logRecordProcessors[0]["_exporter"] instanceof GRPC_OTLPLogExporter,
+      _configuration.metricReader instanceof
+        metrics.PeriodicExportingMetricReader,
     );
-
-    const metricReader = _configuration.metricReader;
-    assert.ok(metricReader._exporter instanceof GRPC_OTLPMetricExporter);
   });
 
   test("http config", () => {
@@ -60,19 +72,21 @@ describe("verify config settings", () => {
     const _configuration = sdk["_configuration"];
     assert.equal(_configuration.serviceName, commonConfig.serviceName);
 
-    const traceExporter = _configuration.traceExporter;
-    assert.ok(traceExporter instanceof HTTP_OTLPTraceExporter);
+    const logs = _configuration.logRecordProcessors;
+
+    assert.equal(logs.length, 1);
+    assert.ok(logs[0] instanceof BatchLogRecordProcessor);
+
+    const spans = _configuration.spanProcessors;
+
+    assert.equal(spans.length, 2);
+    assert.ok(spans[0] instanceof BatchSpanProcessor);
+    assert.ok(spans[1] instanceof EnrichSpanProcessor);
 
-    const logRecordProcessors = _configuration.logRecordProcessors;
-    assert.equal(logRecordProcessors.length, 1);
-    // assert default signals sending mode
-    assert.ok(logRecordProcessors[0] instanceof logs.BatchLogRecordProcessor);
     assert.ok(
-      logRecordProcessors[0]["_exporter"] instanceof HTTP_OTLPLogExporter,
+      _configuration.metricReader instanceof
+        metrics.PeriodicExportingMetricReader,
     );
-
-    const metricReader = _configuration.metricReader;
-    assert.ok(metricReader._exporter instanceof HTTP_OTLPMetricExporter);
   });
 
   test("console - console config", () => {
@@ -82,30 +96,29 @@ describe("verify config settings", () => {
       diagLogLevel: "NONE",
     };
 
-    const sdk: NodeSDK | undefined = buildNodeInstrumentation(config);
+    const sdk: NodeSDK = buildNodeInstrumentation(config)!;
     assert.ok(sdk);
 
     const _configuration = sdk["_configuration"];
     assert.equal(_configuration.serviceName, commonConfig.serviceName);
 
-    const traceExporter = _configuration.traceExporter;
+    const logs = _configuration.logRecordProcessors;
 
-    assert.ok(traceExporter instanceof tracing.ConsoleSpanExporter);
-    assert.isUndefined(traceExporter._transport);
+    // verify simple log processor for instant console logging
+    assert.equal(logs.length, 1);
+    assert.ok(logs[0] instanceof SimpleLogRecordProcessor);
 
-    const logRecordProcessors = _configuration.logRecordProcessors;
-    assert.equal(logRecordProcessors.length, 1);
+    const spans = _configuration.spanProcessors;
+
+    assert.equal(spans.length, 2);
+    // verify simple span for instant console logging
+    assert.ok(spans[0] instanceof SimpleSpanProcessor);
+    assert.ok(spans[1] instanceof EnrichSpanProcessor);
 
-    assert.ok(logRecordProcessors[0] instanceof logs.SimpleLogRecordProcessor);
     assert.ok(
-      logRecordProcessors[0]["_exporter"] instanceof
-        logs.ConsoleLogRecordExporter,
+      _configuration.metricReader instanceof
+        metrics.PeriodicExportingMetricReader,
     );
-    assert.isUndefined(logRecordProcessors[0]["_exporter"]._transport);
-
-    const metricReader = _configuration.metricReader;
-    assert.ok(metricReader._exporter instanceof metrics.ConsoleMetricExporter);
-    assert.isUndefined(metricReader._exporter._transport);
   });
 
   test("single log sending config", () => {
@@ -124,7 +137,7 @@ describe("verify config settings", () => {
 
     const logRecordProcessors = _configuration.logRecordProcessors;
     assert.equal(logRecordProcessors.length, 1);
-    assert.ok(logRecordProcessors[0] instanceof logs.SimpleLogRecordProcessor);
+    assert.ok(logRecordProcessors[0] instanceof SimpleLogRecordProcessor);
   });
 
   test("check if clear base endpoint final slash", () => {

package/test/url-sampler.test.ts

@@ -0,0 +1,215 @@
+import { Context } from "@opentelemetry/api";
+import {
+  SamplingDecision,
+  SamplingResult,
+} from "@opentelemetry/sdk-trace-base";
+import { describe, expect, test, vi } from "vitest";
+import { UrlSampler } from "../lib/url-sampler";
+
+describe("url sampler", () => {
+  // mock sampler to be sure every trace after UrlSamper has RECORD status
+  const mockSampler = {
+    shouldSample: vi
+      .fn()
+      .mockImplementation(
+        (_context, _traceId, _spanName, _spanKind, attributes, _links) => {
+          return {
+            decision: SamplingDecision.RECORD,
+            attributes: attributes,
+          } as SamplingResult;
+        },
+      ),
+  };
+
+  test("should add custom span attributes to trace", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/health",
+        },
+      ],
+      mockSampler,
+      {
+        "signal.namespace": "unittest",
+        "signal.callback.result": () => "test",
+      },
+    );
+
+    expect(sampler).not.toBeNull();
+
+    const result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/track" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+    expect(result.attributes).not.toBeNull();
+  });
+
+  test("should not record trace about /health api", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/health",
+        },
+      ],
+      mockSampler,
+    );
+
+    const result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/health" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+
+  test("should record every other trace which is not /health api", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/health",
+        },
+      ],
+      mockSampler,
+    );
+
+    let result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/test" },
+      [],
+    );
+
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+
+    result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/another/url" },
+      [],
+    );
+
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+  });
+
+  test("operator 'includes', should not record every trace which include /block in url", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "includes",
+          url: "/block",
+        },
+      ],
+      mockSampler,
+    );
+
+    expect(sampler).not.toBeNull();
+
+    const result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/block/example/12" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+
+  test("operator 'endsWith', should not record only trace which ends with /block in url", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "endsWith",
+          url: "/block",
+        },
+      ],
+      mockSampler,
+    );
+
+    expect(sampler).not.toBeNull();
+
+    // expect traced with block in the URL middle
+    let result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/block/example/12" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+
+    // should stop trace with block at the end
+    result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/example/block" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+
+  test("operator 'equals', should not record trace which is equal to /block in url", async () => {
+    const sampler: UrlSampler = new UrlSampler(
+      [
+        {
+          type: "equals",
+          url: "/block",
+        },
+      ],
+      mockSampler,
+    );
+
+    expect(sampler).not.toBeNull();
+
+    let result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/namespace/block/example/12" },
+      [],
+    );
+
+    expect(sampler.toString()).toBe("UrlSampler");
+    expect(result.decision).toBe(SamplingDecision.RECORD);
+
+    result = sampler.shouldSample(
+      {} as Context,
+      "traceId",
+      "span",
+      0,
+      { "http.target": "/block" },
+      [],
+    );
+
+    expect(result.decision).toBe(SamplingDecision.NOT_RECORD);
+  });
+});

package/test/utils/alloy-log-parser.ts

@@ -0,0 +1,46 @@
+export function parseLog(
+  log: string,
+): Record<string, object | string | number> {
+  const logArray = log
+    .split("\\n")
+    .map((line) => line.trim())
+    .filter((line) => line);
+
+  const jsonObject: Record<string, object | string | number> = {};
+  let currentSection: Record<string, object | string | number> = jsonObject;
+  const sectionStack: Record<string, object | string | number>[] = [];
+
+  logArray.forEach((line) => {
+    line = line.trim();
+
+    if (line.startsWith("->")) {
+      const match = line.match(/->\s+([^:]+):\s+(Str|Int)\((.+)\)/);
+      if (match) {
+        const [, key, type, value] = match;
+        const parsedValue = type === "Int" ? parseInt(value, 10) : value;
+
+        if (typeof currentSection === "object") {
+          currentSection[key] = parsedValue;
+        }
+      }
+    } else if (line.endsWith(":")) {
+      // new section
+      const sectionName = line
+        .slice(0, -1)
+        .trim()
+        .toLowerCase()
+        .replace(" ", "_");
+      jsonObject[sectionName] = {};
+      currentSection = jsonObject[sectionName] as Record<
+        string,
+        object | string | number
+      >;
+      sectionStack.push(currentSection);
+    } else if (line.startsWith('"')) {
+      // Additional metadata at the end, store it separately
+      jsonObject["metadata"] = line;
+    }
+  });
+
+  return jsonObject;
+}

package/vitest.config.ts

@@ -4,7 +4,6 @@ export default defineConfig({
   test: {
     globals: true,
     watch: false,
-    include: ["**/test/*.test.ts"],
     exclude: ["**/fixtures/**", "**/dist/**"],
     poolOptions: {
       threads: {
@@ -22,5 +21,20 @@ export default defineConfig({
     },
     reporters: ["default", ["junit", { outputFile: "test-report.xml" }]],
     environment: "node",
+    pool: "threads",
+    workspace: [
+      {
+        test: {
+          include: ["**/test/*.test.ts"],
+          name: "unit",
+        },
+      },
+      {
+        test: {
+          include: ["**/test/integration/*.test.ts"],
+          name: "integration",
+        },
+      },
+    ],
   },
 });