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

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/vitest.config.ts

@@ -4,7 +4,6 @@ export default defineConfig({
   test: {
     globals: true,
     watch: false,
-    include: ["**/test/*.test.ts", "**/test/integration/*.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",
+        },
+      },
+    ],
   },
 });

package/dist/lib/console.d.ts

@@ -1,3 +0,0 @@
-import type { NodeSDKConfig } from "./index.js";
-import type { Exporters } from "./options.js";
-export default function buildConsoleExporters(_: NodeSDKConfig): Exporters;

package/dist/lib/console.js

@@ -1,12 +0,0 @@
-import { logs, metrics, tracing } from "@opentelemetry/sdk-node";
-export default function buildConsoleExporters(_) {
-    return {
-        traces: new tracing.ConsoleSpanExporter(),
-        metrics: new metrics.PeriodicExportingMetricReader({
-            exporter: new metrics.ConsoleMetricExporter(),
-        }),
-        logs: [
-            new logs.SimpleLogRecordProcessor(new logs.ConsoleLogRecordExporter()),
-        ],
-    };
-}

package/dist/lib/grpc.d.ts

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

package/dist/lib/http.d.ts

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

package/lib/console.ts

@@ -1,15 +0,0 @@
-import type { NodeSDKConfig } from "./index.js";
-import type { Exporters } from "./options.js";
-import { logs, metrics, tracing } from "@opentelemetry/sdk-node";
-
-export default function buildConsoleExporters(_: NodeSDKConfig): Exporters {
-  return {
-    traces: new tracing.ConsoleSpanExporter(),
-    metrics: new metrics.PeriodicExportingMetricReader({
-      exporter: new metrics.ConsoleMetricExporter(),
-    }),
-    logs: [
-      new logs.SimpleLogRecordProcessor(new logs.ConsoleLogRecordExporter()),
-    ],
-  };
-}