396 - fix message logs

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 0.65.3
 Release 2020-03-dd
 
+- Fix noisy message logs while checking analyses' limits.
 - Fix CI setup, explicit use of PGPORT while creating the PostgreSQL cluster.
 
 ## 0.65.2

lib/limits/context.js

@@ -13,10 +13,12 @@ function LimitsContext(databaseService, limits, logger) {
 }
 
 // Log analysis limits error information
-LimitsContext.prototype.logError = function(err) {
-    if (this.logger) {
-        this.logger.logLimitsError(err);
+LimitsContext.prototype.logError = function(err, node) {
+    if (!this.logger) {
+        return;
     }
+
+    this.logger.logLimitsError(err, node);
 };
 
 // Execute SQL in the database

lib/logging/logger.js

@@ -36,10 +36,18 @@ AnalysisLogger.prototype.log = function (analysis) {
         });
 };
 
-AnalysisLogger.prototype.logLimitsError = function (err) {
-    if (err) {
-        this.logger.info({ 'error-message': err.message, 'error-code': err.code }, 'analysis:limits_error');
-    }
+AnalysisLogger.prototype.logLimitsError = function (err, node) {
+    const msg = 'analysis:limits_error';
+    const info = {
+        'error-message': err.message,
+        'error-code': err.code,
+        node: node.id(),
+        type: node.getType(),
+        queued: node.didQueueWork(),
+        username: node.getOwner()
+    };
+
+    this.logger.info(info, msg);
 };
 
 AnalysisLogger.prototype.reopenFileStreams = function () {

lib/node/limits.js

@@ -7,13 +7,13 @@ var estimates = require('../limits/estimates');
 
 function limitNumberOfRows(node, context, limit, callback) {
     if (!Number.isFinite(limit.value)) {
-        context.logError('Limit for number of rows is not defined');
+        context.logError(new Error('Limit for number of rows is not defined'), node);
         return callback(null);
     }
     estimates.estimatedNumberOfRows(node, context, function(err, outputRows) {
         if (err) {
             // if estimation is not available don't abort the analysis
-            context.logError(err);
+            context.logError(err, node);
             err = null;
         } else {
             if (outputRows > limit.value) {
@@ -26,12 +26,12 @@ function limitNumberOfRows(node, context, limit, callback) {
 
 function limitInputRows(node, input, context, limit, callback) {
     if (!Number.isFinite(limit.value)) {
-        context.logError('Limit for input rows is not defined');
+        context.logError(new Error('Limit for input rows is not defined'), node);
         return callback(null);
     }
     estimates.estimatedNumberOfRows(node[input], context, function(err, numRows) {
         if (err) {
-            context.logError(err);
+            context.logError(err, node);
             err = null;
         } else {
             if (numRows > limit.value) {
@@ -48,10 +48,10 @@ function limitInputRowsAndAvgGroupedRows(node, input, categoriesData, context, l
     var limitPresent = Number.isFinite(limit.value);
     var groupedLimitPresent = Number.isFinite(groupedLimit.value);
     if (!limitPresent && !groupedLimitPresent) {
-        context.logError('limitInputRowsAndAvgGroupedRows called without any passed limit');
+        context.logError(new Error('limitInputRowsAndAvgGroupedRows called without any passed limit'), node);
         return callback(null);
     } else if (groupedLimitPresent && !_verifyCategoryData(categoriesData)) {
-        context.logError('Categories data must contain source and column name keys');
+        context.logError(new Error('Categories data must contain source and column name keys'), node);
         return callback(null);
     }
 
@@ -73,10 +73,10 @@ function limitInputRowsAndAvgGroupedRows(node, input, categoriesData, context, l
 function limitInputRowsMultipliedByCategories(node, input, categoryTarget, context, limit, callback) {
     var limitPresent = Number.isFinite(limit.value);
     if (!limitPresent) {
-        context.logError('Limit for input rows multiplied by categories is not defined');
+        context.logError(new Error('Limit for input rows multiplied by categories is not defined'), node);
         return callback(null);
     } else if (!_verifyCategoryData(categoryTarget)) {
-        context.logError('Categories data must contain source and column name keys');
+        context.logError(new Error('Categories data must contain source and column name keys'), node);
         return callback(null);
     }
 
@@ -96,7 +96,7 @@ function limitInputRowsMultipliedByCategories(node, input, categoryTarget, conte
 function _limitInputRowsWithCategories(node, input, categoryTarget, context, checkFunction, callback) {
     estimates.estimatedNumberOfRows(node[input], context, function(err, inputRows) {
         if (err) {
-            context.logError(err);
+            context.logError(err, node);
             // something went wrong... lack of stats? anyway, we'll let the analysis pass
             return callback(null);
         } else {
@@ -106,7 +106,7 @@ function _limitInputRowsWithCategories(node, input, categoryTarget, context, che
                     node[categoryTarget.source], context, categoryTarget.column,
                     function(err, num) {
                         if (err) {
-                            context.logError(err);
+                            context.logError(err, node);
                         } else {
                             numCategories = num;
                         }