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

package/coverage/lcov-report/sorter.js

@@ -1,196 +0,0 @@
-/* eslint-disable */
-var addSorting = (function() {
-    'use strict';
-    var cols,
-        currentSort = {
-            index: 0,
-            desc: false
-        };
-
-    // returns the summary table element
-    function getTable() {
-        return document.querySelector('.coverage-summary');
-    }
-    // returns the thead element of the summary table
-    function getTableHeader() {
-        return getTable().querySelector('thead tr');
-    }
-    // returns the tbody element of the summary table
-    function getTableBody() {
-        return getTable().querySelector('tbody');
-    }
-    // returns the th element for nth column
-    function getNthColumn(n) {
-        return getTableHeader().querySelectorAll('th')[n];
-    }
-
-    function onFilterInput() {
-        const searchValue = document.getElementById('fileSearch').value;
-        const rows = document.getElementsByTagName('tbody')[0].children;
-        for (let i = 0; i < rows.length; i++) {
-            const row = rows[i];
-            if (
-                row.textContent
-                    .toLowerCase()
-                    .includes(searchValue.toLowerCase())
-            ) {
-                row.style.display = '';
-            } else {
-                row.style.display = 'none';
-            }
-        }
-    }
-
-    // loads the search box
-    function addSearchBox() {
-        var template = document.getElementById('filterTemplate');
-        var templateClone = template.content.cloneNode(true);
-        templateClone.getElementById('fileSearch').oninput = onFilterInput;
-        template.parentElement.appendChild(templateClone);
-    }
-
-    // loads all columns
-    function loadColumns() {
-        var colNodes = getTableHeader().querySelectorAll('th'),
-            colNode,
-            cols = [],
-            col,
-            i;
-
-        for (i = 0; i < colNodes.length; i += 1) {
-            colNode = colNodes[i];
-            col = {
-                key: colNode.getAttribute('data-col'),
-                sortable: !colNode.getAttribute('data-nosort'),
-                type: colNode.getAttribute('data-type') || 'string'
-            };
-            cols.push(col);
-            if (col.sortable) {
-                col.defaultDescSort = col.type === 'number';
-                colNode.innerHTML =
-                    colNode.innerHTML + '<span class="sorter"></span>';
-            }
-        }
-        return cols;
-    }
-    // attaches a data attribute to every tr element with an object
-    // of data values keyed by column name
-    function loadRowData(tableRow) {
-        var tableCols = tableRow.querySelectorAll('td'),
-            colNode,
-            col,
-            data = {},
-            i,
-            val;
-        for (i = 0; i < tableCols.length; i += 1) {
-            colNode = tableCols[i];
-            col = cols[i];
-            val = colNode.getAttribute('data-value');
-            if (col.type === 'number') {
-                val = Number(val);
-            }
-            data[col.key] = val;
-        }
-        return data;
-    }
-    // loads all row data
-    function loadData() {
-        var rows = getTableBody().querySelectorAll('tr'),
-            i;
-
-        for (i = 0; i < rows.length; i += 1) {
-            rows[i].data = loadRowData(rows[i]);
-        }
-    }
-    // sorts the table using the data for the ith column
-    function sortByIndex(index, desc) {
-        var key = cols[index].key,
-            sorter = function(a, b) {
-                a = a.data[key];
-                b = b.data[key];
-                return a < b ? -1 : a > b ? 1 : 0;
-            },
-            finalSorter = sorter,
-            tableBody = document.querySelector('.coverage-summary tbody'),
-            rowNodes = tableBody.querySelectorAll('tr'),
-            rows = [],
-            i;
-
-        if (desc) {
-            finalSorter = function(a, b) {
-                return -1 * sorter(a, b);
-            };
-        }
-
-        for (i = 0; i < rowNodes.length; i += 1) {
-            rows.push(rowNodes[i]);
-            tableBody.removeChild(rowNodes[i]);
-        }
-
-        rows.sort(finalSorter);
-
-        for (i = 0; i < rows.length; i += 1) {
-            tableBody.appendChild(rows[i]);
-        }
-    }
-    // removes sort indicators for current column being sorted
-    function removeSortIndicators() {
-        var col = getNthColumn(currentSort.index),
-            cls = col.className;
-
-        cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
-        col.className = cls;
-    }
-    // adds sort indicators for current column being sorted
-    function addSortIndicators() {
-        getNthColumn(currentSort.index).className += currentSort.desc
-            ? ' sorted-desc'
-            : ' sorted';
-    }
-    // adds event listeners for all sorter widgets
-    function enableUI() {
-        var i,
-            el,
-            ithSorter = function ithSorter(i) {
-                var col = cols[i];
-
-                return function() {
-                    var desc = col.defaultDescSort;
-
-                    if (currentSort.index === i) {
-                        desc = !currentSort.desc;
-                    }
-                    sortByIndex(i, desc);
-                    removeSortIndicators();
-                    currentSort.index = i;
-                    currentSort.desc = desc;
-                    addSortIndicators();
-                };
-            };
-        for (i = 0; i < cols.length; i += 1) {
-            if (cols[i].sortable) {
-                // add the click event handler on the th so users
-                // dont have to click on those tiny arrows
-                el = getNthColumn(i).querySelector('.sorter').parentElement;
-                if (el.addEventListener) {
-                    el.addEventListener('click', ithSorter(i));
-                } else {
-                    el.attachEvent('onclick', ithSorter(i));
-                }
-            }
-        }
-    }
-    // adds sorting functionality to the UI
-    return function() {
-        if (!getTable()) {
-            return;
-        }
-        cols = loadColumns();
-        loadData();
-        addSearchBox();
-        addSortIndicators();
-        enableUI();
-    };
-})();
-
-window.addEventListener('load', addSorting);

