fix(metrics): load metics instead of cpu

Author: gergelyke

lib/agent/metrics/apm/index.js

@@ -6,6 +6,7 @@ var BYTES_TO_MEGABYTES = 1024 * 1024
 
 function ApmMetrics (options) {
   var _this = this
+  this.cpuCount = os.cpus().length
   this.pid = process.pid
   this.collectorApi = options.collectorApi
   this.config = options.config
@@ -47,7 +48,7 @@ ApmMetrics.prototype.sendMetrics = function () {
   var databag = {
     timestamp: (new Date()).toISOString(),
     memory: this.getMemory(),
-    cpu: this.getCpu()
+    cpu: this.getLoad()
   }
 
   if (eventloop.stats) {
@@ -72,9 +73,14 @@ ApmMetrics.prototype.getMemory = function () {
   }
 }
 
-ApmMetrics.prototype.getCpu = function () {
+ApmMetrics.prototype.getLoad = function () {
+  if (this.config.isRunningInVm) {
+    return {
+      utilization: null
+    }
+  }
   return {
-    utilization: Math.floor(os.loadavg()[0])
+    utilization: Math.floor(os.loadavg()[0] * 100 / this.cpuCount)
   }
 }
 

lib/agent/metrics/apm/index.spec.js

@@ -9,7 +9,7 @@ describe('The ApmMetrics module', function () {
     var activeRequests = 3
     var activeHandlers = 5
     var ISOString = 'date-string'
-    var loadAvg = 3.3
+    var loadAvg = 3
     var memoryUsed = 24000000
     var memoryTotal = 12000000
     var memoryRss = 15000000
@@ -56,6 +56,8 @@ describe('The ApmMetrics module', function () {
       return [loadAvg]
     })
 
+    this.sandbox.stub(apmMetrics, 'cpuCount', 2)
+
     apmMetrics.sendMetrics()
 
     expect(collectorApi.sendApmMetrics).to.be.calledWith({
@@ -70,7 +72,7 @@ describe('The ApmMetrics module', function () {
         stats: _eventLoopStats
       },
       cpu: {
-        utilization: Math.floor(loadAvg)
+        utilization: 150
       },
       gc: {
         time: 0,
@@ -80,4 +82,22 @@ describe('The ApmMetrics module', function () {
       timestamp: ISOString
     })
   })
+
+  it('skips utilization if running in VM', function () {
+    var collectorApi = {
+      sendApmMetrics: this.sandbox.spy()
+    }
+
+    var apmMetrics = ApmMetrics.create({
+      collectorApi: collectorApi,
+      config: {
+        collectInterval: 1,
+        isRunningInVm: true
+      }
+    })
+
+    expect(apmMetrics.getLoad()).to.eql({
+      utilization: null
+    })
+  })
 })

lib/utils/configReader.js

@@ -6,6 +6,7 @@ var url = require('url')
 var debug = require('debug')('risingstack/trace')
 var defaults = require('lodash.defaults')
 var format = require('util').format
+var fs = require('fs')
 
 function ConfigReader (config) {
   this.parameterConfig = config || { }
@@ -81,21 +82,70 @@ ConfigReader.prototype._readConfigFile = function (file) {
 
 ConfigReader.prototype._getFileConfig = function (file) {
   if (file) {
+    try {
+      fs.statSync(file)
+    } catch (ex) {
+      debug('Configuration file not found')
+      return { }
+    }
+
     try {
       return this._readConfigFile(path.resolve(file))
     } catch (ex) {
-      if (ex.code === 'MODULE_NOT_FOUND') {
-        debug('Configuration file not found')
-        return { }
-      } else {
-        throw new Error('Invalid trace.config.js configuration file')
-      }
+      throw new Error('Invalid trace.config.js configuration file')
     }
   } else /* no file path given */ {
     return { }
   }
 }
 
+ConfigReader.prototype._getVmConfig = function (name) {
+  var vmConfig = {}
+  var cGroupContent = this.readProcFile('/self/cgroup')
+  var isRunningInVm
+
+  if (cGroupContent) {
+    isRunningInVm = this.isRunningInVm(cGroupContent)
+  }
+
+  vmConfig.isRunningInVm = isRunningInVm
+
+  return vmConfig
+}
+
+ConfigReader.prototype.isRunningInVm = function (cGroupFile) {
+  var cGroupLines = cGroupFile.split('\n')
+  var patterns = [
+    /^\/docker/,
+    /^\/lxc/
+  ]
+  var parts
+  var i
+  var j
+  for (i = 0; i < cGroupLines.length; i++) {
+    parts = cGroupLines[i].split(':')
+    if (parts.length !== 3) {
+      continue
+    }
+    for (j = 0; j < patterns.length; j++) {
+      if (parts[2].match(patterns[i])) {
+        return true
+      }
+    }
+  }
+  return false
+}
+
+ConfigReader.prototype.readProcFile = function (name) {
+  var procFileContent
+  try {
+    procFileContent = fs.readFileSync('/proc' + name, 'utf-8')
+  } catch (ex) {
+    debug('Cannot read procfile', name, ex)
+  }
+  return procFileContent
+}
+
 ConfigReader.prototype.checkApiToken = function (token) {
   var bearerTokenParts
 
@@ -123,10 +173,13 @@ ConfigReader.prototype.getConfig = function () {
 
   var fileConfig = this._getFileConfig(configFilePath)
 
+  var vmConfig = this._getVmConfig()
+
   config = defaults(
     config,
     fileConfig,
     cloudFoundryConfig,
+    vmConfig,
     defaultConfig
   )
 

lib/utils/configReader.spec.js

@@ -1,5 +1,7 @@
 var expect = require('chai').expect
 
+var fs = require('fs')
+
 var ConfigReader = require('./configReader')
 
 describe('Config Reader module', function () {
@@ -187,6 +189,25 @@ describe('Config Reader module', function () {
     delete process.env.VCAP_SERVICES
   })
 
+  it('loads VM specific config (LXC/Docker)', function () {
+    this.sandbox.stub(fs, 'readFileSync', function () {
+      return '11:memory:/docker'
+    })
+
+    var configReader = ConfigReader.create({
+      serviceName: 'test',
+      reporter: 'dummy',
+      collectorApiUrl: 'http://c.a.b',
+      apiKey: testApiToken
+    })
+
+    this.sandbox.stub(configReader, '_getDefaultConfig', function () {
+      return { configPath: 'default' }
+    })
+
+    expect(configReader.getConfig().isRunningInVm).to.eql(true)
+  })
+
   it('can find config file by default config', function () {
     var configReader = ConfigReader.create({
       serviceName: 'test',
@@ -255,16 +276,11 @@ describe('Config Reader module', function () {
 
   it('throws readable error on loading invalid config file', function () {
     var configReader = ConfigReader.create({ serviceName: 'test', reporter: 'dummy', configPath: 'test' })
-    var readConfigFileStub = this.sandbox.stub(configReader, '_readConfigFile', function () {
-      // simulates an error
-      throw new Error()
-    })
 
     try {
       configReader.getConfig()
     } catch (ex) {
       expect(ex).to.be.eql(new Error('Invalid trace.config.js configuration file'))
-      expect(readConfigFileStub).to.have.been.calledOnce
       return
     }
 
@@ -287,6 +303,18 @@ describe('Config Reader module', function () {
     this.sandbox.stub(configReader, '_readConfigFile', function () {
       return { ignoreHeaders: wellformed }
     })
+
+    this.sandbox.stub(configReader, '_getDefaultConfig', function () {
+      return {
+        test: 'default',
+        collectorApiUrl: 'http://c.a.b'
+      }
+    })
+
+    this.sandbox.stub(fs, 'statSync', function () {
+      return { }
+    })
+
     try {
       var config = configReader.getConfig()
       expect(config.ignoreHeaders).to.eql(wellformed)