@faststore/diagnostics 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 VTEX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# diagnostics

package/configs/dev.json

@@ -0,0 +1,14 @@
+{
+  "traces": {
+    "sampling": {
+      "defaultRate": 1,
+      "rules": [
+        {
+          "name": "debug_all",
+          "sampleRate": 1,
+          "conditions": []
+        }
+      ]
+    }
+  }
+}

package/configs/prod.json

@@ -0,0 +1,14 @@
+{
+  "traces": {
+    "sampling": {
+      "defaultRate": 0.01,
+      "rules": [
+        {
+          "name": "trace_all",
+          "sampleRate": 0.3,
+          "conditions": []
+        }
+      ]
+    }
+  }
+}

package/dist/cjs/index.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const r=require("@opentelemetry/api"),a=require("@vtex/diagnostics-nodejs/dist/exporters/index.js"),o=require("@vtex/diagnostics-nodejs/dist/telemetry/client.js"),i=require("@opentelemetry/instrumentation-http"),c=require("resolve-pkg");function l(e){const t=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(e){for(const n in e)if(n!=="default"){const s=Object.getOwnPropertyDescriptor(e,n);Object.defineProperty(t,n,s.get?s:{enumerable:!0,get:()=>e[n]})}}return t.default=e,Object.freeze(t)}const g=l(r);globalThis.fsDiagnostics??={IS_DEV:process.env.NODE_ENV!=="production",TELEMETRY_CLIENTS:new Map,TRACE_CLIENTS:new Map};const E="@faststore/diagnostics";async function T(){const e=process.env.OTLP_TRACES_ENDPOINT||"localhost:4317",t=a.CreateTracesExporterConfig({endpoint:e,insecure:global.fsDiagnostics.IS_DEV??!1}),n=a.CreateExporter(t,"otlp");return await n.initialize(),n}async function u(e){if(global.fsDiagnostics.TELEMETRY_CLIENTS.has(e.packageName))return global.fsDiagnostics.TELEMETRY_CLIENTS.get(e.packageName);const t=await o.NewTelemetryClient(E,e.clientName,e.serviceName,{additionalAttrs:{"@faststore_version":e.version,"@faststore_package_name":e.packageName,"@faststore_account_name":e.account??"unknown","@faststore_environment":process.env.NODE_ENV??"development"},config:{configPath:c(`@faststore/diagnostics/configs/${global.fsDiagnostics.IS_DEV?"dev":"prod"}.json`,{cwd:process.env.PWD??process.cwd()})}}),n=await T();return global.fsDiagnostics.TRACE_CLIENTS.set(e.packageName,await t.newTracesClient({setGlobalProvider:!0,exporter:n})),t.registerInstrumentations([new i.HttpInstrumentation]),console.log("TELEMETRY CLIENT STARTED",e),global.fsDiagnostics.TELEMETRY_CLIENTS.set(e.packageName,t),t}function f(e){return global.fsDiagnostics.TRACE_CLIENTS.get(e)}exports.OTELAPI=g;exports.getTelemetryClient=u;exports.getTraceClient=f;

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/globals.ts","../../src/start.ts"],"sourcesContent":["globalThis.fsDiagnostics ??= {\n  IS_DEV: import.meta.env.DEV === true || process.env.NODE_ENV !== 'production',\n  TELEMETRY_CLIENTS: new Map(),\n  TRACE_CLIENTS: new Map(),\n}\n","import {\n  CreateTracesExporterConfig,\n  CreateExporter,\n} from '@vtex/diagnostics-nodejs/dist/exporters/index.js'\nimport { NewTelemetryClient } from '@vtex/diagnostics-nodejs/dist/telemetry/client.js'\nimport { HttpInstrumentation } from '@opentelemetry/instrumentation-http'\nimport resolvePackage from 'resolve-pkg'\n\nimport { name as currentPkgName } from '../package.json' with { type: 'json' }\n\nasync function setupTracesExporter() {\n  const OTLP_TRACES_ENDPOINT =\n    process.env.OTLP_TRACES_ENDPOINT || 'localhost:4317'\n\n  const tracesConfig = CreateTracesExporterConfig({\n    endpoint: OTLP_TRACES_ENDPOINT,\n    insecure: global.fsDiagnostics.IS_DEV ?? false,\n  })\n\n  const tracesExporter = CreateExporter(tracesConfig, 'otlp')\n  await tracesExporter.initialize()\n  return tracesExporter\n}\n\nexport async function getTelemetryClient(opt: {\n  serviceName: string\n  version: string\n  clientName: string\n  account: string\n  packageName: string\n}) {\n  if (global.fsDiagnostics.TELEMETRY_CLIENTS.has(opt.packageName))\n    return global.fsDiagnostics.TELEMETRY_CLIENTS.get(opt.packageName)\n\n  const client = await NewTelemetryClient(\n    currentPkgName,\n    opt.clientName,\n    opt.serviceName,\n    {\n      additionalAttrs: {\n        '@faststore_version': opt.version,\n        '@faststore_package_name': opt.packageName,\n        '@faststore_account_name': opt.account ?? 'unknown',\n        '@faststore_environment': process.env.NODE_ENV ?? 'development',\n      },\n      // debug: global.fsDiagnostics.IS_DEV,\n      config: {\n        configPath: resolvePackage(\n          `@faststore/diagnostics/configs/${global.fsDiagnostics.IS_DEV ? 'dev' : 'prod'}.json`,\n          {\n            cwd: process.env.PWD ?? process.cwd(),\n          }\n        ),\n      },\n    }\n  )\n\n  const tracesExporter = await setupTracesExporter()\n  // const logger = await client.newLogsClient()\n  // const metrics = await client.newMetricsClient()\n\n  global.fsDiagnostics.TRACE_CLIENTS.set(\n    opt.packageName,\n    await client.newTracesClient({\n      setGlobalProvider: true,\n      exporter: tracesExporter,\n    })\n  )\n\n  // await logger.shutdown()\n  // await metrics.shutdown()\n\n  client.registerInstrumentations([new HttpInstrumentation()])\n\n  // if (global.fsDiagnostics.IS_DEV)\n  console.log('TELEMETRY CLIENT STARTED', opt)\n\n  global.fsDiagnostics.TELEMETRY_CLIENTS.set(opt.packageName, client)\n  return client\n}\n\nexport function getTraceClient(serviceName: string) {\n  return global.fsDiagnostics.TRACE_CLIENTS.get(serviceName)\n}\n"],"names":["setupTracesExporter","OTLP_TRACES_ENDPOINT","tracesConfig","CreateTracesExporterConfig","tracesExporter","CreateExporter","getTelemetryClient","opt","client","NewTelemetryClient","currentPkgName","resolvePackage","HttpInstrumentation","getTraceClient","serviceName"],"mappings":"ulBAAA,WAAW,gBAAkB,CAC3B,OAAwC,QAAQ,IAAI,WAAa,aACjE,sBAAuB,IACvB,kBAAmB,GACrB,mCCMA,eAAeA,GAAsB,CACnC,MAAMC,EACJ,QAAQ,IAAI,sBAAwB,iBAEhCC,EAAeC,EAAAA,2BAA2B,CAC9C,SAAUF,EACV,SAAU,OAAO,cAAc,QAAU,EAAA,CAC1C,EAEKG,EAAiBC,EAAAA,eAAeH,EAAc,MAAM,EAC1D,aAAME,EAAe,WAAA,EACdA,CACT,CAEA,eAAsBE,EAAmBC,EAMtC,CACD,GAAI,OAAO,cAAc,kBAAkB,IAAIA,EAAI,WAAW,EAC5D,OAAO,OAAO,cAAc,kBAAkB,IAAIA,EAAI,WAAW,EAEnE,MAAMC,EAAS,MAAMC,EAAAA,mBACnBC,EACAH,EAAI,WACJA,EAAI,YACJ,CACE,gBAAiB,CACf,qBAAsBA,EAAI,QAC1B,0BAA2BA,EAAI,YAC/B,0BAA2BA,EAAI,SAAW,UAC1C,yBAA0B,QAAQ,IAAI,UAAY,aAAA,EAGpD,OAAQ,CACN,WAAYI,EACV,kCAAkC,OAAO,cAAc,OAAS,MAAQ,MAAM,QAC9E,CACE,IAAK,QAAQ,IAAI,KAAO,QAAQ,IAAA,CAAI,CACtC,CACF,CACF,CACF,EAGIP,EAAiB,MAAMJ,EAAA,EAI7B,cAAO,cAAc,cAAc,IACjCO,EAAI,YACJ,MAAMC,EAAO,gBAAgB,CAC3B,kBAAmB,GACnB,SAAUJ,CAAA,CACX,CAAA,EAMHI,EAAO,yBAAyB,CAAC,IAAII,EAAAA,mBAAqB,CAAC,EAG3D,QAAQ,IAAI,2BAA4BL,CAAG,EAE3C,OAAO,cAAc,kBAAkB,IAAIA,EAAI,YAAaC,CAAM,EAC3DA,CACT,CAEO,SAASK,EAAeC,EAAqB,CAClD,OAAO,OAAO,cAAc,cAAc,IAAIA,CAAW,CAC3D"}

package/dist/es/index.mjs

@@ -0,0 +1,59 @@
+import * as T from "@opentelemetry/api";
+import { CreateTracesExporterConfig as a, CreateExporter as o } from "@vtex/diagnostics-nodejs/dist/exporters/index.js";
+import { NewTelemetryClient as n } from "@vtex/diagnostics-nodejs/dist/telemetry/client.js";
+import { HttpInstrumentation as r } from "@opentelemetry/instrumentation-http";
+import i from "resolve-pkg";
+globalThis.fsDiagnostics ??= {
+  IS_DEV: process.env.NODE_ENV !== "production",
+  TELEMETRY_CLIENTS: /* @__PURE__ */ new Map(),
+  TRACE_CLIENTS: /* @__PURE__ */ new Map()
+};
+const c = "@faststore/diagnostics";
+async function E() {
+  const e = process.env.OTLP_TRACES_ENDPOINT || "localhost:4317", s = a({
+    endpoint: e,
+    insecure: global.fsDiagnostics.IS_DEV ?? !1
+  }), t = o(s, "otlp");
+  return await t.initialize(), t;
+}
+async function p(e) {
+  if (global.fsDiagnostics.TELEMETRY_CLIENTS.has(e.packageName))
+    return global.fsDiagnostics.TELEMETRY_CLIENTS.get(e.packageName);
+  const s = await n(
+    c,
+    e.clientName,
+    e.serviceName,
+    {
+      additionalAttrs: {
+        "@faststore_version": e.version,
+        "@faststore_package_name": e.packageName,
+        "@faststore_account_name": e.account ?? "unknown",
+        "@faststore_environment": process.env.NODE_ENV ?? "development"
+      },
+      // debug: global.fsDiagnostics.IS_DEV,
+      config: {
+        configPath: i(
+          `@faststore/diagnostics/configs/${global.fsDiagnostics.IS_DEV ? "dev" : "prod"}.json`,
+          {
+            cwd: process.env.PWD ?? process.cwd()
+          }
+        )
+      }
+    }
+  ), t = await E();
+  return global.fsDiagnostics.TRACE_CLIENTS.set(
+    e.packageName,
+    await s.newTracesClient({
+      setGlobalProvider: !0,
+      exporter: t
+    })
+  ), s.registerInstrumentations([new r()]), console.log("TELEMETRY CLIENT STARTED", e), global.fsDiagnostics.TELEMETRY_CLIENTS.set(e.packageName, s), s;
+}
+function N(e) {
+  return global.fsDiagnostics.TRACE_CLIENTS.get(e);
+}
+export {
+  T as OTELAPI,
+  p as getTelemetryClient,
+  N as getTraceClient
+};

package/dist/es/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sources":["../../src/globals.ts","../../src/start.ts"],"sourcesContent":["globalThis.fsDiagnostics ??= {\n  IS_DEV: import.meta.env.DEV === true || process.env.NODE_ENV !== 'production',\n  TELEMETRY_CLIENTS: new Map(),\n  TRACE_CLIENTS: new Map(),\n}\n","import {\n  CreateTracesExporterConfig,\n  CreateExporter,\n} from '@vtex/diagnostics-nodejs/dist/exporters/index.js'\nimport { NewTelemetryClient } from '@vtex/diagnostics-nodejs/dist/telemetry/client.js'\nimport { HttpInstrumentation } from '@opentelemetry/instrumentation-http'\nimport resolvePackage from 'resolve-pkg'\n\nimport { name as currentPkgName } from '../package.json' with { type: 'json' }\n\nasync function setupTracesExporter() {\n  const OTLP_TRACES_ENDPOINT =\n    process.env.OTLP_TRACES_ENDPOINT || 'localhost:4317'\n\n  const tracesConfig = CreateTracesExporterConfig({\n    endpoint: OTLP_TRACES_ENDPOINT,\n    insecure: global.fsDiagnostics.IS_DEV ?? false,\n  })\n\n  const tracesExporter = CreateExporter(tracesConfig, 'otlp')\n  await tracesExporter.initialize()\n  return tracesExporter\n}\n\nexport async function getTelemetryClient(opt: {\n  serviceName: string\n  version: string\n  clientName: string\n  account: string\n  packageName: string\n}) {\n  if (global.fsDiagnostics.TELEMETRY_CLIENTS.has(opt.packageName))\n    return global.fsDiagnostics.TELEMETRY_CLIENTS.get(opt.packageName)\n\n  const client = await NewTelemetryClient(\n    currentPkgName,\n    opt.clientName,\n    opt.serviceName,\n    {\n      additionalAttrs: {\n        '@faststore_version': opt.version,\n        '@faststore_package_name': opt.packageName,\n        '@faststore_account_name': opt.account ?? 'unknown',\n        '@faststore_environment': process.env.NODE_ENV ?? 'development',\n      },\n      // debug: global.fsDiagnostics.IS_DEV,\n      config: {\n        configPath: resolvePackage(\n          `@faststore/diagnostics/configs/${global.fsDiagnostics.IS_DEV ? 'dev' : 'prod'}.json`,\n          {\n            cwd: process.env.PWD ?? process.cwd(),\n          }\n        ),\n      },\n    }\n  )\n\n  const tracesExporter = await setupTracesExporter()\n  // const logger = await client.newLogsClient()\n  // const metrics = await client.newMetricsClient()\n\n  global.fsDiagnostics.TRACE_CLIENTS.set(\n    opt.packageName,\n    await client.newTracesClient({\n      setGlobalProvider: true,\n      exporter: tracesExporter,\n    })\n  )\n\n  // await logger.shutdown()\n  // await metrics.shutdown()\n\n  client.registerInstrumentations([new HttpInstrumentation()])\n\n  // if (global.fsDiagnostics.IS_DEV)\n  console.log('TELEMETRY CLIENT STARTED', opt)\n\n  global.fsDiagnostics.TELEMETRY_CLIENTS.set(opt.packageName, client)\n  return client\n}\n\nexport function getTraceClient(serviceName: string) {\n  return global.fsDiagnostics.TRACE_CLIENTS.get(serviceName)\n}\n"],"names":["setupTracesExporter","OTLP_TRACES_ENDPOINT","tracesConfig","CreateTracesExporterConfig","tracesExporter","CreateExporter","getTelemetryClient","opt","client","NewTelemetryClient","currentPkgName","resolvePackage","HttpInstrumentation","getTraceClient","serviceName"],"mappings":";;;;;AAAA,WAAW,kBAAkB;AAAA,EAC3B,QAAwC,QAAQ,IAAI,aAAa;AAAA,EACjE,uCAAuB,IAAA;AAAA,EACvB,mCAAmB,IAAA;AACrB;;ACMA,eAAeA,IAAsB;AACnC,QAAMC,IACJ,QAAQ,IAAI,wBAAwB,kBAEhCC,IAAeC,EAA2B;AAAA,IAC9C,UAAUF;AAAA,IACV,UAAU,OAAO,cAAc,UAAU;AAAA,EAAA,CAC1C,GAEKG,IAAiBC,EAAeH,GAAc,MAAM;AAC1D,eAAME,EAAe,WAAA,GACdA;AACT;AAEA,eAAsBE,EAAmBC,GAMtC;AACD,MAAI,OAAO,cAAc,kBAAkB,IAAIA,EAAI,WAAW;AAC5D,WAAO,OAAO,cAAc,kBAAkB,IAAIA,EAAI,WAAW;AAEnE,QAAMC,IAAS,MAAMC;AAAA,IACnBC;AAAAA,IACAH,EAAI;AAAA,IACJA,EAAI;AAAA,IACJ;AAAA,MACE,iBAAiB;AAAA,QACf,sBAAsBA,EAAI;AAAA,QAC1B,2BAA2BA,EAAI;AAAA,QAC/B,2BAA2BA,EAAI,WAAW;AAAA,QAC1C,0BAA0B,QAAQ,IAAI,YAAY;AAAA,MAAA;AAAA;AAAA,MAGpD,QAAQ;AAAA,QACN,YAAYI;AAAA,UACV,kCAAkC,OAAO,cAAc,SAAS,QAAQ,MAAM;AAAA,UAC9E;AAAA,YACE,KAAK,QAAQ,IAAI,OAAO,QAAQ,IAAA;AAAA,UAAI;AAAA,QACtC;AAAA,MACF;AAAA,IACF;AAAA,EACF,GAGIP,IAAiB,MAAMJ,EAAA;AAI7B,gBAAO,cAAc,cAAc;AAAA,IACjCO,EAAI;AAAA,IACJ,MAAMC,EAAO,gBAAgB;AAAA,MAC3B,mBAAmB;AAAA,MACnB,UAAUJ;AAAA,IAAA,CACX;AAAA,EAAA,GAMHI,EAAO,yBAAyB,CAAC,IAAII,EAAA,CAAqB,CAAC,GAG3D,QAAQ,IAAI,4BAA4BL,CAAG,GAE3C,OAAO,cAAc,kBAAkB,IAAIA,EAAI,aAAaC,CAAM,GAC3DA;AACT;AAEO,SAASK,EAAeC,GAAqB;AAClD,SAAO,OAAO,cAAc,cAAc,IAAIA,CAAW;AAC3D;"}

package/dist/src/globals.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=globals.d.ts.map

package/dist/src/globals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globals.d.ts","sourceRoot":"","sources":["../../src/globals.ts"],"names":[],"mappings":""}

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * as OTELAPI from '@opentelemetry/api';
+export { getTelemetryClient, getTraceClient } from './start';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,CAAA;AAClB,OAAO,KAAK,OAAO,MAAM,oBAAoB,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA"}

package/dist/src/start.d.ts

@@ -0,0 +1,9 @@
+export declare function getTelemetryClient(opt: {
+    serviceName: string;
+    version: string;
+    clientName: string;
+    account: string;
+    packageName: string;
+}): Promise<import('@vtex/diagnostics-nodejs/dist/telemetry/client.js').TelemetryClient | undefined>;
+export declare function getTraceClient(serviceName: string): import('@vtex/diagnostics-nodejs/dist/types/traces.js').TraceClient | undefined;
+//# sourceMappingURL=start.d.ts.map

package/dist/src/start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../../src/start.ts"],"names":[],"mappings":"AAwBA,wBAAsB,kBAAkB,CAAC,GAAG,EAAE;IAC5C,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;CACpB,oGAiDA;AAED,wBAAgB,cAAc,CAAC,WAAW,EAAE,MAAM,mFAEjD"}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@faststore/diagnostics",
+  "version": "1.0.0",
+  "description": "",
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/src/index.d.ts",
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "files": [
+    "configs",
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/es/index.mjs",
+      "default": "./dist/cjs/index.js"
+    },
+    "./configs/*": "./configs/*"
+  },
+  "dependencies": {
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/instrumentation-http": "^0.212.0",
+    "@vtex/diagnostics-nodejs": "^5.1.1",
+    "resolve-pkg": "^3.0.1"
+  },
+  "devDependencies": {
+    "@types/node": "20.19.13",
+    "tslib": "2.8.1",
+    "typescript": "5.9.3",
+    "vite": "7.1.5",
+    "vite-plugin-dts": "4.5.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build"
+  }
+}