Merge pull request #337 from sjanuary/headless

Implement zip function for headless mode

Author: tobespc

binding.gyp

@@ -67,6 +67,7 @@
       "target_name": "appmetrics",
       "sources": [
         "<(INTERMEDIATE_DIR)/appmetrics.cpp",
+        "<(srcdir)/headlessutils.cpp",
         "<(srcdir)/objecttracker.cpp",
       ],
       'variables': {
@@ -156,6 +157,7 @@
             "<(agentcoredir)/plugins/<(SHARED_LIB_PREFIX)envplugin<(SHARED_LIB_SUFFIX)",
             "<(agentcoredir)/plugins/<(SHARED_LIB_PREFIX)memoryplugin<(SHARED_LIB_SUFFIX)",
             "<(agentcoredir)/plugins/<(SHARED_LIB_PREFIX)hcapiplugin<(SHARED_LIB_SUFFIX)",
+            "<(agentcoredir)/plugins/<(SHARED_LIB_PREFIX)headlessplugin<(SHARED_LIB_SUFFIX)",
           ],
         },
       ],

headless_zip.js

@@ -0,0 +1,82 @@
+/*******************************************************************************
+ * Copyright 2016 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *******************************************************************************/
+
+var fs = require('fs')
+var path = require('path')
+var JSZip = require("jszip");
+
+var dirToWriteTo;
+
+function onError(err) {
+	console.error('Headless Zip: an error occurred:', err)
+}
+
+function deleteDir(directory) {
+	// Delete temporary directory
+	if(fs.existsSync(directory)) {
+		fs.readdirSync(directory).forEach(function(file,index){
+			var fileName = path.join(directory, file)
+			fs.unlinkSync(fileName)
+		})
+		fs.rmdirSync(directory);
+	}
+}
+
+module.exports.setHeadlessOutputDir = function setHeadlessOutputDir(dir) {
+	dirToWriteTo = dir;
+}
+
+function timestamp() {
+	var date = new Date(Date.now())
+	var timestamp = pad(date.getDate().toString()) + pad((date.getMonth() + 1).toString()) + date.getFullYear().toString().substr(2,3) + '_'
+		+ pad(date.getHours().toString()) + pad(date.getMinutes().toString()) + pad(date.getSeconds().toString()) + '_'
+		+ process.pid
+	return timestamp
+}
+
+function pad(numberString) {
+	// pads a single digit number with a leading 0
+	if(numberString.length == 1) {
+		return '0' + numberString
+	}
+	return numberString
+}
+
+module.exports.headlessZip = function headlessZip(dirToZip) {
+	var outputFileName;
+	if(dirToWriteTo) {
+		outputFileName = path.join(dirToWriteTo, 'nodeappmetrics' + timestamp() + '.hcd')
+	} else {
+		outputFileName = 'nodeappmetrics' + timestamp() + '.hcd'
+	}
+
+	var zip = new JSZip();
+	fs.readdir(dirToZip, function(error, files) {
+		if (error) {
+      			onError(error)
+      			return
+    		}
+		for (var i = 0, len = files.length; i < len; i++) {
+      			zip.file(files[i], fs.readFileSync(path.join(dirToZip, files[i])), {compression : "DEFLATE"})
+		}
+	
+		zip.generateNodeStream({type:'nodebuffer',streamFiles:true})
+		.pipe(fs.createWriteStream(outputFileName))
+		.on('finish', function () {
+			deleteDir(dirToZip)
+		})
+	})
+} 

index.js

@@ -26,7 +26,9 @@ var request = require('./lib/request.js');
 var fs = require('fs');
 var nodereport = require('nodereport');
 var agent = require("./appmetrics")
+var headlessZip = require("./headless_zip.js")
 
+// Set the plugin search path
 agent.spath(path.join(module_dir, "plugins"))
 
 
