feat: allow default metrics to be disabled

libp2p · Nov 20, 2022 · e839e97 · e839e97
1 parent ba33924
commit e839e97
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -19,9 +19,10 @@ export interface PrometheusMetricsInit {
   collectDefaultMetrics?: boolean
 
   /**
-   * prom-client options to pass to the `collectDefaultMetrics` function
+   * prom-client options to pass to the `collectDefaultMetrics` function.
+   * Set to `false` to disable `collectDefaultMetrics`.
    */
-  defaultMetrics?: DefaultMetricsCollectorConfiguration
+  defaultMetrics?: DefaultMetricsCollectorConfiguration | false
 
   /**
    * All metrics in prometheus are global so to prevent clashes in naming
@@ -40,9 +41,9 @@ class PrometheusMetrics implements Metrics {
       register.clear()
     }
 
-    if (init?.preserveExistingMetrics !== false) {
+    if (init?.preserveExistingMetrics !== false || init?.defaultMetrics === false) {
       log('Collecting default metrics')
-      collectDefaultMetrics(init?.defaultMetrics)
+      collectDefaultMetrics(init?.defaultMetrics as DefaultMetricsCollectorConfiguration)
     }
 
     // holds global and per-protocol sent/received stats