perfrep Host Performance Report in Percent

Author: omrilotan

.circleci/config.yml

@@ -1,7 +1,7 @@
 defaults: &defaults
   working_directory: ~/app
   docker:
-    - image: circleci/node:10.2-browsers
+    - image: circleci/node:10-browsers
 
 version: 2
 jobs:

packages/perfrep/.npmignore

@@ -0,0 +1,3 @@
+.*
+*.log
+spec.js

packages/perfrep/.npmrc

@@ -0,0 +1 @@
+package-lock=false

packages/perfrep/README.md

@@ -0,0 +1,18 @@
+# perfrep [![](https://img.shields.io/npm/v/perfrep.svg)](https://www.npmjs.com/package/perfrep) [![](https://img.shields.io/badge/source--000000.svg?logo=github&style=social)](https://github.com/omrilotan/mono/tree/master/packages/perfrep)
+
+Host Performance Report in Percent
+
+```js
+const perfrep = require('perfrep');
+
+const {cpu, memory, heap} = await perfrep();
+
+// log to statsd for example
+logMetrics(
+	...Object.entries(await perfrep())
+		.map(
+			([key, value]) => `application.host_perf.${key}_usage:${value}|ms|@0.1`
+		)
+	)
+);
+```

packages/perfrep/index.js

@@ -0,0 +1,52 @@
+const {
+	cpus,
+	freemem,
+	totalmem,
+} = require('os');
+
+/**
+* Get CPU and memory usage in percent (async). Takes about a second
+* @return {Object} {cpu: Float, memory: Float}
+*/
+module.exports = async function usage(){
+	const before = info();
+	await wait(1000);
+	const after = info();
+	const {heapUsed, heapTotal} = process.memoryUsage();
+
+	return {
+		cpu: percent(after.idle - before.idle, after.total - before.total),
+		memory: 100 - percent(freemem(), totalmem()),
+		heap: percent(heapUsed, heapTotal),
+	};
+}
+
+/**
+* Get current idle and total CPU usage
+* @return {Object} {idle: Integer, total: Integer}
+*/
+const info = () => cpus().reduce(
+	(accumulator, {times: {user, nice, sys, irq, idle}}) => ({
+		idle: accumulator.idle + idle,
+		total: accumulator.total + user + nice + sys + irq + idle,
+	}),
+	{
+		idle: 0,
+		total: 0,
+	}
+);
+
+/**
+* A waiting promise
+* @param  {Number} ms
+* @return {Promise}
+*/
+const wait = ms => new Promise(resolve => setTimeout(resolve, ms));
+
+/**
+ * Calculate percent of a pert from the whole
+ * @param  {Number} part
+ * @param  {Number} whole
+ * @return {Number}
+ */
+const percent = (part, whole) => Math.round(part / whole * 100);

packages/perfrep/package.json

@@ -0,0 +1,27 @@
+{
+	"name": "perfrep",
+	"version": "0.1.0",
+	"description": "Host Performance Report in Percent",
+	"keywords": [
+		"cpu",
+		"heap",
+		"mem",
+		"memory",
+		"performance",
+		"report",
+		"monitoring",
+		"usage",
+		"stats"
+	],
+	"author": "omrilotan",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/omrilotan/mono.git"
+	},
+	"homepage": "https://omrilotan.com/mono/perfrep/",
+	"main": "index.js",
+	"scripts": {
+		"test": "cd ../../; npm t perfrep; cd -"
+	}
+}

packages/perfrep/spec.js

@@ -0,0 +1,45 @@
+const perfrep = require('.');
+
+describe('notate', async() => {
+	it('Should return numeric results in percent (between 0 and 100)', async() => {
+		const {cpu, memory, heap} = await perfrep();
+
+		expect(cpu).to.be.at.least(0);
+		expect(cpu).to.be.at.most(100);
+		expect(memory).to.be.at.least(0);
+		expect(memory).to.be.at.most(100);
+		expect(heap).to.be.at.least(0);
+		expect(heap).to.be.at.most(100);
+	});
+	it('Should take about a second', async() => {
+		let cpu, memory, heap;
+		async function results() {
+			const results = await perfrep();
+			cpu = results.cpu;
+			memory = results.memory;
+			heap = results.heap;
+		}
+
+		expect(cpu).to.not.be.a('number');
+		expect(memory).to.not.be.a('number');
+		expect(heap).to.not.be.a('number');
+
+		results();
+
+		expect(cpu).to.not.be.a('number');
+		expect(memory).to.not.be.a('number');
+		expect(heap).to.not.be.a('number');
+
+		await sleep(100);
+
+		expect(cpu).to.not.be.a('number');
+		expect(memory).to.not.be.a('number');
+		expect(heap).to.not.be.a('number');
+
+		await sleep(1000);
+
+		expect(cpu).to.be.a('number');
+		expect(memory).to.be.a('number');
+		expect(heap).to.be.a('number');
+	});
+});