package/coverage/lcov.info

@@ -1,206 +0,0 @@
-TN:
-SF:index.ts
-FNF:0
-FNH:0
-DA:1,1
-LF:1
-LH:1
-BRF:0
-BRH:0
-end_of_record
-TN:
-SF:lib/grpc.ts
-FN:10,buildGrpcExporters
-FNF:1
-FNH:1
-FNDA:2,buildGrpcExporters
-DA:1,1
-DA:10,2
-DA:11,2
-DA:12,2
-DA:13,2
-DA:14,2
-DA:15,2
-DA:16,2
-DA:17,2
-DA:18,2
-DA:19,2
-DA:20,2
-DA:21,2
-DA:22,2
-DA:23,2
-DA:24,2
-DA:25,2
-DA:26,2
-DA:27,2
-DA:28,2
-DA:29,2
-DA:30,2
-DA:31,2
-LF:23
-LH:23
-BRDA:10,0,0,2
-BRDA:23,1,0,1
-BRF:2
-BRH:2
-end_of_record
-TN:
-SF:lib/http.ts
-FN:10,buildHttpExporters
-FNF:1
-FNH:1
-FNDA:2,buildHttpExporters
-DA:1,1
-DA:10,2
-DA:11,2
-DA:12,1
-DA:13,1
-DA:15,2
-DA:16,2
-DA:17,2
-DA:18,2
-DA:19,2
-DA:20,2
-DA:21,2
-DA:22,2
-DA:23,2
-DA:24,2
-DA:25,2
-DA:26,2
-DA:27,2
-DA:28,2
-DA:29,2
-DA:30,2
-DA:31,2
-DA:32,2
-DA:33,2
-DA:34,2
-DA:35,2
-LF:26
-LH:26
-BRDA:10,0,0,2
-BRDA:11,1,0,1
-BRF:2
-BRH:2
-end_of_record
-TN:
-SF:lib/index.ts
-FN:1,(empty-report)
-FNF:1
-FNH:1
-FNDA:1,(empty-report)
-LF:0
-LH:0
-BRDA:1,0,0,1
-BRF:1
-BRH:1
-end_of_record
-TN:
-SF:lib/instrumentation.node.ts
-FN:11,buildNodeInstrumentation
-FNF:1
-FNH:1
-FNDA:6,buildNodeInstrumentation
-DA:1,1
-DA:11,6
-DA:12,6
-DA:13,6
-DA:14,6
-DA:15,1
-DA:16,1
-DA:17,1
-DA:18,1
-DA:19,1
-DA:21,6
-DA:22,1
-DA:23,1
-DA:24,1
-DA:25,1
-DA:26,1
-DA:28,4
-DA:29,1
-DA:30,1
-DA:31,1
-DA:32,1
-DA:33,1
-DA:35,3
-DA:37,3
-DA:38,1
-DA:39,3
-DA:40,2
-DA:41,2
-DA:43,3
-DA:44,3
-DA:45,3
-DA:46,3
-DA:47,3
-DA:48,0
-DA:49,6
-DA:51,6
-DA:52,6
-DA:53,6
-DA:54,6
-DA:55,6
-DA:56,6
-DA:57,6
-DA:58,6
-DA:59,6
-DA:60,6
-DA:61,6
-DA:62,6
-DA:63,6
-DA:64,6
-DA:66,6
-DA:67,6
-DA:68,6
-DA:69,6
-DA:70,0
-DA:71,0
-DA:72,0
-DA:73,0
-DA:74,0
-DA:75,6
-LF:59
-LH:53
-BRDA:11,0,0,6
-BRDA:14,1,0,1
-BRDA:19,2,0,5
-BRDA:21,3,0,4
-BRDA:21,4,0,1
-BRDA:28,5,0,1
-BRDA:33,6,0,3
-BRDA:37,7,0,1
-BRDA:39,8,0,2
-BRDA:47,9,0,0
-BRDA:60,10,0,3
-BRDA:69,11,0,0
-BRF:12
-BRH:10
-end_of_record
-TN:
-SF:lib/options.ts
-FN:1,(empty-report)
-FNF:1
-FNH:1
-FNDA:1,(empty-report)
-LF:0
-LH:0
-BRDA:1,0,0,1
-BRF:1
-BRH:1
-end_of_record
-TN:
-SF:lib/utils.ts
-FNF:0
-FNH:0
-DA:1,1
-DA:4,1
-DA:7,1
-DA:8,1
-DA:9,1
-DA:10,1
-LF:6
-LH:6
-BRF:0
-BRH:0
-end_of_record

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,2 +0,0 @@
-import buildNodeInstrumentation from "./lib/instrumentation.node.js";
-export { buildNodeInstrumentation as instrumentNode };

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/grpc.js

