connectivity-test - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

config/common.json

@@ -9,3 +9,4 @@ {
       "clientId": "connectivity-tester"
-    }
+    },
+    "dismiss-failed-calls": false
   },
@@ -20,4 +21,3 @@ "test-plan": {
     "speed-test": {}
-  },
-  "dismiss-failed-calls": false
+  }
 }

modules/aws-api/index.js

@@ -14,3 +14,3 @@ const AWS      = require('aws-sdk');
 const region     = nconf.get('aws:global:region');
-const skipFailed = nconf.get('dismiss-failed-calls');
+const skipFailed = nconf.get('aws:dismiss-failed-calls');
 
@@ -17,0 +17,0 @@ /**

package.json

 {
   "name": "connectivity-test",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Assesses the connectivity between a host, Internet, and AWS services.",
@@ -5,0 +5,0 @@ "author": "Halim Qarroum <[e-mail]>",

README.md

@@ -10,3 +10,3 @@ <p align="center">
 
-Current version: **1.0.6**
+Current version: **1.0.7**
 
@@ -19,2 +19,3 @@ Lead Maintainer: [Halim Qarroum](mailto:[e-mail])
 - [Features](#features)
+- [Metrics](#metrics)
 - [Description](#description)
@@ -39,2 +40,13 @@ - [Usage](#usage)
 
+## Metrics
+
+The below metrics displays approximate values associated with deploying and using this block.
+
+Metric | Value
+------ | ------
+**Type** | Tool
+**Installation Time** | Less than 1 minute
+**Requirements** | [aws-cli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html), [npm](https://www.npmjs.com/get-npm)
+**Audience** | Any individual using AWS services
+
 ## Description
@@ -176,2 +188,10 @@
 
+### Dismiss failed calls
+
+When using `contest` using credentials which are bound to specific permissions, the output can become full of errors for each AWS service for which `contest` does not currently have access to using the current AWS credentials. To alleviate this issue, you can use the `--aws:dismiss-failed-calls` to mask the calls to AWS services which have failed and only display the ones that have succeeded.
+
+```bash
+contest --aws:dismiss-failed-calls
+```
+
 ## Supported Services
@@ -178,0 +198,0 @@

No alert changes

Improved metrics

Total package byte prevSize

739991

increased by0.12%

Number of lines in readme file

239

increased by9.13%

No dependency changes