@promster/metrics 7.0.1 → 8.0.0

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

@@ -70,6 +70,8 @@ const shouldObserveHttpRequestsAsHistogram = options => options.metricTypes.incl
 
 const shouldObserveHttpRequestsAsCounter = options => options.metricTypes.includes('httpRequestsTotal');
 
+const shouldObserveHttpContentLengthAsHistogram = options => options.metricTypes.includes('httpContentLengthHistogram');
+
 const defaultOptions$1 = {
   getLabelValues: () => ({}),
   labels: [],
@@ -111,13 +113,13 @@ const getDefaultMetrics = options => ({
     help: 'Total number of bytes reclaimed by GC.',
     labelNames: defaultGcLabels
   })),
-  httpRequestContentLengthInBytes: asArray(options.metricNames.httpRequestContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
+  httpRequestContentLengthInBytes: shouldObserveHttpContentLengthAsHistogram(options) && asArray(options.metricNames.httpRequestContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
     name: `${options.metricPrefix}${nameOfHttpContentLengthMetric}`,
     help: 'The HTTP request content length in bytes.',
     labelNames: defaultRequestLabels.concat(options.labels).sort(),
     buckets: options.buckets || defaultHttpContentLengthInBytes
   })),
-  httpResponseContentLengthInBytes: asArray(options.metricNames.httpResponseContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
+  httpResponseContentLengthInBytes: shouldObserveHttpContentLengthAsHistogram(options) && asArray(options.metricNames.httpResponseContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
     name: `${options.metricPrefix}${nameOfHttpContentLengthMetric}`,
     help: 'The HTTP response content length in bytes.',
     labelNames: defaultRequestLabels.concat(options.labels).sort(),
@@ -234,6 +236,8 @@ const createRequestRecorder = (metricTypes, options = defaultOptions) => {
   const shouldObserveInSummary = shouldObserveMetricType('httpRequestsSummary')(defaultedRecorderOptions);
   const shouldObserveInHistogram = shouldObserveMetricType('httpRequestsHistogram')(defaultedRecorderOptions);
   const shouldObserveInCounter = shouldObserveMetricType('httpRequestsTotal')(defaultedRecorderOptions);
+  const shouldObserveContentLengthInHistogram = shouldObserveMetricType('httpContentLengthHistogram')(defaultedRecorderOptions); // eslint-disable-next-line complexity
+
   return (start, recordingOptions) => {
     const {
       durationMs,
@@ -271,14 +275,14 @@ const createRequestRecorder = (metricTypes, options = defaultOptions) => {
       });
     }
 
-    if (metricTypes.httpRequestContentLengthInBytes && recordingOptions.requestContentLength) {
+    if (!shouldSkipMetricsByEnvironment && shouldObserveContentLengthInHistogram && recordingOptions.requestContentLength) {
       metricTypes.httpRequestContentLengthInBytes.forEach(httpRequestContentLengthInBytesMetricType => {
         httpRequestContentLengthInBytesMetricType.observe(labels, // @ts-expect-error
         recordingOptions.requestContentLength);
       });
     }
 
-    if (metricTypes.httpResponseContentLengthInBytes && recordingOptions.responseContentLength) {
+    if (!shouldSkipMetricsByEnvironment && shouldObserveContentLengthInHistogram && recordingOptions.responseContentLength) {
       metricTypes.httpResponseContentLengthInBytes.forEach(httpResponseContentLengthInBytesMetricType => {
         httpResponseContentLengthInBytesMetricType.observe(labels, // @ts-expect-error
         recordingOptions.responseContentLength);

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

@@ -70,6 +70,8 @@ const shouldObserveHttpRequestsAsHistogram = options => options.metricTypes.incl
 
 const shouldObserveHttpRequestsAsCounter = options => options.metricTypes.includes('httpRequestsTotal');
 
+const shouldObserveHttpContentLengthAsHistogram = options => options.metricTypes.includes('httpContentLengthHistogram');
+
 const defaultOptions$1 = {
   getLabelValues: () => ({}),
   labels: [],
@@ -111,13 +113,13 @@ const getDefaultMetrics = options => ({
     help: 'Total number of bytes reclaimed by GC.',
     labelNames: defaultGcLabels
   })),
-  httpRequestContentLengthInBytes: asArray(options.metricNames.httpRequestContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
+  httpRequestContentLengthInBytes: shouldObserveHttpContentLengthAsHistogram(options) && asArray(options.metricNames.httpRequestContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
     name: `${options.metricPrefix}${nameOfHttpContentLengthMetric}`,
     help: 'The HTTP request content length in bytes.',
     labelNames: defaultRequestLabels.concat(options.labels).sort(),
     buckets: options.buckets || defaultHttpContentLengthInBytes
   })),
-  httpResponseContentLengthInBytes: asArray(options.metricNames.httpResponseContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
+  httpResponseContentLengthInBytes: shouldObserveHttpContentLengthAsHistogram(options) && asArray(options.metricNames.httpResponseContentLengthInBytes).map(nameOfHttpContentLengthMetric => new Prometheus__namespace.Histogram({
     name: `${options.metricPrefix}${nameOfHttpContentLengthMetric}`,
     help: 'The HTTP response content length in bytes.',
     labelNames: defaultRequestLabels.concat(options.labels).sort(),
@@ -234,6 +236,8 @@ const createRequestRecorder = (metricTypes, options = defaultOptions) => {
   const shouldObserveInSummary = shouldObserveMetricType('httpRequestsSummary')(defaultedRecorderOptions);
   const shouldObserveInHistogram = shouldObserveMetricType('httpRequestsHistogram')(defaultedRecorderOptions);
   const shouldObserveInCounter = shouldObserveMetricType('httpRequestsTotal')(defaultedRecorderOptions);
+  const shouldObserveContentLengthInHistogram = shouldObserveMetricType('httpContentLengthHistogram')(defaultedRecorderOptions); // eslint-disable-next-line complexity
+
   return (start, recordingOptions) => {
     const {
       durationMs,
@@ -271,14 +275,14 @@ const createRequestRecorder = (metricTypes, options = defaultOptions) => {
       });
     }
 
-    if (metricTypes.httpRequestContentLengthInBytes && recordingOptions.requestContentLength) {
+    if (!shouldSkipMetricsByEnvironment && shouldObserveContentLengthInHistogram && recordingOptions.requestContentLength) {
       metricTypes.httpRequestContentLengthInBytes.forEach(httpRequestContentLengthInBytesMetricType => {
         httpRequestContentLengthInBytesMetricType.observe(labels, // @ts-expect-error
         recordingOptions.requestContentLength);
       });
     }
 
-    if (metricTypes.httpResponseContentLengthInBytes && recordingOptions.responseContentLength) {
+    if (!shouldSkipMetricsByEnvironment && shouldObserveContentLengthInHistogram && recordingOptions.responseContentLength) {
       metricTypes.httpResponseContentLengthInBytes.forEach(httpResponseContentLengthInBytesMetricType => {
         httpResponseContentLengthInBytesMetricType.observe(labels, // @ts-expect-error
         recordingOptions.responseContentLength);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@promster/metrics",
-  "version": "7.0.1",
+  "version": "8.0.0",
   "description": "Metrics utilities used by all other server integrations",
   "main": "dist/promster-metrics.cjs.js",
   "typings": "dist/promster-metrics.cjs.d.ts",
@@ -17,8 +17,8 @@
     "access": "public"
   },
   "engines": {
-    "node": ">=9",
-    "npm": ">=3"
+    "node": ">=14",
+    "npm": ">=6"
   },
   "repository": {
     "type": "git",
@@ -40,20 +40,21 @@
     "lodash.once": "4.1.1",
     "merge-options": "3.0.4",
     "optional": "0.1.4",
-    "ts-essentials": "8.1.0",
+    "ts-essentials": "9.0.0",
     "tslib": "2.3.1",
     "url": "0.11.0",
     "url-value-parser": "2.0.3"
   },
   "devDependencies": {
-    "@promster/types": "^3.1.1",
-    "@types/lodash": "4.14.175",
-    "prom-client": "13.2.0"
+    "@promster/types": "^3.1.5",
+    "@types/lodash": "4.14.176",
+    "prom-client": "14.0.0",
+    "typescript": "4.4.4"
   },
   "optionalDependencies": {
-    "@sematext/gc-stats": "1.5.4"
+    "@sematext/gc-stats": "1.5.5"
   },
   "peerDependencies": {
-    "prom-client": "13.x.x"
+    "prom-client": "13.x.x || 14.x"
   }
 }