@@ -230,6 +232,7 @@ for (var prop in agent) {
     if (typeof agent[prop] == "function") {
         module.exports[prop] = agent[prop]
     }
+    agent.setHeadlessZipFunction(headlessZip.headlessZip);
 }
 
 // Export emit() API for JS data providers
@@ -250,7 +253,11 @@ module.exports.monitor = function() {
 
     if (typeof(this.api) == 'undefined') {
       agent.start();
-        this.api = hcAPI.getAPI(agent, module.exports);
+      this.api = hcAPI.getAPI(agent, module.exports);
+      var headlessOutputDir = agent.getOption('com.ibm.diagnostics.healthcenter.headless.output.directory');
+      if(headlessOutputDir) {
+        headlessZip.setHeadlessOutputDir(headlessOutputDir);
+      }
     }
     return this.api;
 };
@@ -288,8 +295,13 @@ module.exports.getJSONProfilingMode = function() {
 
 module.exports.start = function () {
   agent.setOption(propertyMappings['applicationID'], main_filename);
+  var headlessOutputDir = agent.getOption('com.ibm.diagnostics.healthcenter.headless.output.directory');
+  if(headlessOutputDir) {
+    headlessZip.setHeadlessOutputDir(headlessOutputDir);
+  }
   agent.start();
 }
+
 module.exports.nodereport = function() {
     return nodereport;
 }

package.json

@@ -9,7 +9,8 @@
     "heapdump": "0.x",
     "nan": "2.x",
     "nodereport": "1.x",
-    "tar": "2.x"
+    "tar": "2.x",
+    "jszip": "3.0.x"
   },
   "bundleDependencies": [
     "tar"

src/appmetrics.cpp

@@ -23,6 +23,7 @@
 #include "uv.h"
 #include "ibmras/monitoring/AgentExtensions.h"
 #include "plugins/node/prof/watchdog.h"
+#include "headlessutils.h"
 
 #if NODE_VERSION_AT_LEAST(0, 11, 0) // > v0.11+
 #include "objecttracker.hpp"
@@ -298,13 +299,27 @@ NAN_METHOD(setOption) {
     }
 }
 
