@promster/metrics 9.0.0 → 9.1.0

package/dist/declarations/src/create-request-recorder/create-request-recorder.d.ts

@@ -1,12 +1,14 @@
-import type { TPromsterOptions, TLabelValues, THttpMetrics, TRequestTiming } from '@promster/types';
+import type { TPromsterOptions, TLabelValues, THttpMetrics } from '@promster/types';
 import { sortLabels } from '../sort-labels';
 import { endMeasurementFrom } from '../end-measurement-from';
+import { Timing } from '../timing';
 declare type TRecordingOptions = {
     labels: TLabelValues;
     requestContentLength?: number;
     responseContentLength?: number;
 };
-export declare type TRequestRecorder = (start: TRequestTiming, recordingOptions: TRecordingOptions) => void;
+declare type TLegacyTiming = [number, number];
+export declare type TRequestRecorder = (timing: Timing | TLegacyTiming, recordingOptions: TRecordingOptions) => void;
 declare const createRequestRecorder: {
     (metrics: THttpMetrics, options?: TPromsterOptions): TRequestRecorder;
     defaultOptions: TPromsterOptions;

package/dist/declarations/src/end-measurement-from/end-measurement-from.d.ts

@@ -1,5 +1,4 @@
-import type { TRequestTiming } from '@promster/types';
-declare function endMeasurementFrom(start: TRequestTiming): {
+declare function endMeasurementFrom(start: [number, number]): {
     durationS: number;
 };
 export { endMeasurementFrom };

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

@@ -9,5 +9,7 @@ import { defaultNormalizers, normalizeStatusCode, normalizePath, normalizeMethod
 import { isRunningInKubernetes, skipMetricsInEnvironment } from './environment';
 import { endMeasurementFrom } from './end-measurement-from';
 import { sortLabels } from './sort-labels';
+import { timing } from './timing';
 export type { TRequestRecorder } from './create-request-recorder';
-export { Prometheus, defaultRegister, createHttpMetrics, createGraphQlMetrics, createGcMetrics, getSummary, getContentType, createRequestRecorder, createGcObserver, defaultNormalizers, normalizeStatusCode, normalizePath, normalizeMethod, isRunningInKubernetes, skipMetricsInEnvironment, endMeasurementFrom, sortLabels, };
+export type { Timing as TPromsterTiming } from './timing';
+export { Prometheus, defaultRegister, createHttpMetrics, createGraphQlMetrics, createGcMetrics, getSummary, getContentType, createRequestRecorder, createGcObserver, defaultNormalizers, normalizeStatusCode, normalizePath, normalizeMethod, isRunningInKubernetes, skipMetricsInEnvironment, endMeasurementFrom, sortLabels, timing, };

package/dist/declarations/src/timing/index.d.ts

@@ -0,0 +1,2 @@
+import timing, { Timing } from './timing';
+export { timing, Timing };

package/dist/declarations/src/timing/timing.d.ts

@@ -0,0 +1,15 @@
+declare class Timing {
+    #private;
+    static NS_PER_SEC: bigint;
+    constructor();
+    value(): {
+        seconds: number | 0n | undefined;
+    };
+    reset(): this;
+    end(): this;
+}
+declare const timing: {
+    start(): Timing;
+};
+export default timing;
+export { Timing };

package/dist/promster-metrics.cjs.dev.js

@@ -288,16 +288,18 @@ const defaultOptions$1 = {
   detectKubernetes: false
 };
 
+function isTiming(timing) {
+  return !Array.isArray(timing);
+}
+
 const createRequestRecorder = (metrics, options = defaultOptions$1) => {
   const defaultedRecorderOptions = merge__default["default"](defaultOptions$1, options);
   const shouldSkipMetricsByEnvironment = skipMetricsInEnvironment(defaultedRecorderOptions);
-  return (start, recordingOptions) => {
-    const {
-      durationS
-    } = endMeasurementFrom(start);
+  return (timing, recordingOptions) => {
+    const durationS = isTiming(timing) ? timing.end().value().seconds : endMeasurementFrom(timing).durationS;
     const labels = sortLabels(recordingOptions.labels);
 
-    if (!shouldSkipMetricsByEnvironment) {
+    if (!shouldSkipMetricsByEnvironment && durationS !== undefined) {
       var _metrics$httpRequestD;
 
       (_metrics$httpRequestD = metrics.httpRequestDurationInSeconds) === null || _metrics$httpRequestD === void 0 ? void 0 : _metrics$httpRequestD.forEach(httpRequestDurationInSecondsMetricType => {
@@ -305,7 +307,7 @@ const createRequestRecorder = (metrics, options = defaultOptions$1) => {
       });
     }
 
-    if (!shouldSkipMetricsByEnvironment) {
+    if (!shouldSkipMetricsByEnvironment && durationS !== undefined) {
       var _metrics$httpRequestD2;
 
       (_metrics$httpRequestD2 = metrics.httpRequestDurationPerPercentileInSeconds) === null || _metrics$httpRequestD2 === void 0 ? void 0 : _metrics$httpRequestD2.forEach(httpRequestDurationPerPercentileInSecondsMetricType => {
@@ -313,7 +315,7 @@ const createRequestRecorder = (metrics, options = defaultOptions$1) => {
       });
     }
 
-    if (!shouldSkipMetricsByEnvironment) {
+    if (!shouldSkipMetricsByEnvironment && durationS !== undefined) {
       var _metrics$httpRequests;
 
       (_metrics$httpRequests = metrics.httpRequestsTotal) === null || _metrics$httpRequests === void 0 ? void 0 : _metrics$httpRequests.forEach(httpRequestsTotalMetricType => {
@@ -394,6 +396,125 @@ const defaultNormalizers = {
   normalizeMethod
 };
 
+function _checkPrivateRedeclaration(obj, privateCollection) {
+  if (privateCollection.has(obj)) {
+    throw new TypeError("Cannot initialize the same private elements twice on an object");
+  }
+}
+
+function _classPrivateFieldInitSpec(obj, privateMap, value) {
+  _checkPrivateRedeclaration(obj, privateMap);
+  privateMap.set(obj, value);
+}
+
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+
+  return obj;
+}
+
+function _classApplyDescriptorSet(receiver, descriptor, value) {
+  if (descriptor.set) {
+    descriptor.set.call(receiver, value);
+  } else {
+    if (!descriptor.writable) {
+      throw new TypeError("attempted to set read only private field");
+    }
+
+    descriptor.value = value;
+  }
+}
+
+function _classExtractFieldDescriptor(receiver, privateMap, action) {
+  if (!privateMap.has(receiver)) {
+    throw new TypeError("attempted to " + action + " private field on non-instance");
+  }
+
+  return privateMap.get(receiver);
+}
+
+function _classPrivateFieldSet(receiver, privateMap, value) {
+  var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set");
+  _classApplyDescriptorSet(receiver, descriptor, value);
+  return value;
+}
+
+function _classApplyDescriptorGet(receiver, descriptor) {
+  if (descriptor.get) {
+    return descriptor.get.call(receiver);
+  }
+
+  return descriptor.value;
+}
+
+function _classPrivateFieldGet(receiver, privateMap) {
+  var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get");
+  return _classApplyDescriptorGet(receiver, descriptor);
+}
+
+var _startTime = /*#__PURE__*/new WeakMap();
+
+var _endTime = /*#__PURE__*/new WeakMap();
+
+class Timing {
+  constructor() {
+    _classPrivateFieldInitSpec(this, _startTime, {
+      writable: true,
+      value: void 0
+    });
+
+    _classPrivateFieldInitSpec(this, _endTime, {
+      writable: true,
+      value: void 0
+    });
+
+    this.reset();
+  }
+
+  value() {
+    const startTime = _classPrivateFieldGet(this, _startTime);
+
+    const endTime = _classPrivateFieldGet(this, _endTime);
+
+    return {
+      seconds: endTime && startTime && Number((endTime - startTime) / Timing.NS_PER_SEC)
+    };
+  }
+
+  reset() {
+    _classPrivateFieldSet(this, _startTime, process.hrtime.bigint());
+
+    _classPrivateFieldSet(this, _endTime, undefined);
+
+    return this;
+  }
+
+  end() {
+    _classPrivateFieldSet(this, _endTime, process.hrtime.bigint());
+
+    return this;
+  }
+
+}
+
+_defineProperty(Timing, "NS_PER_SEC", BigInt(1e9));
+
+const timing = {
+  start() {
+    return new Timing();
+  }
+
+};
+
 exports.Prometheus = Prometheus__namespace;
 exports.createGcMetrics = createGcMetrics;
 exports.createGcObserver = createGcObserver;
@@ -411,3 +532,4 @@ exports.normalizePath = normalizePath;
 exports.normalizeStatusCode = normalizeStatusCode;
 exports.skipMetricsInEnvironment = skipMetricsInEnvironment;
 exports.sortLabels = sortLabels;
+exports.timing = timing;

package/dist/promster-metrics.cjs.prod.js

@@ -288,16 +288,18 @@ const defaultOptions$1 = {
   detectKubernetes: false
 };
 
+function isTiming(timing) {
+  return !Array.isArray(timing);
+}
+
 const createRequestRecorder = (metrics, options = defaultOptions$1) => {
   const defaultedRecorderOptions = merge__default["default"](defaultOptions$1, options);
   const shouldSkipMetricsByEnvironment = skipMetricsInEnvironment(defaultedRecorderOptions);
-  return (start, recordingOptions) => {
-    const {
-      durationS
-    } = endMeasurementFrom(start);
+  return (timing, recordingOptions) => {
+    const durationS = isTiming(timing) ? timing.end().value().seconds : endMeasurementFrom(timing).durationS;
     const labels = sortLabels(recordingOptions.labels);
 
-    if (!shouldSkipMetricsByEnvironment) {
+    if (!shouldSkipMetricsByEnvironment && durationS !== undefined) {
       var _metrics$httpRequestD;
 
       (_metrics$httpRequestD = metrics.httpRequestDurationInSeconds) === null || _metrics$httpRequestD === void 0 ? void 0 : _metrics$httpRequestD.forEach(httpRequestDurationInSecondsMetricType => {
@@ -305,7 +307,7 @@ const createRequestRecorder = (metrics, options = defaultOptions$1) => {
       });
     }
 
-    if (!shouldSkipMetricsByEnvironment) {
+    if (!shouldSkipMetricsByEnvironment && durationS !== undefined) {
       var _metrics$httpRequestD2;
 
       (_metrics$httpRequestD2 = metrics.httpRequestDurationPerPercentileInSeconds) === null || _metrics$httpRequestD2 === void 0 ? void 0 : _metrics$httpRequestD2.forEach(httpRequestDurationPerPercentileInSecondsMetricType => {
@@ -313,7 +315,7 @@ const createRequestRecorder = (metrics, options = defaultOptions$1) => {
       });
     }
 
-    if (!shouldSkipMetricsByEnvironment) {
+    if (!shouldSkipMetricsByEnvironment && durationS !== undefined) {
       var _metrics$httpRequests;
 
       (_metrics$httpRequests = metrics.httpRequestsTotal) === null || _metrics$httpRequests === void 0 ? void 0 : _metrics$httpRequests.forEach(httpRequestsTotalMetricType => {
@@ -394,6 +396,125 @@ const defaultNormalizers = {
   normalizeMethod
 };
 
+function _checkPrivateRedeclaration(obj, privateCollection) {
+  if (privateCollection.has(obj)) {
+    throw new TypeError("Cannot initialize the same private elements twice on an object");
+  }
+}
+
+function _classPrivateFieldInitSpec(obj, privateMap, value) {
+  _checkPrivateRedeclaration(obj, privateMap);
+  privateMap.set(obj, value);
+}
+
+function _defineProperty(obj, key, value) {
+  if (key in obj) {
+    Object.defineProperty(obj, key, {
+      value: value,
+      enumerable: true,
+      configurable: true,
+      writable: true
+    });
+  } else {
+    obj[key] = value;
+  }
+
+  return obj;
+}
+
+function _classApplyDescriptorSet(receiver, descriptor, value) {
+  if (descriptor.set) {
+    descriptor.set.call(receiver, value);
+  } else {
+    if (!descriptor.writable) {
+      throw new TypeError("attempted to set read only private field");
+    }
+
+    descriptor.value = value;
+  }
+}
+
+function _classExtractFieldDescriptor(receiver, privateMap, action) {
+  if (!privateMap.has(receiver)) {
+    throw new TypeError("attempted to " + action + " private field on non-instance");
+  }
+
+  return privateMap.get(receiver);
+}
+
+function _classPrivateFieldSet(receiver, privateMap, value) {
+  var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "set");
+  _classApplyDescriptorSet(receiver, descriptor, value);
+  return value;
+}
+
+function _classApplyDescriptorGet(receiver, descriptor) {
+  if (descriptor.get) {
+    return descriptor.get.call(receiver);
+  }
+
+  return descriptor.value;
+}
+
+function _classPrivateFieldGet(receiver, privateMap) {
+  var descriptor = _classExtractFieldDescriptor(receiver, privateMap, "get");
+  return _classApplyDescriptorGet(receiver, descriptor);
+}
+
+var _startTime = /*#__PURE__*/new WeakMap();
+
+var _endTime = /*#__PURE__*/new WeakMap();
+
+class Timing {
+  constructor() {
+    _classPrivateFieldInitSpec(this, _startTime, {
+      writable: true,
+      value: void 0
+    });
+
+    _classPrivateFieldInitSpec(this, _endTime, {
+      writable: true,
+      value: void 0
+    });
+
+    this.reset();
+  }
+
+  value() {
+    const startTime = _classPrivateFieldGet(this, _startTime);
+
+    const endTime = _classPrivateFieldGet(this, _endTime);
+
+    return {
+      seconds: endTime && startTime && Number((endTime - startTime) / Timing.NS_PER_SEC)
+    };
+  }
+
+  reset() {
+    _classPrivateFieldSet(this, _startTime, process.hrtime.bigint());
+
+    _classPrivateFieldSet(this, _endTime, undefined);
+
+    return this;
+  }
+
+  end() {
+    _classPrivateFieldSet(this, _endTime, process.hrtime.bigint());
+
+    return this;
+  }
+
+}
+
+_defineProperty(Timing, "NS_PER_SEC", BigInt(1e9));
+
+const timing = {
+  start() {
+    return new Timing();
+  }
+
+};
+
 exports.Prometheus = Prometheus__namespace;
 exports.createGcMetrics = createGcMetrics;
 exports.createGcObserver = createGcObserver;
@@ -411,3 +532,4 @@ exports.normalizePath = normalizePath;
 exports.normalizeStatusCode = normalizeStatusCode;
 exports.skipMetricsInEnvironment = skipMetricsInEnvironment;
 exports.sortLabels = sortLabels;
+exports.timing = timing;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promster/metrics",
-  "version": "9.0.0",
+  "version": "9.1.0",
   "description": "Metrics utilities used by all other server integrations",
   "main": "dist/promster-metrics.cjs.js",
   "typings": "dist/promster-metrics.cjs.d.ts",
@@ -46,7 +46,7 @@
     "url-value-parser": "2.0.3"
   },
   "devDependencies": {
-    "@promster/types": "^3.2.0",
+    "@promster/types": "^3.2.1",
     "@types/lodash": "4.14.176",
     "prom-client": "14.0.1",
     "typescript": "4.4.4"