@boxyhq/metrics 0.1.0 → 0.2.0

package/README.md

@@ -1,2 +1,5 @@
-# metrics
+# @boxyhq/metrics
+
+<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

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./init";
-export * from "./instruments";
+export * from './init';
+export * from './instruments';

package/dist/init.js

@@ -13,8 +13,7 @@ const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
  *  See https://opentelemetry.io/docs/instrumentation/js/instrumentation/#initialize-metrics
  */
 function initializeMetrics(serviceInfo) {
-    if (process.env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT ||
-        process.env.OTEL_EXPORTER_OTLP_ENDPOINT) {
+    if (process.env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT || process.env.OTEL_EXPORTER_OTLP_ENDPOINT) {
         const meterProvider = new sdk_metrics_1.MeterProvider({
             resource: new resources_1.Resource({
                 [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: `${serviceInfo.name}`,
@@ -22,8 +21,8 @@ function initializeMetrics(serviceInfo) {
             }),
         });
         let metricExporter;
-        if (process.env.OTEL_EXPORTER_OTLP_PROTOCOL === "grpc" ||
-            process.env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL === "grpc") {
+        if (process.env.OTEL_EXPORTER_OTLP_PROTOCOL === 'grpc' ||
+            process.env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL === 'grpc') {
             metricExporter = new exporter_metrics_otlp_grpc_1.OTLPMetricExporter();
         }
         else {

package/dist/instruments/counter.d.ts

@@ -1,10 +1,15 @@
-import type { Attributes, MetricOptions } from "@opentelemetry/api";
-type OperationParams = {
+import type { Attributes, MetricOptions } from '@opentelemetry/api';
+type CounterOperationParams = {
+    /** OTel meter name */
     meter: string;
+    /** Metric name being instrumented */
     name: string;
+    /** Value by which counter is incremented, defaults to 1 */
     inc?: number;
+    /** MetricOptions such as unit */
     counterOptions?: MetricOptions;
+    /** Metric Attributes in the form of key value pairs */
     counterAttributes?: Attributes;
 };
-declare const incrementCounter: ({ meter, name, inc, counterOptions, counterAttributes, }: OperationParams) => void;
-export { incrementCounter };
+declare const incrementCounter: ({ meter, name, inc, counterOptions, counterAttributes, }: CounterOperationParams) => void;
+export { incrementCounter, type CounterOperationParams };

package/dist/instruments/gauge.d.ts

@@ -1,10 +1,15 @@
-import type { Attributes, MetricOptions } from "@opentelemetry/api";
-type OperationParams = {
+import type { Attributes, MetricOptions } from '@opentelemetry/api';
+type GaugeOperationParams = {
+    /** OTel meter name */
     meter: string;
+    /** Metric name being instrumented */
     name: string;
+    /** Non-additive value observed at a point in time */
     val: number;
+    /** MetricOptions such as unit */
     gaugeOptions?: MetricOptions;
+    /** Metric Attributes in the form of key value pairs */
     gaugeAttributes?: Attributes;
 };
-declare const observeGauge: ({ meter, name, val, gaugeOptions, gaugeAttributes, }: OperationParams) => void;
-export { observeGauge };
+declare const observeGauge: ({ meter, name, val, gaugeOptions, gaugeAttributes }: GaugeOperationParams) => void;
+export { observeGauge, type GaugeOperationParams };

package/dist/instruments/gauge.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.observeGauge = void 0;
 const meter_1 = require("../lib/meter");
 const gauges = {};
-const observeGauge = ({ meter, name, val, gaugeOptions, gaugeAttributes, }) => {
+const observeGauge = ({ meter, name, val, gaugeOptions, gaugeAttributes }) => {
     let gauge = gauges[name];
     if (gauge === undefined) {
         const _otelMeter = (0, meter_1.acquireMeter)(meter);

package/dist/instruments/histogram.d.ts

@@ -1,10 +1,15 @@
-import type { Attributes, MetricOptions } from "@opentelemetry/api";
-type OperationParams = {
+import type { Attributes, MetricOptions } from '@opentelemetry/api';
+type HistogramOperationParams = {
+    /** OTel meter name */
     meter: string;
+    /** Metric name being instrumented */
     name: string;
+    /** Value to be recorded  */
     val: number;
+    /** MetricOptions such as unit */
     histogramOptions?: MetricOptions;
+    /** Metric Attributes in the form of key value pairs */
     histogramAttributes?: Attributes;
 };
-declare const recordHistogram: ({ meter, name, val, histogramOptions, histogramAttributes, }: OperationParams) => void;
-export { recordHistogram };
+declare const recordHistogram: ({ meter, name, val, histogramOptions, histogramAttributes, }: HistogramOperationParams) => void;
+export { recordHistogram, type HistogramOperationParams };

package/dist/instruments/index.d.ts

@@ -1,5 +1,5 @@
-export { incrementCounter } from "./counter";
-export { observeGauge } from "./gauge";
-export { recordHistogram } from "./histogram";
-export { recordTimer } from "./timer";
-export { instrument, instrumented } from "./instrument";
+export * from './counter';
+export * from './gauge';
+export * from './histogram';
+export * from './timer';
+export * from './instrument';

package/dist/instruments/index.js

@@ -1,14 +1,21 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.instrumented = exports.instrument = exports.recordTimer = exports.recordHistogram = exports.observeGauge = exports.incrementCounter = void 0;
-var counter_1 = require("./counter");
-Object.defineProperty(exports, "incrementCounter", { enumerable: true, get: function () { return counter_1.incrementCounter; } });
-var gauge_1 = require("./gauge");
-Object.defineProperty(exports, "observeGauge", { enumerable: true, get: function () { return gauge_1.observeGauge; } });
-var histogram_1 = require("./histogram");
-Object.defineProperty(exports, "recordHistogram", { enumerable: true, get: function () { return histogram_1.recordHistogram; } });
-var timer_1 = require("./timer");
-Object.defineProperty(exports, "recordTimer", { enumerable: true, get: function () { return timer_1.recordTimer; } });
-var instrument_1 = require("./instrument");
-Object.defineProperty(exports, "instrument", { enumerable: true, get: function () { return instrument_1.instrument; } });
-Object.defineProperty(exports, "instrumented", { enumerable: true, get: function () { return instrument_1.instrumented; } });
+__exportStar(require("./counter"), exports);
+__exportStar(require("./gauge"), exports);
+__exportStar(require("./histogram"), exports);
+__exportStar(require("./timer"), exports);
+__exportStar(require("./instrument"), exports);

package/dist/instruments/instrument.d.ts

@@ -1,19 +1,24 @@
-type InstrumentParams = {
+import type { Attributes } from '@opentelemetry/api';
+type InstrumentOperationParams = {
     /** OTel meter name */
     meter: string;
     /** Function name being instrumented */
     name: string;
     /** Handle to execute the function */
     delegate: () => unknown;
+    /** Metric Attributes in the form of key value pairs  */
+    instrumentAttributes?: Attributes;
 };
 /**
  * Run the given function, recording throughput, latency and errors
  *
  * @param operationParams
  */
-declare function instrument({ meter, name, delegate }: InstrumentParams): Promise<unknown>;
+declare function instrument({ meter, name, delegate, instrumentAttributes }: InstrumentOperationParams): Promise<unknown>;
 /**
  * Decorator that instruments a class method
+ *
+ * @param meter - Name of OTel meter
  */
-declare function instrumented(meter: string, target: any, key: string, descriptor?: PropertyDescriptor): PropertyDescriptor | undefined;
-export { instrument, instrumented };
+declare function instrumented(meter: string): (target: any, key: string, descriptor?: PropertyDescriptor) => PropertyDescriptor | undefined;
+export { instrument, instrumented, type InstrumentOperationParams };

package/dist/instruments/instrument.js

@@ -17,7 +17,7 @@ const timer_1 = require("./timer");
  *
  * @param operationParams
  */
-function instrument({ meter, name, delegate }) {
+function instrument({ meter, name, delegate, instrumentAttributes }) {
     return __awaiter(this, void 0, void 0, function* () {
         const start = process.hrtime();
         try {
@@ -26,8 +26,8 @@ function instrument({ meter, name, delegate }) {
         catch (err) {
             (0, counter_1.incrementCounter)({
                 meter,
-                name: "function.errors",
-                counterAttributes: { function: name },
+                name: 'function.errors',
+                counterAttributes: Object.assign({ function: name }, instrumentAttributes),
             });
             throw err;
         }
@@ -36,9 +36,9 @@ function instrument({ meter, name, delegate }) {
             const elapsedNanos = elapsed[0] * 1000000000 + elapsed[1];
             (0, timer_1.recordTimer)({
                 meter,
-                name: "function.executionTime",
+                name: 'function.executionTime',
                 val: elapsedNanos,
-                timerAttributes: { function: name },
+                timerAttributes: Object.assign({ function: name }, instrumentAttributes),
             });
         }
     });
@@ -46,27 +46,31 @@ function instrument({ meter, name, delegate }) {
 exports.instrument = instrument;
 /**
  * Decorator that instruments a class method
+ *
+ * @param meter - Name of OTel meter
  */
-function instrumented(meter, target, key, descriptor) {
-    if (descriptor === undefined) {
-        descriptor = Object.getOwnPropertyDescriptor(target, key);
-    }
-    if (descriptor === undefined) {
+function instrumented(meter) {
+    return function (target, key, descriptor) {
+        if (descriptor === undefined) {
+            descriptor = Object.getOwnPropertyDescriptor(target, key);
+        }
+        if (descriptor === undefined) {
+            return descriptor;
+        }
+        const originalMethod = descriptor.value;
+        const klass = target.constructor.name;
+        // this needs to be a non-arrow function or we'll get the wrong `this`
+        function overrideMethod(...args) {
+            return instrument({
+                meter,
+                name: `${klass}.${key}`,
+                delegate: () => __awaiter(this, void 0, void 0, function* () {
+                    return yield originalMethod.apply(this, args);
+                }),
+            });
+        }
+        descriptor.value = overrideMethod;
         return descriptor;
-    }
-    const originalMethod = descriptor.value;
-    const klass = target.constructor.name;
-    // this needs to be a non-arrow function or we'll get the wrong `this`
-    function overrideMethod(...args) {
-        return instrument({
-            meter,
-            name: `${klass}.${key}`,
-            delegate: () => __awaiter(this, void 0, void 0, function* () {
-                return yield originalMethod.apply(this, args);
-            }),
-        });
-    }
-    descriptor.value = overrideMethod;
-    return descriptor;
+    };
 }
 exports.instrumented = instrumented;

package/dist/instruments/timer.d.ts

@@ -1,10 +1,15 @@
-import type { Attributes, MetricOptions } from "@opentelemetry/api";
-type OperationParams = {
+import type { Attributes, MetricOptions } from '@opentelemetry/api';
+type TimerOperationParams = {
+    /** OTel meter name */
     meter: string;
+    /** Metric name being instrumented */
     name: string;
+    /** Timer value to be recorded */
     val: number;
+    /** MetricOptions such as unit */
     timerOptions?: MetricOptions;
+    /** Metric Attributes in the form of key value pairs */
     timerAttributes?: Attributes;
 };
-declare const recordTimer: ({ meter, name, val, timerOptions, timerAttributes, }: OperationParams) => void;
-export { recordTimer };
+declare const recordTimer: ({ meter, name, val, timerOptions, timerAttributes }: TimerOperationParams) => void;
+export { recordTimer, type TimerOperationParams };

package/dist/instruments/timer.js

@@ -3,11 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.recordTimer = void 0;
 const meter_1 = require("../lib/meter");
 const timers = {};
-const recordTimer = ({ meter, name, val, timerOptions, timerAttributes, }) => {
+const recordTimer = ({ meter, name, val, timerOptions, timerAttributes }) => {
     let timer = timers[name];
     if (timer === undefined) {
         const _otelMeter = (0, meter_1.acquireMeter)(meter);
-        timer = timers[name] = _otelMeter.createHistogram(name, Object.assign(Object.assign({}, timerOptions), { unit: "ns" }));
+        timer = timers[name] = _otelMeter.createHistogram(name, Object.assign(Object.assign({}, timerOptions), { unit: 'ns' }));
     }
     timer.record(val, timerAttributes);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boxyhq/metrics",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Internal SDK for OTel instrumentation",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -9,12 +9,12 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "lint": "eslint -c .eslintrc.json --ext .ts ./"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/boxyhq/jackson.git",
-    "directory": "metrics"
+    "url": "git+https://github.com/boxyhq/metrics.git"
   },
   "keywords": [
     "otel",
@@ -22,9 +22,9 @@
   ],
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/boxyhq/jackson/issues"
+    "url": "https://github.com/boxyhq/metrics/issues"
   },
-  "homepage": "https://github.com/boxyhq/jackson#readme",
+  "homepage": "https://github.com/boxyhq/metrics#readme",
   "dependencies": {
     "@opentelemetry/api": "1.4.1",
     "@opentelemetry/exporter-metrics-otlp-grpc": "0.37.0",
@@ -37,7 +37,9 @@
     "@tsconfig/recommended": "1.0.2",
     "@typescript-eslint/eslint-plugin": "5.57.1",
     "@typescript-eslint/parser": "5.57.1",
-    "eslint": "8.37.0",
-    "typescript": "5.0.3"
+    "eslint": "8.38.0",
+    "eslint-config-prettier": "8.8.0",
+    "prettier": "2.8.7",
+    "typescript": "5.0.4"
   }
 }