add manual profiling, prebuild all addons

Author: dmelikyan

.gitignore

@@ -2,7 +2,6 @@
 ._
 ._.*
 build
-prebuilt
 node_modules
 npm-debug.log
 package-lock.json

README.md

@@ -21,7 +21,7 @@ Learn more on the [features](https://stackimpact.com/features/) page (with scree
 
 #### How it works
 
-The StackImpact profiler agent is imported into a program and used as a normal package. When the program runs, various sampling profilers are started and stopped automatically by the agent and/or programmatically using the agent methods. The agent periodically reports recorded profiles and metrics to the StackImpact Dashboard. If an application has multiple processes, also referred to as workers, instances or nodes, only one or two processes will have active agents at any point of time.
+The StackImpact profiler agent is imported into a program and used as a normal package. When the program runs, various sampling profilers are started and stopped automatically by the agent and/or programmatically using the agent methods. The agent periodically reports recorded profiles and metrics to the StackImpact Dashboard. If an application has multiple processes, also referred to as workers, instances or nodes, only one or two processes will have active agents at any point of time. The agent can also operate in manual mode, which should be used in development only.
 
 
 #### Documentation
@@ -34,7 +34,7 @@ See full [documentation](https://stackimpact.com/docs/) for reference.
 
 * Linux, OS X or Windows. Node.js v4.0.0 or higher.
 * CPU profiler is disabled by default for Node.js v7.0.0 to v8.9.3 due to memory leak in underlying V8's CPU profiler. To enable, add `cpuProfilerDisabled: false` to startup options.
-* Allocation profiler supports Node.js v6.0.0 and higher. The allocation profiler is disabled by default, since V8's heap sampling is still experimental and is seen to result in segmentation faults. To enable, add `allocationProfilerDisabled: false` to startup options.
+* Allocation profiler supports Node.js v6.0.0 and higher, but is disabled by default for Node.js v6.0.0 to v8.5.0 due to segfaults. To enable, add `allocationProfilerDisabled: false` to startup options.
 * Async profiler supports Node.js v8.1.0 and higher.
 
 
@@ -79,18 +79,18 @@ All initialization options:
 * `appVersion` (Optional) Sets application version, which can be used to associate profiling information with the source code release.
 * `appEnvironment` (Optional) Used to differentiate applications in different environments.
 * `hostName` (Optional) By default, host name will be the OS hostname.
-* `autoProfiling` (Optional) If set to `false`, disables automatic profiling and reporting. `agent.profile()` and `agent.report(callback)` should be used instead. Useful for environments without support for timers or background tasks.
+* `autoProfiling` (Optional) If set to `false`, disables automatic profiling and reporting. Programmatic or manual profiling should be used instead. Useful for environments without support for timers or background tasks.
 * `debug` (Optional) Enables debug logging.
 * `cpuProfilerDisabled`, `allocationProfilerDisabled`, `asyncProfilerDisabled`, `errorProfilerDisabled` (Optional) Disables respective profiler when `true`.
 * `includeAgentFrames` (Optional) Set to `true` to not exclude agent stack frames from profiles.
 
 
 #### Programmatic profiling
 
-Use `agent.profile()` to instruct the agent when to start and stop profiling. The agent decides if and which profiler is activated. Normally, this method should be used in repeating code, such as request or event handlers. Usage example:
+Use `agent.profile(name)` to instruct the agent when to start and stop profiling. The agent decides if and which profiler is activated. Normally, this method should be used in repeating code, such as request or event handlers. In addition to more precise profiling, timing information will also be reported for the profiled spans. Usage example:
 
 ```javascript
-const span = agent.profile();
+const span = agent.profile('span1');
 
 // your code here
 
@@ -100,6 +100,43 @@ span.stop();
 Is no callback is provided, `stop()` method returns a promise.
 
 
+#### Manual profiling
+
+*Manual profiling should not be used in production!*
+
+By default, the agent starts and stops profiling automatically. Manual profiling allows to start and stop profilers directly. It is suitable for profiling short-lived programs and should not be used for long-running production applications. Automatic profiling should be disabled with `autoProfiling: false`.
+
+```javascript
+// Start CPU profiler.
+agent.startCpuProfiler();
+```
+
+```javascript
+// Stop CPU profiler and report the recorded profile to the Dashboard.
+agent.stopCpuProfiler(callback);
+```
+
+```javascript
+// Start async call profiler.
+agent.startAsyncProfiler();
+```
+
+```javascript
+// Stop async call profiler and report the recorded profile to the Dashboard.
+agent.stopAsyncProfiler(callback);
+```
+
+```javascript
+// Start heap allocation profiler.
+agent.startAllocationProfiler();
+```
+
+```javascript
+// Stop heap allocation profiler and report the recorded profile to the Dashboard.
+agent.stopAllocationProfiler(callback);
+```
+
+
 #### Shutting down the agent
 *Optional*
 

abi-map.json

@@ -0,0 +1 @@
+{"v4.0.0":"46","v4.1.0":"46","v4.1.1":"46","v4.1.2":"46","v4.2.0":"46","v4.2.1":"46","v4.2.2":"46","v4.2.3":"46","v4.2.4":"46","v4.2.5":"46","v4.2.6":"46","v4.3.0":"46","v4.3.1":"46","v4.3.2":"46","v4.4.0":"46","v4.4.1":"46","v4.4.2":"46","v4.4.3":"46","v4.4.4":"46","v4.4.5":"46","v4.4.6":"46","v4.4.7":"46","v4.5.0":"46","v4.6.0":"46","v4.6.1":"46","v4.6.2":"46","v4.7.0":"46","v4.7.1":"46","v4.7.2":"46","v4.7.3":"46","v4.8.0":"46","v4.8.1":"46","v4.8.2":"46","v4.8.3":"46","v4.8.4":"46","v5.0.0":"47","v5.1.0":"47","v5.1.1":"47","v5.10.0":"47","v5.10.1":"47","v5.11.0":"47","v5.11.1":"47","v5.12.0":"47","v5.2.0":"47","v5.3.0":"47","v5.4.0":"47","v5.4.1":"47","v5.5.0":"47","v5.6.0":"47","v5.7.0":"47","v5.7.1":"47","v5.8.0":"47","v5.9.0":"47","v5.9.1":"47","v6.0.0":"48","v6.1.0":"48","v6.10.0":"48","v6.10.1":"48","v6.10.2":"48","v6.10.3":"48","v6.11.0":"48","v6.11.1":"48","v6.11.2":"48","v6.2.0":"48","v6.2.1":"48","v6.2.2":"48","v6.3.0":"48","v6.3.1":"48","v6.4.0":"48","v6.5.0":"48","v6.6.0":"48","v6.7.0":"48","v6.8.0":"48","v6.8.1":"48","v6.9.0":"48","v6.9.1":"48","v6.9.2":"48","v6.9.3":"48","v6.9.4":"48","v6.9.5":"48","v7.0.0":"51","v7.1.0":"51","v7.10.0":"51","v7.10.1":"51","v7.2.0":"51","v7.2.1":"51","v7.3.0":"51","v7.4.0":"51","v7.5.0":"51","v7.6.0":"51","v7.7.1":"51","v7.7.2":"51","v7.7.3":"51","v7.7.4":"51","v7.8.0":"51","v7.9.0":"51","v8.0.0":"57","v8.1.0":"57","v8.1.1":"57","v8.1.2":"57","v8.1.3":"57","v8.1.4":"57","v8.2.0":"57","v8.2.1":"57","v8.3.0":"57","v8.4.0":"57","v8.5.0":"57","v8.6.0":"57","v8.7.0":"57","v8.8.0":"57","v8.8.1":"57","v8.9.0":"57","v8.9.1":"57","v8.9.2":"57","v8.9.3":"57","v8.9.4":"57","v8.10.0":"57","v8.11.0":"57","v8.11.1":"57","v9.0.0":"59","v9.1.0":"59","v9.2.0":"59","v9.2.1":"59","v9.3.0":"59","v9.4.0":"59","v9.5.0":"59","v9.6.0":"59","v9.6.1":"59","v9.7.0":"59","v9.7.1":"59","v9.8.0":"59","v9.9.0":"59","v9.10.0":"59","v9.10.1":"59","v9.11.0":"59","v9.11.1":"59"}

addons/darwin-x64/stackimpact-addon-v46.node

@@ -0,0 +1,171 @@
+
+const os = require('os');
+const fs = require('fs');
+const cp = require('child_process');
+
+cp.execSync('npm update node-abi', {stdio: [0,1,2]});
+const nodeAbi = require('node-abi');
+
+const versions= [
+  "v4.0.0",
+  "v4.1.0",
+  "v4.1.1",
+  "v4.1.2",
+  "v4.2.0",
+  "v4.2.1",
+  "v4.2.2",
+  "v4.2.3",
+  "v4.2.4",
+  "v4.2.5",
+  "v4.2.6",
+  "v4.3.0",
+  "v4.3.1",
+  "v4.3.2",
+  "v4.4.0",
+  "v4.4.1",
+  "v4.4.2",
+  "v4.4.3",
+  "v4.4.4",
+  "v4.4.5",
+  "v4.4.6",
+  "v4.4.7",
+  "v4.5.0",
+  "v4.6.0",
+  "v4.6.1",
+  "v4.6.2",
+  "v4.7.0",
+  "v4.7.1",
+  "v4.7.2",
+  "v4.7.3",
+  "v4.8.0",
+  "v4.8.1",
+  "v4.8.2",
+  "v4.8.3",
+  "v4.8.4",
+  "v5.0.0",
+  "v5.1.0",
+  "v5.1.1",
+  "v5.10.0",
+  "v5.10.1",
+  "v5.11.0",
+  "v5.11.1",
+  "v5.12.0",
+  "v5.2.0",
+  "v5.3.0",
+  "v5.4.0",
+  "v5.4.1",
+  "v5.5.0",
+  "v5.6.0",
+  "v5.7.0",
+  "v5.7.1",
+  "v5.8.0",
+  "v5.9.0",
+  "v5.9.1",
+  "v6.0.0",
+  "v6.1.0",
+  "v6.10.0",
+  "v6.10.1",
+  "v6.10.2",
+  "v6.10.3",
+  "v6.11.0",
+  "v6.11.1",
+  "v6.11.2",
+  "v6.2.0",
+  "v6.2.1",
+  "v6.2.2",
+  "v6.3.0",
+  "v6.3.1",
+  "v6.4.0",
+  "v6.5.0",
+  "v6.6.0",
+  "v6.7.0",
+  "v6.8.0",
+  "v6.8.1",
+  "v6.9.0",
+  "v6.9.1",
+  "v6.9.2",
+  "v6.9.3",
+  "v6.9.4",
+  "v6.9.5",
+  "v7.0.0",
+  "v7.1.0",
+  "v7.10.0",
+  "v7.10.1",
+  "v7.2.0",
+  "v7.2.1",
+  "v7.3.0",
+  "v7.4.0",
+  "v7.5.0",
+  "v7.6.0",
+  "v7.7.1",
+  "v7.7.2",
+  "v7.7.3",
+  "v7.7.4",
+  "v7.8.0",
+  "v7.9.0",
+  "v8.0.0",
+  "v8.1.0",
+  "v8.1.1",
+  "v8.1.2",
+  "v8.1.3",
+  "v8.1.4",
+  "v8.2.0",
+  "v8.2.1",
+  "v8.3.0",
+  "v8.4.0",
+  "v8.5.0",
+  "v8.6.0",
+  "v8.7.0",
+  "v8.8.0",
+  "v8.8.1",
+  "v8.9.0",
+  "v8.9.1",
+  "v8.9.2",
+  "v8.9.3",
+  "v8.9.4",
+  "v8.10.0",
+  "v8.11.0",
+  "v8.11.1",
+  "v9.0.0",
+  "v9.1.0",
+  "v9.2.0",
+  "v9.2.1",
+  "v9.3.0",
+  "v9.4.0",
+  "v9.5.0",
+  "v9.6.0",
+  "v9.6.1",
+  "v9.7.0",
+  "v9.7.1",
+  "v9.8.0",
+  "v9.9.0",
+  "v9.10.0",
+  "v9.10.1",
+  "v9.11.0",
+  "v9.11.1"
+];
+
+
+let abiMap = {};
+
+let addonDir = `addons/${os.platform()}-${process.arch}`;
+if (!fs.existsSync(addonDir)) {
+  fs.mkdirSync(addonDir);
+}
+
+versions.forEach((version) => {
+  let abi = nodeAbi.getAbi(version);
+  let addonPath = `${addonDir}/stackimpact-addon-v${abi}.node`;
+
+  if (!fs.existsSync(addonPath)) {
+    cp.execSync(`node-gyp rebuild --target=${version}`, {stdio: [0,1,2]});
+    fs.copyFileSync('build/Release/stackimpact-addon.node', addonPath);
+  }
+  else {
+    console.log(`Addon with ABI ${abi} exists, skipping.`);
+  }
+
+  abiMap[version] = abi;
+});
+
+fs.writeFileSync('abi-map.json', JSON.stringify(abiMap));

addons/darwin-x64/stackimpact-addon-v47.node

@@ -1,13 +1,11 @@
-const stackimpact = require('..');
+const stackimpact = require('../..');
 
 
 const agent = stackimpact.start({
   agentKey: process.env.AGENT_KEY,
   appName: 'ExampleNodejsLambda',
   appEnvironment: 'prod',
   autoProfiling: false,
-  cpuProfilerDisabled: false,
-  allocationProfilerDisabled: false,
   debug: true
 });
 
@@ -43,13 +41,3 @@ exports.handler = function(event, context, callback) {
     callback(null, response);
   });
 };
-
-
-
-// Simulate events.
-// Delete if deploying as lambda function.
-setInterval(() => {
-  exports.handler({}, {}, () => {
-    console.log('RequestResponse');
-  });
-}, 1000);

addons/darwin-x64/stackimpact-addon-v48.node

@@ -1,6 +1,6 @@
 const fs = require('fs');
 const http = require('http');
-const stackimpact = require('..');
+const stackimpact = require('../..');
 
 
 // StackImpact agent initialization
@@ -9,8 +9,6 @@ let agent = stackimpact.start({
   agentKey: process.env.AGENT_KEY,
   appName: 'ExampleNodejsApp',
   appVersion: '1.0.0',
-  cpuProfilerDisabled: false,
-  allocationProfilerDisabled: false,
   debug: true
 });
 
@@ -101,7 +99,7 @@ function simulateProgrammaticProfiling() {
   setInterval(() => {
     let span = agent.profile();
 
-    for(let i = 0; i < usage * 300000; i++) {
+    for(let i = 0; i < 100000; i++) {
       Math.random();
     }
 

addons/darwin-x64/stackimpact-addon-v51.node

@@ -0,0 +1,32 @@
+const stackimpact = require('../..');
+
+
+const agent = stackimpact.start({
+  agentKey: process.env.AGENT_KEY,
+  appName: 'MyNodeApp',
+  appEnvironment: 'mydevenv',
+  autoProfiling: false
+});
+
+
+function simulateMemAllocs() {
+  let mem = [];
+
+  setInterval(() => {
+    for(let i = 0; i < 1000000; i++) {
+      obj = {'v': Math.random()};
+      mem.push(obj);
+    }
+  }, 1000);
+}
+
+agent.startAllocationProfiler();
+
+simulateMemAllocs();
+
+setTimeout(() => {
+  agent.stopAllocationProfiler(() => {
+    // profile reported
+    process.exit();
+  });
+}, 5000);

addons/darwin-x64/stackimpact-addon-v57.node

@@ -0,0 +1,33 @@
+const https = require('https');
+const stackimpact = require('../..');
+
+
+const agent = stackimpact.start({
+  agentKey: process.env.AGENT_KEY,
+  appName: 'MyNodeApp',
+  appEnvironment: 'mydevenv',
+  autoProfiling: false
+});
+
+
+function simulateAsyncWork() {
+  setInterval(() => {
+    var req = https.get('https://stackimpact.com', (res) => {
+    });
+
+    req.on('error', function(err) {
+      console.log(err.message);
+    });
+  }, 1000);
+}
+
+agent.startAsyncProfiler();
+
+simulateAsyncWork();
+
+setTimeout(() => {
+  agent.stopAsyncProfiler(() => {
+    // profile reported
+    process.exit();
+  });
+}, 5000);