fix(startup): verbose error message

Author: gergelyke

README.md

@@ -61,6 +61,8 @@ module.exports = {
 
 *Note: Custom reporters are no longer supported in trace 2.x*
 
+*Note: If you are running your app with NODE_ENV=test, Trace won't start*
+
 ## API
 
 ### trace.report(String, [Object])

lib/agent/api/index.js

@@ -20,9 +20,7 @@ function CollectorApi (options) {
   this.processId = options.processId
   this.hostname = options.hostname
   this.serviceName = options.serviceName
-  this.baseRetryInterval = 100
-  this.retryCount = 0
-  this.retryLimit = 13
+  this.baseRetryInterval = 1000 * 60 * 30 // 30 minutes
   this.serviceKey = null
 }
 
@@ -98,9 +96,8 @@ CollectorApi.prototype.sendSamples = function (data) {
 }
 
 CollectorApi.prototype._getRetryInterval = function () {
-  var retryInterval = Math.pow(2, this.retryCount) * this.baseRetryInterval
-  debug('retrying with %d ms', retryInterval)
-  return retryInterval
+  debug('retrying with %d ms', this.baseRetryInterval)
+  return this.baseRetryInterval
 }
 
 CollectorApi.prototype.getService = function (cb) {
@@ -113,7 +110,6 @@ CollectorApi.prototype.getService = function (cb) {
   var payload = JSON.stringify({
     name: _this.serviceName
   })
-
   var req = https.request({
     hostname: opts.hostname,
     port: opts.port,
@@ -132,12 +128,9 @@ CollectorApi.prototype.getService = function (cb) {
 
       if (err) {
         debug('There was an error when connecting to the Trace API, retrying', err)
-        if (++_this.retryCount < _this.retryLimit) {
-          return setTimeout(function () {
-            _this.getService()
-          }, _this._getRetryInterval())
-        }
-        return debug('The trace collector-api is currently unavailable', err)
+        return setTimeout(function () {
+          _this.getService()
+        }, _this._getRetryInterval())
       }
 
       var resText = resBuffer.toString('utf8')
@@ -147,13 +140,9 @@ CollectorApi.prototype.getService = function (cb) {
         return console.error(format('%s trace: error: %s', new Date(), 'TRACE_API_KEY got rejected - are you sure you are using the right one?'))
       }
       if (res.statusCode > 399) {
-        if (++_this.retryCount < _this.retryLimit) {
-          return setTimeout(function () {
-            _this.getService(cb)
-          }, _this._getRetryInterval())
-        }
-
-        return cb(new Error('The trace collector-api is currently unavailable'))
+        return setTimeout(function () {
+          _this.getService(cb)
+        }, _this._getRetryInterval())
       }
 
       try {

lib/agent/api/index.spec.js

@@ -99,14 +99,12 @@ describe('The Trace CollectorApi module', function () {
 
   it('retries on 409 error', function (done) {
     var collectorApi = CollectorApi.create(defaultConfig)
+    var _getRetryIntervalSpy = this.sandbox.spy(collectorApi, '_getRetryInterval')
 
     var data = {
       name: defaultConfig.serviceName
     }
 
-    collectorApi.retryLimit = 2
-    collectorApi.baseRetryInterval = 0
-
     nock(defaultConfig.collectorApiUrl, {
       reqheaders: {
         'Authorization': 'Bearer testApiKey',
@@ -115,12 +113,15 @@ describe('The Trace CollectorApi module', function () {
       }
     })
       .post(defaultConfig.collectorApiServiceEndpoint, JSON.stringify(data))
-      .times(collectorApi.retryLimit)
+      .times(2)
       .reply(409, {})
 
-    collectorApi.getService(function (err) {
-      expect(err.message).to.eql('The trace collector-api is currently unavailable')
+    collectorApi.getService()
+
+    // FIXME: this is not nice, who can I test it better?
+    setTimeout(function () {
+      expect(_getRetryIntervalSpy).to.be.called
       done()
-    })
+    }, 100)
   })
 })

lib/index.js

@@ -1,7 +1,6 @@
 var Agent = require('./agent')
 var Instrumentation = require('./instrumentations')
 
-var format = require('util').format
 var debug = require('debug')('risingstack/trace')
 
 var ConfigReader = require('./utils/configReader')
@@ -22,7 +21,7 @@ function Trace () {
   try {
     this.config = this.configReader.getConfig()
   } catch (ex) {
-    console.error(format('%s trace: error: %s', new Date(), ex.message))
+    console.error('trace: error', ex.message)
     return traceNoop
   }
 

lib/utils/configReader.js

@@ -95,11 +95,11 @@ ConfigReader.prototype.getConfig = function () {
   config.whiteListHosts = [url.parse(config.collectorApiUrl).host]
 
   if (!config.apiKey) {
-    throw new Error('Missing apiKey')
+    throw new Error('Missing apiKey, please set the TRACE_API_KEY environment variable')
   }
 
   if (!config.serviceName) {
-    throw new Error('Missing serviceName')
+    throw new Error('Missing serviceName, please set the TRACE_SERVICE_NAME environment variable')
   }
 
   return config