feat(proxy): adding https proxy

Author: gergelyke

README.md

@@ -66,7 +66,8 @@ module.exports = {
   ],
   disableInstrumentations: [
     'mongodb'
-  ]
+  ],
+  proxy: 'http://168.63.76.32:3128'
 }
 ```
 

lib/agent/api/index.js

@@ -5,6 +5,7 @@ var requestSync = require('sync-request')
 var isNumber = require('lodash.isnumber')
 var debug = require('debug')('risingstack/trace')
 var assign = require('lodash.assign')
+var HttpsProxyAgent = require('https-proxy-agent')
 
 var bl = require('bl')
 var libPackage = require('../../../package')
@@ -28,6 +29,10 @@ function CollectorApi (options) {
   this.serviceName = options.serviceName
   this.baseRetryInterval = 1000 * 60 * 30 // 30 minutes
   this.serviceKey = null
+
+  if (options.proxy) {
+    this.proxyAgent = new HttpsProxyAgent(options.proxy)
+  }
 }
 
 // USE THIS WITH CAUTION, IT WILL BE BLOCKING
@@ -62,19 +67,23 @@ CollectorApi.prototype._send = function (destinationUrl, data, callback) {
 
   callback = callback || function () {}
 
-  var req = https.request({
+  var requestOptions = {
     hostname: opts.hostname,
     port: opts.port,
     path: opts.path,
     method: 'POST',
+    // if the proxy is not set, it will fallback to the default agent
+    agent: this.proxyAgent,
     headers: {
       'Authorization': 'Bearer ' + this.apiKey,
       'Content-Type': 'application/json',
       'X-Reporter-Version': libPackage.version,
       'X-Reporter-Language': this.collectorLanguage,
       'Content-Length': payload.length
     }
-  }, function (res) {
+  }
+
+  var req = https.request(requestOptions, function (res) {
     res.setEncoding('utf8')
     res.pipe(bl(function (err, result) {
       if (err) {

lib/agent/api/index.spec.js

@@ -1,5 +1,6 @@
 var util = require('util')
 var url = require('url')
+var https = require('https')
 
 var CollectorApi = require('./')
 
@@ -9,54 +10,81 @@ var libPackage = require('../../../package')
 var assign = require('lodash.assign')
 
 describe('The Trace CollectorApi module', function () {
-  var defaultConfig = {
-    serviceName: 'testName',
-    apiKey: 'testApiKey',
-    collectorLanguage: 'nodejs',
-    collectorApiUrl: 'https://collector.api.mock',
-    collectorApiSampleEndpoint: '/service/sample',
-    collectorApiServiceEndpoint: '/service',
-    collectorApiApmMetricsEndpoint: '/service/%s/apm-metrics',
-    collectorApiRpmMetricsEndpoint: '/service/%s/rpm-metrics',
-    collectorApiEdgeMetricsEndpoint: '/service/%s/edge-metrics',
-    collectorApiIncomingEdgeMetricsEndpoint: '/service/%s/edge-incoming',
-    collectorApiExternalEdgeMetricsEndpoint: '/service/%s/edge-external',
-    collectorApiHealthcheckEndpoint: '/service/%s/healthcheck',
-    collectorApiProfilerMemoryHeapdumpEndpoint: '/service/%s/memory-heapdump',
-    collectorApiProfilerCpuProfileEndpoint: '/service/%s/cpu-profile',
-    collectorApiControlEndpoint: '/service/%s/control',
-    collectorApiCustomMetrics: '/service/%s/custom-metrics',
-    system: {
-      hostname: 'test.org',
-      processVersion: '4.3.1',
-      processName: 'node',
-      processId: 7777,
-      osArch: 'x86',
-      osPlatform: 'darwin',
-      osRelease: '11',
-      cpus: [
-        {
-          model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
-          speed: 2700
-        },
-        {
-          model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
-          speed: 2700
-        },
-        {
-          model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
-          speed: 2700
-        },
-        { model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
-          speed: 2700
-        }
-      ]
+  var defaultConfig
+  beforeEach(function () {
+    defaultConfig = {
+      serviceName: 'testName',
+      apiKey: 'testApiKey',
+      collectorLanguage: 'nodejs',
+      collectorApiUrl: 'https://collector.api.mock',
+      collectorApiSampleEndpoint: '/service/sample',
+      collectorApiServiceEndpoint: '/service',
+      collectorApiApmMetricsEndpoint: '/service/%s/apm-metrics',
+      collectorApiRpmMetricsEndpoint: '/service/%s/rpm-metrics',
+      collectorApiEdgeMetricsEndpoint: '/service/%s/edge-metrics',
+      collectorApiIncomingEdgeMetricsEndpoint: '/service/%s/edge-incoming',
+      collectorApiExternalEdgeMetricsEndpoint: '/service/%s/edge-external',
+      collectorApiHealthcheckEndpoint: '/service/%s/healthcheck',
+      collectorApiProfilerMemoryHeapdumpEndpoint: '/service/%s/memory-heapdump',
+      collectorApiProfilerCpuProfileEndpoint: '/service/%s/cpu-profile',
+      collectorApiControlEndpoint: '/service/%s/control',
+      collectorApiCustomMetrics: '/service/%s/custom-metrics',
+      system: {
+        hostname: 'test.org',
+        processVersion: '4.3.1',
+        processName: 'node',
+        processId: 7777,
+        osArch: 'x86',
+        osPlatform: 'darwin',
+        osRelease: '11',
+        cpus: [
+          {
+            model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
+            speed: 2700
+          },
+          {
+            model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
+            speed: 2700
+          },
+          {
+            model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
+            speed: 2700
+          },
+          { model: 'Intel(R) Core(TM) i5-5257U CPU @ 2.70GHz',
+            speed: 2700
+          }
+        ]
+      }
     }
-  }
+  })
 
   it('can be instantiated w/ serviceName and apiKey', function () {
+    var httpsRequestSpy = this.sandbox.spy(https, 'request')
+    defaultConfig.proxy = 'http://127.0.0.1'
+    var collectorApi = CollectorApi.create(defaultConfig)
+
+    var serviceKey = 12
+
+    var data = {
+      trace: 'very data',
+      hostname: 'test.org',
+      pid: 7777
+    }
+
+    var path = util.format(defaultConfig.collectorApiRpmMetricsEndpoint, serviceKey)
+    var sendUrl = url.resolve(defaultConfig.collectorApiUrl, path)
+
+    var collectorApi = CollectorApi.create(defaultConfig)
+    collectorApi.serviceKey = serviceKey
+
+    collectorApi.sendRpmMetrics(data)
+
+    expect(httpsRequestSpy.firstCall.args[0].agent).to.eql(collectorApi.proxyAgent)
+    expect(collectorApi.proxyAgent).to.be.ok
+  })
+
+  it('can use a proxy', function () {
     var collectorApi = CollectorApi.create(defaultConfig)
-    expect(collectorApi).to.be.ok
   })
 
   it('sends rpm metrics to the collector server', function () {

lib/utils/configReader.js

@@ -62,7 +62,8 @@ ConfigReader.prototype._getEnvVarConfig = function () {
     disableStackTrace: process.env.TRACE_DISABLE_STACK_TRACE == true, // eslint-disable-line
     disableInstrumentations: process.env.TRACE_DISABLE_INSTRUMENTATIONS
       ? process.env.TRACE_DISABLE_INSTRUMENTATIONS.split(',')
-      : []
+      : [],
+    proxy: process.env.TRACE_PROXY
   }
 
   var ignoreHeaders

package.json

@@ -44,6 +44,7 @@
     "bl": "1.1.2",
     "continuation-local-storage": "3.1.7",
     "debug": "2.2.0",
+    "https-proxy-agent": "1.0.0",
     "lodash.assign": "4.0.9",
     "lodash.defaults": "4.0.1",
     "lodash.flatmap": "4.3.0",