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

package/coverage/lcov-report/sorter.js

@@ -0,0 +1,196 @@
+/* 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

@@ -0,0 +1,312 @@
+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/console.ts
+FN:5,buildConsoleExporters
+FNF:1
+FNH:1
+FNDA:1,buildConsoleExporters
+DA:1,1
+DA:5,1
+DA:6,1
+DA:7,1
+DA:8,1
+DA:9,1
+DA:10,1
+DA:11,1
+DA:12,1
+DA:13,1
+DA:14,1
+DA:15,1
+LF:12
+LH:12
+BRDA:5,0,0,1
+BRF:1
+BRH:1
+end_of_record
+TN:
+SF:lib/grpc.ts
+FN:10,buildGrpcExporters
+FNF:1
+FNH:1
+FNDA:3,buildGrpcExporters
+DA:1,1
+DA:10,3
+DA:11,3
+DA:12,3
+DA:13,3
+DA:14,3
+DA:15,3
+DA:16,3
+DA:17,3
+DA:18,3
+DA:19,3
+DA:20,3
+DA:21,3
+DA:22,3
+DA:23,3
+DA:24,3
+DA:25,3
+DA:26,3
+DA:27,3
+DA:28,3
+DA:29,3
+DA:30,3
+DA:31,3
+LF:23
+LH:23
+BRDA:10,0,0,3
+BRDA:23,1,0,2
+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:13,buildNodeInstrumentation
+FNF:1
+FNH:1
+FNDA:8,buildNodeInstrumentation
+DA:1,1
+DA:13,8
+DA:14,8
+DA:15,8
+DA:16,8
+DA:17,1
+DA:18,1
+DA:19,1
+DA:20,1
+DA:21,1
+DA:23,8
+DA:24,1
+DA:25,1
+DA:26,1
+DA:27,1
+DA:28,1
+DA:30,8
+DA:31,1
+DA:32,1
+DA:33,1
+DA:34,1
+DA:35,1
+DA:37,5
+DA:39,8
+DA:40,1
+DA:41,8
+DA:42,1
+DA:43,4
+DA:44,3
+DA:45,3
+DA:47,5
+DA:48,5
+DA:49,5
+DA:50,5
+DA:51,4
+DA:52,1
+DA:53,8
+DA:55,8
+DA:56,8
+DA:57,8
+DA:58,8
+DA:59,8
+DA:60,8
+DA:61,8
+DA:62,8
+DA:63,8
+DA:64,8
+DA:65,8
+DA:66,8
+DA:67,8
+DA:68,8
+DA:69,8
+DA:70,8
+DA:71,8
+DA:72,8
+DA:74,8
+DA:75,8
+DA:76,8
+DA:77,8
+DA:78,1
+DA:79,1
+DA:80,1
+DA:81,1
+DA:82,1
+DA:83,8
+LF:65
+LH:65
+BRDA:13,0,0,8
+BRDA:16,1,0,1
+BRDA:21,2,0,7
+BRDA:23,3,0,1
+BRDA:28,4,0,6
+BRDA:30,5,0,5
+BRDA:30,6,0,1
+BRDA:39,7,0,1
+BRDA:41,8,0,4
+BRDA:41,9,0,1
+BRDA:43,10,0,3
+BRDA:45,11,0,5
+BRDA:50,12,0,4
+BRDA:51,13,0,1
+BRDA:68,14,0,5
+BRDA:77,15,0,1
+BRF:16
+BRH:16
+end_of_record
+TN:
+SF:lib/metrics.ts
+FN:33,gauge
+FN:34,histogram
+FN:35,counter
+FN:36,updowncounter
+FN:37,async-counter
+FN:38,async-updowncounter
+FN:39,async-gauge
+FN:48,getMeter
+FN:59,getMetric
+FNF:9
+FNH:9
+FNDA:1,gauge
+FNDA:1,histogram
+FNDA:1,counter
+FNDA:1,updowncounter
+FNDA:1,async-counter
+FNDA:1,async-updowncounter
+FNDA:2,async-gauge
+FNDA:9,getMeter
+FNDA:9,getMetric
+DA:1,1
+DA:28,1
+DA:32,1
+DA:33,1
+DA:34,1
+DA:35,1
+DA:36,1
+DA:37,1
+DA:38,1
+DA:39,1
+DA:40,1
+DA:48,9
+DA:49,9
+DA:50,9
+DA:51,1
+DA:52,1
+DA:53,9
+DA:54,8
+DA:55,8
+DA:56,9
+DA:57,9
+DA:59,1
+DA:60,9
+DA:61,9
+DA:62,9
+DA:63,9
+DA:65,9
+DA:66,1
+DA:67,1
+DA:69,8
+DA:70,8
+LF:31
+LH:31
+BRDA:33,0,0,1
+BRDA:34,1,0,1
+BRDA:35,2,0,1
+BRDA:36,3,0,1
+BRDA:37,4,0,1
+BRDA:38,5,0,1
+BRDA:39,6,0,2
+BRDA:48,7,0,9
+BRDA:50,8,0,8
+BRDA:50,9,0,1
+BRDA:53,10,0,8
+BRDA:59,11,0,9
+BRDA:65,12,0,1
+BRDA:67,13,0,8
+BRF:14
+BRH:14
+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

@@ -0,0 +1,7 @@
+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 };
+export * from "./lib/metrics.js";

package/dist/index.js

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

package/dist/lib/console.d.ts

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

package/dist/lib/console.js

@@ -0,0 +1,12 @@
+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

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

package/dist/lib/grpc.js

@@ -0,0 +1,26 @@
+import { LogRecordProcessorMap } from "./utils.js";
+import { metrics } from "@opentelemetry/sdk-node";
+import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-grpc";
+export default function buildGrpcExporters(config) {
+    return {
+        traces: new OTLPTraceExporter({
+            url: `${config.collectorUrl}`,
+            compression: CompressionAlgorithm.GZIP,
+        }),
+        metrics: new metrics.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

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

package/dist/lib/http.js

@@ -0,0 +1,29 @@
+import { LogRecordProcessorMap } from "./utils.js";
+import { metrics } from "@opentelemetry/sdk-node";
+import { CompressionAlgorithm } from "@opentelemetry/otlp-exporter-base";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
+import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-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 metrics.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

@@ -0,0 +1,46 @@
+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;
+    /**
+     * protocol used to send signals.
+     *
+     * @default grpc
+     */
+    protocol?: SDKProtocol;
+}
+export type SDKCollectorMode = "single" | "batch";
+export type SDKProtocol = "grpc" | "http" | "console";
+export type SDKLogLevel = "NONE" | "ERROR" | "WARN" | "INFO" | "DEBUG" | "VERBOSE" | "ALL";
+export {};

package/dist/lib/index.js

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

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

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