feat/node-core package, exporter for otel metrics

Author: piotr-szewczyk

packages/node/global.d.ts

@@ -1,6 +1,6 @@
 {
     "name": "@traceo-sdk/node",
-    "version": "0.32.1",
+    "version": "0.32.2",
     "author": "Traceo",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -25,6 +25,7 @@
     },
     "dependencies": {
         "stacktrace-parser-node": "^1.1.3",
+        "@traceo-sdk/node-core": "0.32.2",
         "os": "^0.1.2"
     },
     "devDependencies": {

packages/node/package.json

@@ -1,67 +1,31 @@
+import { INodeClient, CoreClient, TraceoOptions, Dictionary } from "@traceo-sdk/node-core";
 import { Logger } from "./logger";
-import { Metrics } from "./metrics";
+import { MetricsRunner } from "./metrics";
 import { Scrapper } from "./scrapper";
-import { ClientOptions, TraceoOptions } from "./types";
-import { TRACEO_SDK_VERSION } from "./version";
 
-export class Client {
-  public headers: { [key: string]: any };
-
-  private _metrics: Metrics;
-  private scrappedData: Scrapper;
+export class Client extends CoreClient implements INodeClient {
+  public headers: Dictionary<any>;
 
   public readonly logger: Logger;
   public options: TraceoOptions;
 
-  constructor(apiKey: string, options: ClientOptions) {
-    this.configGlobalClient();
-
-    this.options = {
-      ...options,
-      apiKey
-    };
-
-    this.headers = {
-      "x-sdk-name": "node",
-      "x-sdk-version": TRACEO_SDK_VERSION,
-      "x-sdk-key": apiKey
-    };
+  constructor(apiKey: string, options: Omit<TraceoOptions, "apiKey">) {
+    super(apiKey, options);
 
     this.logger = new Logger();
-    this.scrappedData = new Scrapper();
-
-    this._metrics = new Metrics();
-
-    if (!this.isOffline) {
-      this.initSDK();
-    }
-  }
-
-  public static get client(): Client {
-    return global["__TRACEO__"];
   }
 
   public static get logger(): Logger {
-    return this.client.logger;
-  }
-
-  public static get config(): TraceoOptions {
-    return this.client.options;
+    return this.logger;
   }
 
-  private get isOffline(): boolean {
-    return this.options.offline;
-  }
-
-  private initSDK(): void {
-    this.scrappedData.collect();
+  public initSDK(): void {
+    const scrapper = new Scrapper();
+    scrapper.collect();
 
     if (this.options.collectMetrics) {
-      this._metrics.register();
+      const metrics = new MetricsRunner();
+      metrics.register();
     }
   }
-
-  private configGlobalClient(): void {
-    global["__TRACEO__"] = this;
-  }
 }

packages/node/src/client.ts

@@ -1,8 +1,5 @@
 import { stacktrace } from "stacktrace-parser-node";
-import { HttpModule } from "../core/http";
-import { isClientConnected } from "../core/is";
-import { TraceoError, NodeIncidentType, CAPTURE_ENDPOINT } from "../types";
-import { getOsDetails } from "../helpers";
+import { transport, TraceoError, NodeIncidentType, CAPTURE_ENDPOINT, utils } from "@traceo-sdk/node-core";
 
 /**
  * For using in middleware and as an function in try/catch
@@ -19,7 +16,7 @@ import { getOsDetails } from "../helpers";
  *
  */
 export const catchException = async (error: Error) => {
-  if (isClientConnected()) {
+  if (utils.isClientConnected()) {
     await handleException(error);
   }
 
@@ -28,8 +25,8 @@ export const catchException = async (error: Error) => {
 
 const handleException = async (error: TraceoError) => {
   const event: NodeIncidentType = await prepareException(error);
-  const httpModule = HttpModule.getInstance();
-  httpModule.request({
+
+  transport.request({
     url: CAPTURE_ENDPOINT.INCIDENT,
     body: event,
     onError: (error: Error) => {
@@ -43,7 +40,7 @@ const handleException = async (error: TraceoError) => {
 
 const prepareException = async (error: TraceoError): Promise<NodeIncidentType> => {
   const { stack } = error;
-  const platform = getOsDetails();
+  const platform = utils.getOsDetails();
 
   const { message, name, traces } = await stacktrace.parse(error);
   const event: NodeIncidentType = {

packages/node/src/core/global.ts

@@ -2,10 +2,9 @@ import {
   TraceoError,
   TraceoIncomingMessage,
   TraceoServerResponse,
-  ErrorMiddlewareOptions
-} from "../types";
-import { isClientConnected, isLocalhost } from "../core/is";
-import { getProtocol, getIp } from "../helpers";
+  ErrorMiddlewareOptions,
+  utils,
+} from "@traceo-sdk/node-core";
 import { catchException } from "./handler";
 /**
  * Base middleware to catch and intercept error across the express app.
@@ -37,7 +36,7 @@ export const errorMiddleware = (options: ErrorMiddlewareOptions = {}) => {
     _res: TraceoServerResponse,
     next: (error: TraceoError) => void
   ): Promise<void> {
-    if (!isClientConnected()) {
+    if (!utils.isClientConnected()) {
       next(error);
       return;
     }
@@ -52,14 +51,15 @@ export const errorMiddleware = (options: ErrorMiddlewareOptions = {}) => {
 
 const isToCatch = (req: TraceoIncomingMessage, options: ErrorMiddlewareOptions = {}): boolean => {
   if (options.allowHttp !== undefined && !options.allowHttp) {
-    const isSecure = getProtocol(req) === "https" ? true : false;
+    const isSecure = utils.getProtocol(req) === "https" ? true : false;
     if (!isSecure) {
       return false;
     }
   }
 
   if (options.allowLocalhost !== undefined && !options.allowLocalhost) {
-    if (isLocalhost(String(getIp(req)))) {
+    const ip = utils.getIp(req) as string;
+    if (utils.isLocalhost(ip)) {
       return false;
     }
   }

packages/node/src/core/http.ts

@@ -1,18 +1,17 @@
 import { format } from "util";
-import { HttpModule } from "./core/http";
-import { CAPTURE_ENDPOINT, LogLevel } from "./types";
-import { Client } from "./client";
+import { CAPTURE_ENDPOINT, LogLevel, transport } from "@traceo-sdk/node-core";
+import { getGlobalTraceo } from "@traceo-sdk/node-core/dist/utils";
 
 export class Logger {
-  private readonly http: HttpModule;
   private logsQueue = [];
   private INTERVAL = 60;
 
   constructor() {
-    this.http = HttpModule.getInstance();
     this.logsQueue = [];
 
-    const scrapLogsInterval = Client.config?.scrapLogsInterval;
+    const client = getGlobalTraceo();
+        
+    const scrapLogsInterval = client.options.scrapLogsInterval;
     if (scrapLogsInterval && scrapLogsInterval >= 15) {
       this.INTERVAL = scrapLogsInterval;
     }
@@ -67,7 +66,7 @@ export class Logger {
 
   private async sendLogs() {
     if (this.logsQueue.length > 0) {
-      this.http.request({
+      transport.request({
         url: CAPTURE_ENDPOINT.LOG,
         body: this.logsQueue,
         onError: (error: Error) => {