@libp2p/prometheus-metrics 4.3.9 → 4.3.10

package/dist/src/counter-group.js

@@ -1,13 +1,13 @@
 import { Counter as PromCounter } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusCounterGroup {
     counter;
     label;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const label = this.label = normaliseString(opts.label ?? name);
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const label = this.label = normalizeString(opts.label ?? name);
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/counter.js

@@ -1,12 +1,12 @@
 import { Counter as PromCounter } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusCounter {
     counter;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const labels = opts.label != null ? [normaliseString(opts.label)] : [];
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const labels = opts.label != null ? [normalizeString(opts.label)] : [];
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/histogram-group.js

@@ -1,13 +1,13 @@
 import { Histogram as PromHistogram } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusHistogramGroup {
     histogram;
     label;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const label = this.label = normaliseString(opts.label ?? name);
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const label = this.label = normalizeString(opts.label ?? name);
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/histogram.js

@@ -1,12 +1,12 @@
 import { Histogram as PromHistogram } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusHistogram {
     histogram;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const labels = opts.label != null ? [normaliseString(opts.label)] : [];
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const labels = opts.label != null ? [normalizeString(opts.label)] : [];
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/metric-group.js

@@ -1,13 +1,13 @@
 import { Gauge } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusMetricGroup {
     gauge;
     label;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const label = this.label = normaliseString(opts.label ?? name);
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const label = this.label = normalizeString(opts.label ?? name);
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/metric.js

@@ -1,12 +1,12 @@
 import { Gauge } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusMetric {
     gauge;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const labels = opts.label != null ? [normaliseString(opts.label)] : [];
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const labels = opts.label != null ? [normalizeString(opts.label)] : [];
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/summary-group.js

@@ -1,13 +1,13 @@
 import { Summary as PromSummary } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusSummaryGroup {
     summary;
     label;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const label = this.label = normaliseString(opts.label ?? name);
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const label = this.label = normalizeString(opts.label ?? name);
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/summary.js

@@ -1,12 +1,12 @@
 import { Summary as PromSummary } from 'prom-client';
-import { normaliseString } from './utils.js';
+import { normalizeString } from './utils.js';
 export class PrometheusSummary {
     summary;
     calculators;
     constructor(name, opts) {
-        name = normaliseString(name);
-        const help = normaliseString(opts.help ?? name);
-        const labels = opts.label != null ? [normaliseString(opts.label)] : [];
+        name = normalizeString(name);
+        const help = normalizeString(opts.help ?? name);
+        const labels = opts.label != null ? [normalizeString(opts.label)] : [];
         let collect;
         this.calculators = [];
         // calculated metric

package/dist/src/utils.d.ts

@@ -8,5 +8,5 @@ export declare const ONE_MINUTE: number;
  * See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
  * for rules on valid naming
  */
-export declare function normaliseString(str: string): string;
+export declare function normalizeString(str: string): string;
 //# sourceMappingURL=utils.d.ts.map

package/dist/src/utils.js

@@ -4,7 +4,7 @@ export const ONE_MINUTE = 60 * ONE_SECOND;
  * See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
  * for rules on valid naming
  */
-export function normaliseString(str) {
+export function normalizeString(str) {
     return str
         .replace(/[^a-zA-Z0-9_]/g, '_')
         .replace(/_+/g, '_');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libp2p/prometheus-metrics",
-  "version": "4.3.9",
+  "version": "4.3.10",
   "description": "Collect libp2p metrics for scraping by Prometheus or Graphana",
   "author": "",
   "license": "Apache-2.0 OR MIT",
@@ -48,19 +48,19 @@
     "test:electron-main": "aegir test -t electron-main --cov"
   },
   "dependencies": {
-    "@libp2p/interface": "^2.6.0",
+    "@libp2p/interface": "^2.6.1",
     "it-foreach": "^2.1.1",
     "it-stream-types": "^2.0.2",
     "prom-client": "^15.1.3",
     "uint8arraylist": "^2.4.8"
   },
   "devDependencies": {
-    "@libp2p/crypto": "^5.0.12",
-    "@libp2p/interface-compliance-tests": "^6.3.4",
-    "@libp2p/logger": "^5.1.9",
-    "@libp2p/peer-id": "^5.0.13",
+    "@libp2p/crypto": "^5.0.13",
+    "@libp2p/interface-compliance-tests": "^6.3.5",
+    "@libp2p/logger": "^5.1.10",
+    "@libp2p/peer-id": "^5.0.14",
     "@multiformats/multiaddr": "^12.3.3",
-    "aegir": "^45.0.5",
+    "aegir": "^45.1.1",
     "it-drain": "^3.0.7",
     "it-pipe": "^3.0.1",
     "p-defer": "^4.0.1"

package/src/counter-group.ts

@@ -1,5 +1,5 @@
 import { Counter as PromCounter, type CollectFunction } from 'prom-client'
-import { normaliseString, type CalculatedMetric } from './utils.js'
+import { normalizeString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedMetricOptions } from './index.js'
 import type { CounterGroup, CalculateMetric } from '@libp2p/interface'
 
@@ -9,9 +9,9 @@ export class PrometheusCounterGroup implements CounterGroup, CalculatedMetric<Re
   private readonly calculators: Array<CalculateMetric<Record<string, number>>>
 
   constructor (name: string, opts: PrometheusCalculatedMetricOptions<Record<string, number>>) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const label = this.label = normaliseString(opts.label ?? name)
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const label = this.label = normalizeString(opts.label ?? name)
     let collect: CollectFunction<PromCounter<any>> | undefined
     this.calculators = []
 

package/src/counter.ts

@@ -1,5 +1,5 @@
 import { type CollectFunction, Counter as PromCounter } from 'prom-client'
-import { normaliseString, type CalculatedMetric } from './utils.js'
+import { normalizeString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedMetricOptions } from './index.js'
 import type { CalculateMetric, Counter } from '@libp2p/interface'
 
@@ -8,9 +8,9 @@ export class PrometheusCounter implements Counter, CalculatedMetric {
   private readonly calculators: CalculateMetric[]
 
   constructor (name: string, opts: PrometheusCalculatedMetricOptions) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const labels = opts.label != null ? [normaliseString(opts.label)] : []
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const labels = opts.label != null ? [normalizeString(opts.label)] : []
     let collect: CollectFunction<PromCounter<any>> | undefined
     this.calculators = []
 

package/src/histogram-group.ts

@@ -1,5 +1,5 @@
 import { type CollectFunction, Histogram as PromHistogram } from 'prom-client'
-import { normaliseString, type CalculatedMetric } from './utils.js'
+import { normalizeString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedHistogramOptions } from './index.js'
 import type { CalculateMetric, HistogramGroup, StopTimer } from '@libp2p/interface'
 
@@ -9,9 +9,9 @@ export class PrometheusHistogramGroup implements HistogramGroup, CalculatedMetri
   private readonly calculators: Array<CalculateMetric<Record<string, number>>>
 
   constructor (name: string, opts: PrometheusCalculatedHistogramOptions<Record<string, number>>) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const label = this.label = normaliseString(opts.label ?? name)
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const label = this.label = normalizeString(opts.label ?? name)
     let collect: CollectFunction<PromHistogram<any>> | undefined
     this.calculators = []
 

package/src/histogram.ts

@@ -1,5 +1,5 @@
 import { type CollectFunction, Histogram as PromHistogram } from 'prom-client'
-import { normaliseString } from './utils.js'
+import { normalizeString } from './utils.js'
 import type { PrometheusCalculatedHistogramOptions } from './index.js'
 import type { StopTimer, CalculateMetric, Histogram } from '@libp2p/interface'
 
@@ -8,9 +8,9 @@ export class PrometheusHistogram implements Histogram {
   private readonly calculators: CalculateMetric[]
 
   constructor (name: string, opts: PrometheusCalculatedHistogramOptions) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const labels = opts.label != null ? [normaliseString(opts.label)] : []
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const labels = opts.label != null ? [normalizeString(opts.label)] : []
     let collect: CollectFunction<PromHistogram<any>> | undefined
     this.calculators = []
 

package/src/metric-group.ts

@@ -1,5 +1,5 @@
 import { type CollectFunction, Gauge } from 'prom-client'
-import { normaliseString, type CalculatedMetric } from './utils.js'
+import { normalizeString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedMetricOptions } from './index.js'
 import type { CalculateMetric, MetricGroup, StopTimer } from '@libp2p/interface'
 
@@ -9,9 +9,9 @@ export class PrometheusMetricGroup implements MetricGroup, CalculatedMetric<Reco
   private readonly calculators: Array<CalculateMetric<Record<string, number>>>
 
   constructor (name: string, opts: PrometheusCalculatedMetricOptions<Record<string, number>>) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const label = this.label = normaliseString(opts.label ?? name)
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const label = this.label = normalizeString(opts.label ?? name)
     let collect: CollectFunction<Gauge<any>> | undefined
     this.calculators = []
 

package/src/metric.ts

@@ -1,5 +1,5 @@
 import { type CollectFunction, Gauge } from 'prom-client'
-import { normaliseString } from './utils.js'
+import { normalizeString } from './utils.js'
 import type { PrometheusCalculatedMetricOptions } from './index.js'
 import type { Metric, StopTimer, CalculateMetric } from '@libp2p/interface'
 
@@ -8,9 +8,9 @@ export class PrometheusMetric implements Metric {
   private readonly calculators: CalculateMetric[]
 
   constructor (name: string, opts: PrometheusCalculatedMetricOptions) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const labels = opts.label != null ? [normaliseString(opts.label)] : []
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const labels = opts.label != null ? [normalizeString(opts.label)] : []
     let collect: CollectFunction<Gauge<any>> | undefined
     this.calculators = []
 

package/src/summary-group.ts

@@ -1,5 +1,5 @@
 import { type CollectFunction, Summary as PromSummary } from 'prom-client'
-import { normaliseString, type CalculatedMetric } from './utils.js'
+import { normalizeString, type CalculatedMetric } from './utils.js'
 import type { PrometheusCalculatedSummaryOptions } from './index.js'
 import type { CalculateMetric, SummaryGroup, StopTimer } from '@libp2p/interface'
 
@@ -9,9 +9,9 @@ export class PrometheusSummaryGroup implements SummaryGroup, CalculatedMetric<Re
   private readonly calculators: Array<CalculateMetric<Record<string, number>>>
 
   constructor (name: string, opts: PrometheusCalculatedSummaryOptions<Record<string, number>>) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const label = this.label = normaliseString(opts.label ?? name)
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const label = this.label = normalizeString(opts.label ?? name)
     let collect: CollectFunction<PromSummary<any>> | undefined
     this.calculators = []
 

package/src/summary.ts

@@ -1,5 +1,5 @@
 import { type CollectFunction, Summary as PromSummary } from 'prom-client'
-import { normaliseString } from './utils.js'
+import { normalizeString } from './utils.js'
 import type { PrometheusCalculatedSummaryOptions } from './index.js'
 import type { StopTimer, CalculateMetric, Summary } from '@libp2p/interface'
 
@@ -8,9 +8,9 @@ export class PrometheusSummary implements Summary {
   private readonly calculators: CalculateMetric[]
 
   constructor (name: string, opts: PrometheusCalculatedSummaryOptions) {
-    name = normaliseString(name)
-    const help = normaliseString(opts.help ?? name)
-    const labels = opts.label != null ? [normaliseString(opts.label)] : []
+    name = normalizeString(name)
+    const help = normalizeString(opts.help ?? name)
+    const labels = opts.label != null ? [normalizeString(opts.label)] : []
     let collect: CollectFunction<PromSummary<any>> | undefined
     this.calculators = []
 

package/src/utils.ts

@@ -11,7 +11,7 @@ export const ONE_MINUTE = 60 * ONE_SECOND
  * See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
  * for rules on valid naming
  */
-export function normaliseString (str: string): string {
+export function normalizeString (str: string): string {
   return str
     .replace(/[^a-zA-Z0-9_]/g, '_')
     .replace(/_+/g, '_')