@@ -1,26 +0,0 @@
-import { LogRecordProcessorMap } from "./utils.js";
-import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
-import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
-import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
-import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
-export default function buildGrpcExporters(config) {
-    return {
-        traces: new OTLPTraceExporter({
-            url: `${config.collectorUrl}`,
-            compression: CompressionAlgorithm.GZIP,
-        }),
-        metrics: new PeriodicExportingMetricReader({
-            exporter: new OTLPMetricExporter({
-                url: `${config.collectorUrl}`,
-                compression: CompressionAlgorithm.GZIP,
-            }),
-        }),
-        logs: [
-            new LogRecordProcessorMap[config.collectorMode ?? "batch"](new OTLPLogExporter({
-                url: `${config.collectorUrl}`,
-                compression: CompressionAlgorithm.GZIP,
-            })),
-        ],
-    };
-}

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/dist/lib/http.js

@@ -1,29 +0,0 @@
-import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
-import { LogRecordProcessorMap } from "./utils.js";
-import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
-import { PeriodicExportingMetricReader } from "@opentelemetry/sdk-metrics";
-import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
-import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
-export default function buildHttpExporters(config) {
-    if (config.collectorUrl.endsWith("/")) {
-        config.collectorUrl = config.collectorUrl.slice(0, -1);
-    }
-    return {
-        traces: new OTLPTraceExporter({
-            url: `${config.collectorUrl}/v1/traces`,
-            compression: CompressionAlgorithm.GZIP,
-        }),
-        metrics: new PeriodicExportingMetricReader({
-            exporter: new OTLPMetricExporter({
-                url: `${config.collectorUrl}/v1/metrics`,
-                compression: CompressionAlgorithm.GZIP,
-            }),
-        }),
-        logs: [
-            new LogRecordProcessorMap[config.collectorMode ?? "batch"](new OTLPLogExporter({
-                url: `${config.collectorUrl}/v1/logs`,
-                compression: CompressionAlgorithm.GZIP,
-            })),
-        ],
-    };
-}

package/dist/lib/index.d.ts

@@ -1,46 +0,0 @@
-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 NodeSDKConfig extends SDKConfig {
-    /**
-     * Flag to enable or disable the tracing for node:fs module
-     *
-     * @default false disabling `instrumentation-fs` because it bloating the traces
-     */
-    enableFS?: boolean;
-    /**
-     * http based connection protocol used to send signals.
-     *
-     * @default grpc
-     */
-    protocol?: SDKProtocol;
-}
-export type SDKCollectorMode = "single" | "batch";
-export type SDKProtocol = "grpc" | "http";
-export type SDKLogLevel = "NONE" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "VERBOSE" | "ALL";
-export {};

package/dist/lib/index.js

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

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

@@ -1,3 +0,0 @@
-import { NodeSDK } from "@opentelemetry/sdk-node";
-import type { NodeSDKConfig } from "./index.js";
-export default function buildNodeInstrumentation(config?: NodeSDKConfig): NodeSDK | undefined;

package/dist/lib/instrumentation.node.js

