Add metrics for GC duration

Issue: BB-447
scality · Nov 22, 2023 · 94e19de · 94e19de
1 parent 42c0b28
commit 94e19de
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/extensions/gc/GarbageCollectorMetrics.js b/extensions/gc/GarbageCollectorMetrics.js
@@ -14,6 +14,14 @@ const gcS3Operations = ZenkoMetrics.createCounter({
     ],
 });
 
+const gcDuration = ZenkoMetrics.createHistogram({
+    name: 's3_gc_duration_seconds',
+    help: 'Duration of the garbage collector operation, calculated from the time when the GC is ' +
+        'requested to the end of the operation',
+    labelNames: [GC_LABEL_ORIGIN],
+    buckets: [0.2, 0.1, 0.5, 2.5, 10, 50],
+});
+
 class GarbageCollectorMetrics {
     static handleError(log, err, method) {
         if (log) {
@@ -33,6 +41,16 @@ class GarbageCollectorMetrics {
             GarbageCollectorMetrics.handleError(log, err, 'GarbageCollectorMetrics.onS3Request');
         }
     }
+
+    static onGcCompleted(log, process, duration) {
+        try {
+            gcDuration.observe({
+                [GC_LABEL_ORIGIN]: process,
+            }, duration / 1000);
+        } catch (err) {
+            GarbageCollectorMetrics.handleError(log, err, 'GarbageCollectorMetrics.onGcComplete');
+        }
+    }
 }
 
 module.exports = {

diff --git a/extensions/gc/tasks/GarbageCollectorTask.js b/extensions/gc/tasks/GarbageCollectorTask.js
@@ -176,6 +176,9 @@ class GarbageCollectorTask extends BackbeatTask {
                     }, entry.getLogInfo()));
                 return done(err);
             }
+
+            GarbageCollectorMetrics.onGcCompleted(log, entry.ruleType,
+                Date.now() - entry.timestamp);
             return done();
         });
     }
@@ -254,6 +257,8 @@ class GarbageCollectorTask extends BackbeatTask {
                     if (!err) {
                         log.end().info('completed expiration of archived data',
                             entry.getLogInfo());
+                        GarbageCollectorMetrics.onGcCompleted(log, 'archive',
+                            Date.now() - entry.timestamp);
                     }
 
                     next(err);