refactor(): uniform user log messages

Author: dszakallas

lib/agent/api/index.js

@@ -4,7 +4,6 @@ var util = require('util')
 var requestSync = require('sync-request')
 var isNumber = require('lodash.isnumber')
 var debug = require('debug')('risingstack/trace')
-var format = require('util').format
 var assign = require('lodash.assign')
 
 var bl = require('bl')
@@ -80,7 +79,7 @@ CollectorApi.prototype._send = function (destinationUrl, data) {
   debug('sending data to trace servers: ', destinationUrl, payload)
 
   req.on('error', function (error) {
-    console.error('There was an error connecting to the Trace servers. Make sure your servers can reach trace-collector-api.risingstack.com')
+    console.error('error: [trace]', 'There was an error connecting to the Trace servers. Make sure your servers can reach trace-collector-api.risingstack.com')
     debug('error connecting to the Trace servers', error)
   })
   req.write(payload)
@@ -215,7 +214,7 @@ CollectorApi.prototype.getService = function (cb) {
 
       debug('raw response from trace servers: ', resText)
       if (res.statusCode === 401) {
-        return console.error(format('%s trace: error: %s', new Date(), 'TRACE_API_KEY got rejected - are you sure you are using the right one?'))
+        return console.error('error: [trace]', 'Trace API key is rejected - are you sure you are using the right one?')
       }
       if (res.statusCode > 399) {
         return setTimeout(function () {
@@ -238,7 +237,7 @@ CollectorApi.prototype.getService = function (cb) {
   debug('getting serviceKey with payload:', payload)
 
   req.on('error', function (error) {
-    console.error('There was an error connecting to the Trace servers. Make sure your servers can reach trace-collector-api.risingstack.com')
+    console.error('error: [trace]', 'There was an error connecting to the Trace servers. Make sure your servers can reach trace-collector-api.risingstack.com')
     debug('error connecting to the Trace servers', error)
   })
   req.write(payload)

lib/index.js

@@ -21,13 +21,13 @@ function Trace () {
   try {
     this.config = this.configReader.getConfig()
   } catch (ex) {
-    console.error('trace: error', ex.message)
+    console.error('error: [trace]', ex.message)
     return traceNoop
   }
 
   // warn the user if the newrelic agent is present as well
   if (require.cache.__NR_cache) {
-    console.error('Make sure to require Trace before New Relic, otherwise Trace won\'t start')
+    console.error('error: [trace]', 'Make sure to require Trace before New Relic, otherwise Trace won\'t start')
     return traceNoop
   }
 

lib/optionalDependencies/event-loop-stats.js

@@ -3,7 +3,7 @@ var eventLoopStats
 try {
   eventLoopStats = require('event-loop-stats')
 } catch (ex) {
-  console.log('event-loop-stats couldn\'t be required, possibly a compiler issue - continuing')
+  console.log('error: [trace]', 'event-loop-stats couldn\'t be required, possibly a compiler issue - continuing')
   eventLoopStats = {
     sense: function () {}
   }

lib/optionalDependencies/gc-stats.js

@@ -4,7 +4,7 @@ try {
   gcStats = require('gc-stats')
 } catch (ex) {
   gcStats = function () {
-    console.log('gc-stats couldn\'t be required, possibly a compiler issue - continuing')
+    console.error('error: [trace]', 'gc-stats couldn\'t be required, possibly a compiler issue - continuing')
     return {
       on: function () {}
     }

lib/optionalDependencies/microtime.js

@@ -3,7 +3,7 @@ var microtime
 try {
   microtime = require('microtime')
 } catch (ex) {
-  console.log('microtime couldn\'t be required, possibly a compiler issue - continuing')
+  console.error('error: [trace]', 'microtime couldn\'t be required, possibly a compiler issue - continuing')
   microtime = {
     now: function () {
       return Date.now() * 1000

lib/utils/configReader.js

@@ -68,7 +68,7 @@ ConfigReader.prototype._getEnvVarConfig = function () {
       ignoreHeaders = JSON.parse(process.env.TRACE_IGNORE_HEADERS)
       defaults(envVarConfig, { ignoreHeaders: ignoreHeaders })
     } catch (err) {
-      console.error(format('%s trace: warning: Cannot parse TRACE_IGNORE_HEADERS. Error: %s', err.message))
+      console.error('warn: [trace]', format('Cannot parse TRACE_IGNORE_HEADERS. Error: %s', err.message))
     }
   }
 
@@ -77,7 +77,7 @@ ConfigReader.prototype._getEnvVarConfig = function () {
       ignoreOutgoingHosts = JSON.parse(process.env.TRACE_IGNORE_OUTGOING_HOSTS)
       defaults(envVarConfig, { ignoreOutgoingHosts: ignoreOutgoingHosts })
     } catch (err) {
-      console.error(format('%s trace: warning: Cannot parse TRACE_IGNORE_OUTGOING_HOSTS. Error: %s', err.message))
+      console.error('warn: [trace]', format('Cannot parse TRACE_IGNORE_OUTGOING_HOSTS. Error: %s', err.message))
     }
   }
 
@@ -177,7 +177,7 @@ ConfigReader.prototype._checkApiToken = function (token) {
   var bearerTokenParts
 
   if (!token) {
-    throw new Error('Missing apiKey, please set the TRACE_API_KEY environment variable')
+    throw new Error('Missing API key, please set the TRACE_API_KEY environment variable')
   }
 
   bearerTokenParts = token.split('.')
@@ -222,7 +222,7 @@ ConfigReader.prototype.getConfig = function () {
   this._checkApiToken(config.apiKey)
 
   if (!config.serviceName) {
-    throw new Error('Missing serviceName, please set the TRACE_SERVICE_NAME environment variable')
+    throw new Error('Missing service name, please set the TRACE_SERVICE_NAME environment variable')
   }
 
   this._normalizeConfig()