signalfx · Jun 16, 2016 · Jun 17, 2016 · Jun 17, 2016 · Aug 1, 2016 · Aug 1, 2016
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ coverage
 build
 .idea
 *.iml
+package-lock.json
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,6 @@
 language: node_js
 node_js:
+  - "9.11"
+  - "8.11"
   - "4.1"
   - "4.0"
-  - '0.10'
-  - '0.12'
-  - 'iojs'
diff --git a/README.md b/README.md
@@ -33,17 +33,18 @@ There are two ways to create an ingest client object:
 var signalfx = require('signalfx');
 
 // Create default client
-var client = new signalfx.Ingest('MY_SIGNALFX_TOKEN' [, options]);
+var client = new signalfx.Ingest('MY_SIGNALFX_TOKEN', {options});
 // or create JSON client
-var clientJson = new signalfx.IngestJson('MY_SIGNALFX_TOKEN' [, options]);
+var clientJson = new signalfx.IngestJson('MY_SIGNALFX_TOKEN', {options});
 ```
 Object `options` is an optional map and may contains following fields:
 + **enableAmazonUniqueId** - boolean, `false` by default. If `true`, library will retrieve Amazon unique identifier and set it as `AWSUniqueId` dimension for each datapoint and event. Use this option only if your application deployed to Amazon  
 + **dimensions** - object, pre-defined dimensions for each datapoint and event. This object has key-value format `{ dimension_name: dimension_value, ...}`
 + **ingestEndpoint** -  string, custom url to send datapoints in format http://custom.domain/api/path
-+ **timeout** - number, sending datapoints timeout in ms (default is 1000ms)
++ **timeout** - number, sending datapoints timeout in ms (default is 5000ms)
 + **batchSize** - number, batch size to group sending datapoints 
 + **userAgents** - array of strings, items from this array will be added to 'user-agent' header separated by comma
++ **proxy** - string, defines an address and credentials for sending metrics through a proxy server. The string should have the following format `http://<USER>:<PASSWORD>@<HOST>:<PORT>`
 
 ### Reporting data
 