+// get property
+NAN_METHOD(getOption) {
+	if (info.Length() > 0) {
+		Local<String> value = info[0]->ToString();
+		std::string property = loaderApi->getProperty(toStdString(value).c_str());
+		v8::Local<v8::String> v8str = v8::String::NewFromUtf8(v8::Isolate::GetCurrent(), property.c_str());
+		info.GetReturnValue().Set<v8::String>(v8str);
+	} else {
+		loaderApi->logMessage(warning, "Incorrect number of parameters passed to getOption");
+	}
+}
+
 NAN_METHOD(start) {
 	if (!running) {
 		running = true;
 
         loaderApi->init();
 
         loaderApi->start();
+	
+	headless::start();
     }
     if (!initMonitorApi()) {
         loaderApi->logMessage(warning, "Failed to initialize monitoring API");
@@ -319,6 +334,7 @@ NAN_METHOD(stop) {
         running = false;
         loaderApi->stop();
         loaderApi->shutdown();
+	headless::stop();
     }
 
 }
@@ -492,6 +508,13 @@ NAN_METHOD(sendControlCommand) {
 
 }
 
+NAN_METHOD(setHeadlessZipFunction) {
+    if (!info[0]->IsFunction()) {
+        return Nan::ThrowError("First argument must be a function");
+    }
+    Nan::Callback *callback = new Nan::Callback(info[0].As<Function>());
+    headless::setZipFunction(callback);
+}
 
 NAN_METHOD(localConnect) {
     if (!isMonitorApiValid()) {
@@ -624,6 +647,10 @@ static bool isGlobalAgentAlreadyLoaded(Local<Object> module) {
     return false;
 }
 
+void zip(const char* outputDir) {
+	headless::zip(outputDir);
+}
+
 void init(Local<Object> exports, Local<Object> module) {
     /*
      * Throw an error if appmetrics has already been loaded globally
@@ -644,13 +671,15 @@ void init(Local<Object> exports, Local<Object> module) {
     /*
      * Set exported functions
      */
+    exports->Set(Nan::New<String>("getOption").ToLocalChecked(), Nan::New<FunctionTemplate>(getOption)->GetFunction());
     exports->Set(Nan::New<String>("setOption").ToLocalChecked(), Nan::New<FunctionTemplate>(setOption)->GetFunction());
     exports->Set(Nan::New<String>("start").ToLocalChecked(), Nan::New<FunctionTemplate>(start)->GetFunction());
     exports->Set(Nan::New<String>("spath").ToLocalChecked(), Nan::New<FunctionTemplate>(spath)->GetFunction());
     exports->Set(Nan::New<String>("stop").ToLocalChecked(), Nan::New<FunctionTemplate>(stop)->GetFunction());
     exports->Set(Nan::New<String>("localConnect").ToLocalChecked(), Nan::New<FunctionTemplate>(localConnect)->GetFunction());
     exports->Set(Nan::New<String>("nativeEmit").ToLocalChecked(), Nan::New<FunctionTemplate>(nativeEmit)->GetFunction());
     exports->Set(Nan::New<String>("sendControlCommand").ToLocalChecked(), Nan::New<FunctionTemplate>(sendControlCommand)->GetFunction());
+    exports->Set(Nan::New<String>("setHeadlessZipFunction").ToLocalChecked(), Nan::New<FunctionTemplate>(setHeadlessZipFunction)->GetFunction());
 #if defined(_LINUX)
     exports->Set(Nan::New<String>("lrtime").ToLocalChecked(), Nan::New<FunctionTemplate>(lrtime)->GetFunction());
 #endif
@@ -670,6 +699,7 @@ void init(Local<Object> exports, Local<Object> module) {
     if (!loadProperties()) {
         loaderApi->logMessage(warning, "Failed to load appmetrics.properties file");
     }
+    loaderApi->registerZipFunction(&zip);
     loaderApi->setLogLevels();
     /* changing this to pass agentcore.version and adding new appmetrics.version for use in the client */
     loaderApi->setProperty("agentcore.version", loaderApi->getAgentVersion());

src/headlessutils.cpp

@@ -0,0 +1,63 @@
+/*******************************************************************************
+ * Copyright 2016 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *******************************************************************************/
+
+
+#include "headlessutils.h"
+#include <iostream>
+#include "nan.h"
+#include "uv.h"
+
+namespace headless {
+
+Nan::Callback* zipFunction;
+
+void setZipFunction(Nan::Callback* zF) {
+	zipFunction = zF;
+}
+
+uv_async_t async_zip;
+
+uv_loop_t* loop;
+const char* outputDir;
+
+void asyncfunc(uv_async_t* handle) {
+	Nan::HandleScope scope;
+ 	v8::Isolate* isolate = v8::Isolate::GetCurrent();
+  	v8::Local<v8::Value> argv[] = { v8::String::NewFromUtf8(isolate, outputDir) };
+  	headless::zipFunction->Call(1, argv);
+}
+
+
+const char* headlessRecVersion = "1.0";
+
+void start() {
+	loop = uv_default_loop();
+	uv_async_init(loop, &async_zip, asyncfunc);
+}
+
+void stop() {
+	uv_close((uv_handle_t*) &async_zip, NULL);
+}
+
+void zip(const char* dir) {
+	outputDir = dir;
+	uv_async_send(&async_zip);
+}
+
+
+} /* end namespace headless */
+
+

src/headlessutils.h

@@ -0,0 +1,32 @@
+/*******************************************************************************
+ * Copyright 2016 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *******************************************************************************/
+
+
+#ifndef HEADLESSUTILS_H_
+#define HEADLESSUTILS_H_
+
+#include "nan.h"
+
+
+namespace headless {
+
+	void setZipFunction(Nan::Callback* callback);
+	void start();
+	void stop();
+	void zip(const char* dir);
+
+} /* namespace headless */
+#endif /* HEADLESSUTILS_H_ */