chore: add flag to disable summary metric collection

rudderlabs · May 21, 2024 · 5774bf6 · 5774bf6
1 parent 397df55
commit 5774bf6
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 13 deletions.
diff --git a/src/util/prometheus.js b/src/util/prometheus.js
@@ -11,7 +11,7 @@ function appendPrefix(name) {
 }
 
 class Prometheus {
-  constructor() {
+  constructor(enableSummaryMetrics = true) {
     this.prometheusRegistry = new prometheusClient.Registry();
     this.prometheusRegistry.setDefaultLabels(defaultLabels);
     prometheusClient.collectDefaultMetrics({
@@ -21,7 +21,7 @@ class Prometheus {
     prometheusClient.AggregatorRegistry.setRegistries(this.prometheusRegistry);
     this.aggregatorRegistry = new prometheusClient.AggregatorRegistry();
 
-    this.createMetrics();
+    this.createMetrics(enableSummaryMetrics);
   }
 
   async metricsController(ctx) {
@@ -192,7 +192,7 @@ class Prometheus {
     }
   }
 
-  createMetrics() {
+  createMetrics(enableSummaryMetrics) {
     const metrics = [
       // Counters
       {
@@ -1121,14 +1121,16 @@ class Prometheus {
             metric.buckets,
           );
         } else if (metric.type === 'summary') {
-          this.newSummaryStat(
-            appendPrefix(metric.name),
-            metric.help,
-            metric.labelNames,
-            metric.percentiles,
-            metric.maxAge,
-            metric.ageBuckets,
-          );
+          if (enableSummaryMetrics) {
+            this.newSummaryStat(
+              appendPrefix(metric.name),
+              metric.help,
+              metric.labelNames,
+              metric.percentiles,
+              metric.maxAge,
+              metric.ageBuckets,
+            );
+          }
         } else {
           logger.error(
             `Prometheus: Metric creation failed. Name: ${metric.name}. Invalid type: ${metric.type}`,

diff --git a/src/util/stats.js b/src/util/stats.js
@@ -4,6 +4,8 @@ const logger = require('../logger');
 
 const enableStats = process.env.ENABLE_STATS !== 'false';
 const statsClientType = process.env.STATS_CLIENT || 'statsd';
+// summary metrics are enabled by default. To disable set ENABLE_SUMMARY_METRICS='false'.
+const enableSummaryMetrics = process.env.ENABLE_SUMMARY_METRICS !== 'false';
 
 let statsClient;
 function init() {
@@ -19,7 +21,7 @@ function init() {
 
     case 'prometheus':
       logger.info('setting up prometheus client');
-      statsClient = new prometheus.Prometheus();
+      statsClient = new prometheus.Prometheus(enableSummaryMetrics);
       break;
 
     default:
@@ -40,7 +42,7 @@ const timing = (name, start, tags = {}) => {
 
 // timingSummary is used to record observations for a summary metric
 const timingSummary = (name, start, tags = {}) => {
-  if (!enableStats || !statsClient) {
+  if (!enableStats || !statsClient || !enableSummaryMetrics) {
     return;
   }