@@ -215,8 +216,9 @@ var handle = client.execute({
             program: "data('cpu.utilization').mean().publish()",
             start: Date.now() - 60000,
             stop: Date.now() + 60000,
-            resolution: 10000});
-
+            resolution: 10000,
+            immediate: false});
+
 handle.stream(function(err, data) { console.log(data); });
 ```
 
@@ -227,11 +229,12 @@ Please note that a token created via the REST API is necessary to use this API.
 Parameters to the execute method are as follows :
 
 + **program** (string) - Required field. The signalflow to be run.
-+ **start** (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -1h. Defaults to now.  
-+ **end**  (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -30m.  Defaults to infinity.
-+ **resolution** (int) - The interval across which to calculate, in 1000 millisecond intervals.  Defaults to 1000. 
++ **start** (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -1h. Defaults to now.
++ **stop**  (int | string) - A milliseconds since epoch number or a string representing a relative time : e.g. -30m.  Defaults to infinity.
++ **resolution** (int) - The interval across which to calculate, in 1000 millisecond intervals.  Defaults to 1000.
 + **maxDelay** (int) - The maximum time to wait for a datapoint to arrive, in 10000 millisecond intervals.  Defaults to dynamic.
 + **bigNumber** (boolean) - True if returned values require precision beyond MAX_SAFE_INTEGER.  Returns all values in data messages as bignumber objects as per https://www.npmjs.com/package/bignumber.js  Defaults to false.
++ **immediate** (boolean) - Whether to adjust the stop timestamp so that the computation doesn't wait for future data to be available.
 
 #### Computation Objects
 

diff --git a/circle.sh b/circle.sh
diff --git a/circle.yml b/circle.yml
diff --git a/example/index.html b/example/index.html
@@ -33,7 +33,6 @@
       }
       </style>
   </head>
-
   <body>
     <div class="graph"></div>
     <script>
@@ -112,7 +111,7 @@
 
       var token = 'YOUR USER TOKEN';
 
-      var sfxClient = signalfx.SignalFlow(token);
+      var sfxClient = signalfx.streamer.SignalFlow(token);
 
       var j1 = sfxClient.execute({
         program: "data('cpu.utilization').publish()",
@@ -122,13 +121,13 @@
 
       j1.stream(function (err, data) {
         if(!err) {
-          if ( data.type === signalfx.CONSTANTS.MESSAGE_TYPES.METADATA ) {
+          if ( data.type === signalfx.streamer.CONSTANTS.MESSAGE_TYPES.METADATA ) {
             data.data = d3.range(limit).map(function() {
               return 0;
             });
             groups[data.tsId] = data;
             addGroup(data.tsId);
-          } else if ( data.type === signalfx.CONSTANTS.MESSAGE_TYPES.DATA) {
+          } else if ( data.type === signalfx.streamer.CONSTANTS.MESSAGE_TYPES.DATA) {
             data.data.forEach(function (datapoint) {
               groups[datapoint.tsId].data.push(datapoint.value);
               groups[datapoint.tsId].path.attr('d', line);

diff --git a/gulpfile.js b/gulpfile.js
@@ -44,7 +44,7 @@ gulp.task('test', ['pre-test'], function (cb) {
 
 gulp.task('browserify', function () {
   //todo : minify
-  return browserify('./lib/signalfx_browser.js', { standalone: 'signalfx' })
+  return browserify('./lib/signalfx_browser.js', { standalone: 'signalfx.streamer' })
     .exclude('bufferutil')
     .exclude('utf-8-validate')
     //do NOT bundle websockets because the browser will provide it

diff --git a/lib/client/conf.js b/lib/client/conf.js
@@ -6,7 +6,10 @@ exports.DEFAULT_INGEST_ENDPOINT = 'https://ingest.signalfx.com';
 exports.DEFAULT_API_ENDPOINT = 'https://api.signalfx.com';
 exports.DEFAULT_SIGNALFLOW_WEBSOCKET_ENDPOINT = 'wss://stream.signalfx.com';
 exports.DEFAULT_BATCH_SIZE = 300;// Will wait for this many requests before posting
-exports.DEFAULT_TIMEOUT = 1000; // Default timeout is 1s
+exports.DEFAULT_TIMEOUT = 5000; // Default timeout is 5s
+
+// Whether to request SignalFlow WebSocket message compression.
+exports.COMPRESS_SIGNALFLOW_WEBSOCKET_MESSAGES = true;
 
 // Global Parameters
 exports.PROTOBUF_HEADER_CONTENT_TYPE = 'application/x-protobuf';

diff --git a/lib/client/ingest/protobuf_signal_fx_client.js b/lib/client/ingest/protobuf_signal_fx_client.js
@@ -67,8 +67,8 @@ ProtoBufSignalFx.prototype._batchData = function (datapointsList) {
   dpum.datapoints = dpum.datapoints.concat(datapointsList);
 
   try {
-    var dataToSend = dpum.encode();
-    return dataToSend.toBuffer();
+    var dataToSend = protocolBuffers.DataPointUploadMessage.encode(dpum);
+    return dataToSend.finish();
   } catch (error) {
     winston.error('Invalid Protobuf object', error);
   }
@@ -127,8 +127,8 @@ ProtoBufSignalFx.prototype._encodeEvent = function (protobufEvent) {
   var eventMessage = new protocolBuffers.EventUploadMessage();
   eventMessage.events = [];
   eventMessage.events.push(protobufEvent);
-  var eventToSend = eventMessage.encode();
-  return eventToSend.toBuffer();
+  var eventToSend = protocolBuffers.EventUploadMessage.encode(eventMessage);
+  return eventToSend.finish();
 };
 
 exports.ProtoBufSignalFx = ProtoBufSignalFx;

diff --git a/lib/client/ingest/signal_fx_client.js b/lib/client/ingest/signal_fx_client.js
@@ -25,8 +25,9 @@ var version = require('../../../package.json').version;
  *                    ingestEndpoint:"string",
  *                    timeout:"number",
  *                    batchSize:"number",
- *                    userAgents:"array"
- *                }
+ *                    userAgents:"array",
+ *                    proxy:"string" //http://<USER>:<PASSWORD>@<HOST>:<PORT>
+ *                  }
  */
 function SignalFxClient(apiToken, options) {
   var _this = this;
@@ -40,6 +41,7 @@ function SignalFxClient(apiToken, options) {
   this.userAgents = params.userAgents || null;
   this.globalDimensions = params.dimensions || {};
   this.enableAmazonUniqueId = params.enableAmazonUniqueId || false;
+  this.proxy = params.proxy || null;
 
   this.rawData = [];
   this.rawEvents = [];
@@ -68,8 +70,6 @@ function SignalFxClient(apiToken, options) {
       resolve();
     });
   });
-
-
 }
 
 SignalFxClient.prototype.AWSUniqueId_DIMENTION_NAME = 'AWSUniqueId';
@@ -103,7 +103,7 @@ SignalFxClient.prototype.send = function (data) {
   return this.loadAWSUniqueId
     .then(function () {
       _this.processingData();
-      _this.startAsyncSend();
+      return _this.startAsyncSend();
     });
 };
 
@@ -156,7 +156,7 @@ SignalFxClient.prototype._batchData = function (datapointsList) {
  * Send an event to SignalFx
  *
  * @param event - param object with following fields:
- *    category (int) - the category of event. Choose one from EVENT_CATEGORIES list
+ *    category (string) - the category of event. Choose one from EVENT_CATEGORIES list
  *    eventType (string) - the event type (name of the event time series).
  *    dimensions  (dict) - a map of event dimensions, empty dictionary by default
  *    properties  (dict) - a map of extra properties on that event, empty dictionary by default
@@ -184,7 +184,7 @@ SignalFxClient.prototype.sendEvent = function (event) {
 
   this.rawEvents.push(data);
   return this.loadAWSUniqueId.then(function () {
-    _this.startAsyncEventSend();
+    return _this.startAsyncEventSend();
   });
 };
 
@@ -193,7 +193,8 @@ SignalFxClient.prototype._retrieveAWSUniqueId = function (callback) {
   var getOptions = {
     url: conf.AWS_UNIQUE_ID_URL,
     timeout: 1000,
-    method: 'GET'
+    method: 'GET',
+    proxy: this.proxy
   };
 
   request(getOptions, function (error, response, body) {
@@ -240,9 +241,12 @@ SignalFxClient.prototype.startAsyncSend = function () {
     var dataToSend = _this._batchData(datapointsList);
     if (dataToSend && dataToSend.length > 0) {
       var url = _this.ingestEndpoint + '/' + _this.INGEST_ENDPOINT_SUFFIX;
-      _this.post(dataToSend, url, _this.getHeaderContentType());
+      return _this.post(dataToSend, url, _this.getHeaderContentType());
     }
   }
+  return new Promise(function (resolve) {
+    resolve(null);
+  });
 };
 
 SignalFxClient.prototype.startAsyncEventSend = function () {
@@ -259,15 +263,15 @@ SignalFxClient.prototype.startAsyncEventSend = function () {
       var eventToSend = _this._buildEvent(data);
       if (eventToSend) {
         var url = this.ingestEndpoint + '/' + this.EVENT_ENDPOINT_SUFFIX;
-        this.post(_this._encodeEvent(eventToSend), url, _this.getHeaderContentType());
+        return this.post(_this._encodeEvent(eventToSend), url, _this.getHeaderContentType());
       }
     } catch (error) {
-      winston.error('Can\'t processing event: ', error);
+      winston.error('Can\'t process event: ', error);
     }
   }
 };
 
-SignalFxClient.prototype.post = function (data, postUrl, contentType, callback) {
+SignalFxClient.prototype.post = function (data, postUrl, contentType) {
   var _this = this;
 
   var headers = {};
@@ -285,17 +289,18 @@ SignalFxClient.prototype.post = function (data, postUrl, contentType, callback)
     timeout: _this.timeout,
     headers: headers,
     body: data,
-    method: 'POST'
+    method: 'POST',
+    proxy: _this.proxy
   };
 
-  request(postOptions, function (error, response, body) {
-    if (callback) {
-      callback();
-    }
-
-    if (error || response.statusCode !== 200) {
-      winston.error('Failed to sent datapoint: ', response ? response.statusCode : '', body, error);
-    }
+  return new Promise(function (resolve, reject) {
+    request(postOptions, function (error, response, body) {
+      if (error || response.statusCode !== 200) {
+        winston.error('Failed to send datapoint: ', response ? response.statusCode : '', body, error);
+        reject(error);
+      }
+      resolve(body);
+    });
   });
 };
-Original file line number
+Diff line change
@@ @@ -3,3 +3,4 @@ coverage @@
     build
     .idea
     *.iml
+    package-lock.json