@@ -1,53 +0,0 @@
-import { NodeSDK } from "@opentelemetry/sdk-node";
-import isUrl from "is-url";
-import buildHttpExporters from "./http.js";
-import buildGrpcExporters from "./grpc.js";
-import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
-import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
-import { W3CTraceContextPropagator } from "@opentelemetry/core";
-export default function buildNodeInstrumentation(config) {
-    if (!config) {
-        console.warn("observability config not set. Skipping NodeJS OpenTelemetry instrumentation.");
-        return;
-    }
-    if (!config.collectorUrl) {
-        console.warn("collectorUrl not set. Skipping NodeJS OpenTelemetry instrumentation.");
-        return;
-    }
-    if (!isUrl(config.collectorUrl)) {
-        console.error("collectorUrl does not use a valid format. Skipping NodeJS OpenTelemetry instrumentation.");
-        return;
-    }
-    let exporter;
-    if (config.protocol === "http") {
-        exporter = buildHttpExporters(config);
-    }
-    else {
-        exporter = buildGrpcExporters(config);
-    }
-    try {
-        diag.setLogger(new DiagConsoleLogger(), config.diagLogLevel
-            ? DiagLogLevel[config.diagLogLevel]
-            : DiagLogLevel.INFO);
-        const sdk = new NodeSDK({
-            serviceName: config.serviceName,
-            traceExporter: exporter.traces,
-            metricReader: exporter.metrics,
-            logRecordProcessors: exporter.logs,
-            textMapPropagator: new W3CTraceContextPropagator(),
-            instrumentations: [
-                getNodeAutoInstrumentations({
-                    "@opentelemetry/instrumentation-fs": {
-                        enabled: config.enableFS ?? false,
-                    },
-                }),
-            ],
-        });
-        sdk.start();
-        console.log("NodeJS OpenTelemetry instrumentation started successfully.");
-        return sdk;
-    }
-    catch (error) {
-        console.error("Error starting NodeJS OpenTelemetry instrumentation:", error);
-    }
-}

package/dist/lib/options.d.ts

@@ -1,7 +0,0 @@
-import type { MetricReader } from "@opentelemetry/sdk-metrics";
-import type { logs, tracing } from "@opentelemetry/sdk-node";
-export type Exporters = {
-    traces: tracing.SpanExporter;
-    metrics: MetricReader;
-    logs: logs.LogRecordProcessor[];
-};

package/dist/lib/options.js

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

package/dist/lib/utils.d.ts

@@ -1,3 +0,0 @@
-import { SDKCollectorMode } from "./index.js";
-import { logs } from "@opentelemetry/sdk-node";
-export declare const LogRecordProcessorMap: Record<SDKCollectorMode, typeof logs.SimpleLogRecordProcessor | typeof logs.BatchLogRecordProcessor>;

package/dist/lib/utils.js

@@ -1,5 +0,0 @@
-import { logs } from "@opentelemetry/sdk-node";
-export const LogRecordProcessorMap = {
-    single: logs.SimpleLogRecordProcessor,
-    batch: logs.BatchLogRecordProcessor,
-};

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,25 +0,0 @@
-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/test-report.xml

@@ -1,39 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<testsuites name="vitest tests" tests="9" failures="0" errors="0" time="0.781">
-    <testsuite name="test/index.test.ts" timestamp="2024-11-26T09:25:25.586Z" hostname="ABozzelli-ITMAC24" tests="2" failures="0" errors="0" skipped="0" time="0.002388">
-        <testcase classname="test/index.test.ts" name="instrumentNode &gt; should call buildNodeInstrumentation with the provided config" time="0.001363792">
-        </testcase>
-        <testcase classname="test/index.test.ts" name="instrumentNode &gt; should not throw when called without arguments" time="0.000454542">
-        </testcase>
-    </testsuite>
-    <testsuite name="test/node-config.test.ts" timestamp="2024-11-26T09:25:25.587Z" hostname="ABozzelli-ITMAC24" tests="4" failures="0" errors="0" skipped="0" time="0.042719333">
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; grpc config" time="0.017177333">
-            <system-out>
-NodeJS OpenTelemetry instrumentation started successfully.
-
-            </system-out>
-        </testcase>
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; http config" time="0.016206917">
-            <system-out>
-NodeJS OpenTelemetry instrumentation started successfully.
-
-            </system-out>
-        </testcase>
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; single log sending config" time="0.008346875">
-            <system-out>
-NodeJS OpenTelemetry instrumentation started successfully.
-
-            </system-out>
-        </testcase>
-        <testcase classname="test/node-config.test.ts" name="verify config settings &gt; check if clear base endpoint final slash" time="0.000374">
-        </testcase>
-    </testsuite>
-    <testsuite name="test/validation.test.ts" timestamp="2024-11-26T09:25:25.587Z" hostname="ABozzelli-ITMAC24" tests="3" failures="0" errors="0" skipped="0" time="0.003302375">
-        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; should call buildNodeInstrumentation without config and skip instrumentation" time="0.00188275">
-        </testcase>
-        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; node instrumentation: url undefined" time="0.000551875">
-        </testcase>
-        <testcase classname="test/validation.test.ts" name="validation config: should return without breaking the execution &gt; node instrumentation: invalid url" time="0.000253958">
-        </testcase>
-    </testsuite>
-</testsuites>