@boxyhq/metrics 0.2.2 → 0.2.3

package/README.md

@@ -3,3 +3,14 @@
 <a href="https://www.npmjs.com/package/@boxyhq/metrics"><img src="https://img.shields.io/npm/v/@boxyhq/metrics.svg" alt="npm" ></a>
 
 Package for OTel instrumentation
+
+## Running Tests
+
+Tests helps us to ensure that the telemetry export works as expected after every OTEL dependency update.
+
+```shell
+npm i
+# Copy test/.env.example to test/.env and set the values
+cp test/.env.example test/.env
+npm run test:manual
+```

package/dist/package.json

@@ -0,0 +1,48 @@
+{
+    "name": "@boxyhq/metrics",
+    "version": "0.2.3",
+    "description": "Internal SDK for OTel instrumentation",
+    "main": "dist/index.js",
+    "typings": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsc -p tsconfig.json",
+        "prepublishOnly": "npm run build",
+        "lint": "eslint -c .eslintrc.json --ext .ts ./",
+        "test:manual": "env-cmd -f ./test/.env ts-node --project tsconfig.json test/index.ts"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/boxyhq/metrics.git"
+    },
+    "keywords": [
+        "otel",
+        "telemetry"
+    ],
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/boxyhq/metrics/issues"
+    },
+    "homepage": "https://github.com/boxyhq/metrics#readme",
+    "dependencies": {
+        "@opentelemetry/api": "1.4.1",
+        "@opentelemetry/exporter-metrics-otlp-grpc": "0.40.0",
+        "@opentelemetry/exporter-metrics-otlp-http": "0.40.0",
+        "@opentelemetry/resources": "1.14.0",
+        "@opentelemetry/sdk-metrics": "1.14.0",
+        "@opentelemetry/semantic-conventions": "1.14.0"
+    },
+    "devDependencies": {
+        "@tsconfig/recommended": "1.0.2",
+        "@typescript-eslint/eslint-plugin": "5.58.0",
+        "@typescript-eslint/parser": "5.58.0",
+        "env-cmd": "10.1.0",
+        "eslint": "8.38.0",
+        "eslint-config-prettier": "8.8.0",
+        "prettier": "2.8.8",
+        "ts-node": "10.9.1",
+        "typescript": "5.0.4"
+    }
+}

package/dist/{init.js → src/init.js}

@@ -28,14 +28,17 @@ function initializeMetrics(serviceInfo) {
         else {
             metricExporter = new exporter_metrics_otlp_http_1.OTLPMetricExporter();
         }
+        /** exportIntervalMillis must be greater than exportTimeoutMillis */
+        const exportIntervalMillis = Number(process.env.OTEL_EXPORT_INTERVAL_MS) || 60000;
+        const exportTimeoutMillis = Number(process.env.OTEL_EXPORT_INTERVAL_MS) - 1000 || 30000;
         meterProvider.addMetricReader(new sdk_metrics_1.PeriodicExportingMetricReader({
             exporter: metricExporter,
-            exportIntervalMillis: 60000,
+            exportIntervalMillis,
+            exportTimeoutMillis,
         }));
         api_1.metrics.setGlobalMeterProvider(meterProvider);
     }
     if (process.env.OTEL_EXPORTER_DEBUG) {
-        api_1.diag.disable();
         api_1.diag.setLogger(new api_1.DiagConsoleLogger(), api_1.DiagLogLevel.DEBUG);
     }
 }

package/dist/test/index.d.ts

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

package/dist/test/index.js

@@ -0,0 +1,56 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+const package_json_1 = __importDefault(require("../package.json"));
+const promises_1 = require("timers/promises");
+const SERVICE_NAME = '@boxyhq/metrics';
+(0, src_1.initializeMetrics)({ name: SERVICE_NAME, version: package_json_1.default.version });
+const METER = 'meter';
+function testInstruments() {
+    return __awaiter(this, void 0, void 0, function* () {
+        (0, src_1.incrementCounter)({
+            meter: METER,
+            name: 'test.counter',
+            counterOptions: { description: 'Test counter' },
+        });
+        console.log(`Operation for counter metric ... DONE`);
+        (0, src_1.observeGauge)({
+            meter: METER,
+            name: 'test.gauge',
+            gaugeOptions: { description: 'Test gauge', unit: 'm/s' },
+            val: 100,
+        });
+        console.log(`Operation for gauge metric ... DONE`);
+        (0, src_1.recordHistogram)({
+            meter: METER,
+            name: 'test.histogram',
+            histogramOptions: { description: 'Test histogram' },
+            val: 200,
+        });
+        console.log(`Operation for histogram metric ... DONE`);
+        yield (0, src_1.instrument)({
+            meter: METER,
+            name: 'test.instrument',
+            delegate: () => Promise.resolve(),
+        });
+        console.log(`Operation for function instrumentation ... DONE`);
+        /** Essential to set a timeout below that is more than the export interval*/
+        const waitTime = Number(process.env.OTEL_EXPORT_INTERVAL_MS) + 1000 || 61000;
+        console.log(`Waiting for ${waitTime}ms to complete export ....`);
+        yield (0, promises_1.setTimeout)(waitTime);
+        console.log(`Export operation ... COMPLETE, please check the configured OTEL service for recorded values`);
+    });
+}
+testInstruments();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxyhq/metrics",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Internal SDK for OTel instrumentation",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -10,7 +10,8 @@
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "prepublishOnly": "npm run build",
-    "lint": "eslint -c .eslintrc.json --ext .ts ./"
+    "lint": "eslint -c .eslintrc.json --ext .ts ./",
+    "test:manual": "env-cmd -f ./test/.env ts-node --project tsconfig.json test/index.ts"
   },
   "repository": {
     "type": "git",
@@ -27,19 +28,21 @@
   "homepage": "https://github.com/boxyhq/metrics#readme",
   "dependencies": {
     "@opentelemetry/api": "1.4.1",
-    "@opentelemetry/exporter-metrics-otlp-grpc": "0.37.0",
-    "@opentelemetry/exporter-metrics-otlp-http": "0.37.0",
-    "@opentelemetry/resources": "1.11.0",
-    "@opentelemetry/sdk-metrics": "1.11.0",
-    "@opentelemetry/semantic-conventions": "1.11.0"
+    "@opentelemetry/exporter-metrics-otlp-grpc": "0.40.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "0.40.0",
+    "@opentelemetry/resources": "1.14.0",
+    "@opentelemetry/sdk-metrics": "1.14.0",
+    "@opentelemetry/semantic-conventions": "1.14.0"
   },
   "devDependencies": {
     "@tsconfig/recommended": "1.0.2",
     "@typescript-eslint/eslint-plugin": "5.58.0",
     "@typescript-eslint/parser": "5.58.0",
+    "env-cmd": "10.1.0",
     "eslint": "8.38.0",
     "eslint-config-prettier": "8.8.0",
-    "prettier": "2.8.7",
+    "prettier": "2.8.8",
+    "ts-node": "10.9.1",
     "typescript": "5.0.4"
   }
 }