whk - npm Package Compare versions

Comparing version 1.1.3 to 1.1.4

cli.js

@@ -16,2 +16,3 @@ #!/usr/bin/env node
    .option('insecure', {alias:'k', demandOption:false, default:false, describe:'Whether to allow insecure (bad TLS certificate/mismatch hostname) connections.'})
+   .option('json', {demandOption:false, default:false, describe:'Print data out in JSON format. Note: time is expressed as an array [s, ns] (see process.hrtime)'})
    .option('version', {alias:'v', describe:'display version'})
@@ -30,3 +31,3 @@ .wrap(yargs.terminalWidth())
 if(argv._.length === 0) {
-  console.log('No URL was specified. Usage: whk https://www.google.com')
+  console.log('No URL was specified. Usage: whk https://www.website.com')
   process.exit(1)
@@ -84,31 +85,56 @@ }
         whack.est_sample_size(whack.std_time(tts))
-    ) / 4) 
-    let table = new Table({
-        chars: {
-          'top':'', 'top-mid':'', 'top-left':'', 'top-right':'', 
-          'bottom':'', 'bottom-mid':'', 'bottom-left':'', 'bottom-right':'', 
-          'left':'', 'left-mid':'', 'mid':'', 'mid-mid':'', 
-          'right':'', 'right-mid':'', 'middle':' '
-        },
-        style: { 'padding-left': 1, 'padding-right': 1 }
-    })
-    table.push(['Stat','Avg','Min','Max','+/- σ','+/- ci(95%)', 'Request%']);
-    table.push(format('DNS', dns, tts))
-    table.push(format('Connect', cts, tts))
-    table.push(format('TLS', tls, tts))
-    table.push(format('TTFB', ttfbs, tts))
-    table.push(format('TTLB', ttlbs, tts))
-    table.push(format('Total', tts, tts))
-    console.log()
-    console.log(table.toString())
-    console.log()
-    console.log(' ' + responded + ' requests in ' + whack.format_time(done_time) + ' (' + whack.format_bytes(total_bytes) + ' received)')
-    console.log(' Requests/sec:', whack.two_decimals(responded/whack.to_number(done_time)))
-    console.log(' Transfer/sec:', whack.format_bytes(total_bytes/whack.to_number(done_time)))
-    if(avg_est_samples > responded) {
+    ) / 4)
+    let too_little_samples = avg_est_samples > responded
+    let print_table = function() {
+      let table = new Table({
+          chars: {
+            'top':'', 'top-mid':'', 'top-left':'', 'top-right':'', 
+            'bottom':'', 'bottom-mid':'', 'bottom-left':'', 'bottom-right':'', 
+            'left':'', 'left-mid':'', 'mid':'', 'mid-mid':'', 
+            'right':'', 'right-mid':'', 'middle':' '
+          },
+          style: { 'padding-left': 1, 'padding-right': 1 }
+      })
+      table.push(['Stat','Avg','Min','Max','+/- σ','+/- ci(95%)', 'Request%']);
+      table.push(format('DNS', dns, tts))
+      table.push(format('Connect', cts, tts))
+      table.push(format('TLS', tls, tts))
+      table.push(format('TTFB', ttfbs, tts))
+      table.push(format('TTLB', ttlbs, tts))
+      table.push(format('Total', tts, tts))
       console.log()
-      console.log('Warning: you may need to increase the amount of tests (-a) as it')
-      console.log('has too much variance to be reliable, recommended size:', avg_est_samples)
+      console.log(table.toString())
+      console.log()
+      console.log(' ' + responded + ' requests in ' + whack.format_time(done_time) + ' (' + whack.format_bytes(total_bytes) + ' received)')
+      console.log(' Requests/sec:', whack.two_decimals(responded/whack.to_number(done_time)))
+      console.log(' Transfer/sec:', whack.format_bytes(total_bytes/whack.to_number(done_time)))
+      if(too_little_samples) {
+        console.log()
+        console.log('Warning: you may need to increase the amount of tests (-a) as it')
+        console.log('has too much variance to be reliable, recommended size:', avg_est_samples)
+      }
+      console.log()
     }
