@ogcio/o11y-sdk-react 0.1.0-beta.2 → 0.1.0-beta.3

package/dist/lib/index.d.ts

@@ -0,0 +1,39 @@
+interface SDKConfig {
+    /**
+     * The opentelemetry collector entrypoint GRPC url.
+     * If the collectoUrl 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
+     */
+    serviceName?: string;
+    /**
+     * Diagnostic log level for the internal runtime instrumentation
+     *
+     * @type string
+     * @default INFO
+     */
+    diagLogLevel?: SDKLogLevel;
+    /**
+     * Collector signals processing mode.
+     * signle: 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
+     * @default batch
+     */
+    collectorMode?: SDKCollectorMode;
+}
+export interface FaroSDKConfig extends SDKConfig {
+    /**
+     * String with single or multiple URLs separated by comma used by the instrumentation to ignore CORS errors and send signals through it
+     * @example http://localhost:9000,http://localhost:8000
+     * @example http://localhost:9000
+     */
+    corsTraceHeaders?: string;
+}
+export type SDKCollectorMode = "single" | "batch";
+export type SDKLogLevel = "NONE" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "VERBOSE" | "ALL";
+export {};

package/dist/lib/index.js

@@ -0,0 +1 @@
+export {};

package/dist/lib/instrumentation.faro.d.ts

@@ -0,0 +1,3 @@
+import type { FaroSDKConfig } from "./index.js";
+import { type Faro } from "@grafana/faro-react";
+export default function buildFaroInstrumentation(config?: FaroSDKConfig): Faro | undefined;

package/dist/lib/instrumentation.faro.js

@@ -0,0 +1,61 @@
+import { ErrorsInstrumentation, getWebInstrumentations, initializeFaro, WebVitalsInstrumentation, } from "@grafana/faro-react";
+import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
+import { W3CTraceContextPropagator } from "@opentelemetry/core";
+import isUrl from "is-url";
+import { FetchInstrumentation } from "@opentelemetry/instrumentation-fetch";
+import { UserInteractionInstrumentation } from "@opentelemetry/instrumentation-user-interaction";
+import { DocumentLoadInstrumentation } from "@opentelemetry/instrumentation-document-load";
+import { TracingInstrumentation } from "@grafana/faro-web-tracing";
+export default function buildFaroInstrumentation(config) {
+    if (!config) {
+        console.warn("observability config not set. Skipping Faro OpenTelemetry instrumentation.");
+        return;
+    }
+    if (!config.collectorUrl) {
+        console.warn("collectorUrl not set. Skipping Faro OpenTelemetry instrumentation.");
+        return;
+    }
+    if (!isUrl(config.collectorUrl)) {
+        console.error("collectorUrl does not use a valid format. Skipping Faro OpenTelemetry instrumentation.");
+        return;
+    }
+    try {
+        diag.setLogger(new DiagConsoleLogger(), config.diagLogLevel
+            ? DiagLogLevel[config.diagLogLevel]
+            : DiagLogLevel.INFO);
+        const faro = initializeFaro({
+            url: config.collectorUrl,
+            app: {
+                name: config.serviceName,
+            },
+            batching: {
+                enabled: !(config.collectorMode === "single"),
+            },
+            instrumentations: [
+                ...getWebInstrumentations({
+                    captureConsole: true,
+                }),
+                new ErrorsInstrumentation(),
+                new WebVitalsInstrumentation(),
+                new TracingInstrumentation({
+                    propagator: new W3CTraceContextPropagator(),
+                    instrumentations: [
+                        new DocumentLoadInstrumentation(),
+                        new FetchInstrumentation({
+                            ignoreUrls: [config.collectorUrl], // ignore collector to avoid fetch loop
+                            propagateTraceHeaderCorsUrls: config.corsTraceHeaders
+                                ? config.corsTraceHeaders.split(",").map((s) => new RegExp(s))
+                                : undefined,
+                        }),
+                        new UserInteractionInstrumentation(),
+                    ],
+                }),
+            ],
+        });
+        console.log("Faro OpenTelemetry instrumentation started successfully.");
+        return faro;
+    }
+    catch (error) {
+        console.error("Error starting Faro OpenTelemetry instrumentation:", error);
+    }
+}

package/dist/vitest.config.d.ts

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

package/dist/vitest.config.js

@@ -0,0 +1,25 @@
+import { defineConfig } from "vitest/config";
+export default defineConfig({
+    test: {
+        globals: true,
+        watch: false,
+        include: ["**/test/*.test.ts"],
+        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",
+    },
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ogcio/o11y-sdk-react",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.3",
   "description": "Opentelemetry standard instrumentation SDK for React based project",
   "main": "dist/index.js",
   "type": "module",

package/test-report.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<testsuites name="vitest tests" tests="5" failures="0" errors="0" time="0.015040706">
+    <testsuite name="test/index.test.ts" timestamp="2025-01-28T15:51:41.666Z" hostname="fv-az633-589" tests="2" failures="0" errors="0" skipped="0" time="0.006099583">
+        <testcase classname="test/index.test.ts" name="instrumentFaro &gt; should call buildFaroInstrumentation with the provided config" time="0.003494948">
+        </testcase>
+        <testcase classname="test/index.test.ts" name="instrumentFaro &gt; should not throw when called without arguments" time="0.001179316">
+        </testcase>
+    </testsuite>
+    <testsuite name="test/validation.test.ts" timestamp="2025-01-28T15:51:41.667Z" hostname="fv-az633-589" tests="3" failures="0" errors="0" skipped="0" time="0.008941123">
+        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; should call buildFaroInstrumentation without config and skip instrumentation" time="0.004579762">
+        </testcase>
+        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; faro instrumentation: url undefined" time="0.001722924">
+        </testcase>
+        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; faro instrumentation: invalid url" time="0.000789311">
+        </testcase>
+    </testsuite>
+</testsuites>