-    console.log()
+    let print_json = function() {
+      console.log(JSON.stringify({
+        data:{
+          dns:{raw:dns, avg:whack.avg_time(dns), min:whack.min_time(dns), max:whack.max_time(dns), std:whack.std_time(dns), ci:whack.confidence_interval(dns)},
+          cts:{raw:cts, avg:whack.avg_time(cts), min:whack.min_time(cts), max:whack.max_time(cts), std:whack.std_time(cts), ci:whack.confidence_interval(cts)},
+          tls:{raw:tls, avg:whack.avg_time(tls), min:whack.min_time(tls), max:whack.max_time(tls), std:whack.std_time(tls), ci:whack.confidence_interval(tls)},
+          ttfb:{raw:ttfbs, avg:whack.avg_time(ttfbs), min:whack.min_time(ttfbs), max:whack.max_time(ttfbs), std:whack.std_time(ttfbs), ci:whack.confidence_interval(ttfbs)},
+          ttlb:{raw:ttlbs, avg:whack.avg_time(ttlbs), min:whack.min_time(ttlbs), max:whack.max_time(ttlbs), std:whack.std_time(ttlbs), ci:whack.confidence_interval(ttlbs)},
+        },
+        requests:responded,
+        time:done_time,
+        bytes:total_bytes,
+        needed_samples:avg_est_samples,
+        too_little_samples:too_little_samples
+      }, null, 2))
+    }
+    if(argv.json) {
+      print_json()
+    } else {
+      print_table()
+    }
+
   } else {
@@ -142,6 +168,6 @@ run();
 }
-
-console.log('Running ' + expected + ' tests @ ' + url)
-console.log('Concurrently running ' + allowed + ' tests')
-
+if(!argv.json) {
+  console.log('Running ' + expected + ' tests @ ' + url)
+  console.log('Concurrently running ' + allowed + ' tests')
+}
 run();
@@ -148,0 +174,0 @@

index.js

@@ -127,5 +127,13 @@ const https   = require('https')
     options.headers = headers;
+  } else {
+    options.headers = {};
   }
   options.method = method;
 
+  // Provide a default user agent otherwise some HTTP proxies will 
+  // break.
+  if(!options.headers['user-agent'] || !options.headers['User-Agent']) {
+    options.headers['user-agent'] = 'whack';
+  }
+
   let request = connector.request(options, (res) => {
@@ -132,0 +140,0 @@

package.json

 {
   "name": "whk",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "description": "Modern HTTP/TLS benchmarking tool",
@@ -11,8 +11,8 @@ "main": "index.js",
   "license": "MIT",
-  "bin":{
-    "whk":"./cli.js"
+  "bin": {
+    "whk": "./cli.js"
   },
-  "repository":{
-    "type":"git",
-    "url":"https://github.com/trevorlinton/whack"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/trevorlinton/whack"
   },
@@ -19,0 +19,0 @@ "dependencies": {

README.md

@@ -61,11 +61,12 @@ # whk - A modern HTTP/TLS benchmarking tool
 ```bash
-  -a, --amount 		The amount of samples to take.
+  -a, --amount      The amount of samples to take.
   -c, --concurrent  Maximum amount of samples to allow at once
   -X                The method to use for the requests
   -H                Add headers to the request
-  -d, --data 		The data to include in the body of the request
+  -d, --data        The data to include in the body of the request
   --keep-alive      Whether to keep alive socket connections
   --no-delay        Whether to buffer read and write data (TCP_NO_DELAY)
-  --insecure, -k    Whether to allow insecure (bad TLS certificate/mismatch hostname) connections.                                              
+  --insecure, -k    Whether to allow insecure (bad TLS certificate/mismatch hostname) connections.    
+  --json            Print data out in JSON format. Note: time is expressed as an array [s, ns] (see process.hrtime)
   --help            Show help
 ```

No alert changes

Improved metrics

Total package byte prevSize

18018

increased by11.42%

Lines of code

333

increased by11.37%

Number of lines in readme file

72

increased by1.41%

No dependency changes