insomnia-plugin-usage-logger - npm Package Compare versions

Comparing version 1.0.5 to 1.0.6

package.json

 {
   "name": "insomnia-plugin-usage-logger",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "An Insomnia plugin for logging request and response details using Resurface. More info at: https://resurface.io",
@@ -50,3 +50,3 @@ "main": "./src/plugin.js",
     "publisher": {
-      "name": "resurface.io",
+      "name": "Graylog, Inc.",
       "icon": "https://raw.githubusercontent.com/resurfaceio/insomnia-plugin/master/assets/plugin/icon-alt.svg"
@@ -53,0 +53,0 @@ },

README.md

@@ -1,2 +0,2 @@
-# Resurface Insomnia Plugin
+# Graylog API Security Insomnia Plugin
 Easily log API requests and responses to your own <a href="https://resurface.io">security data lake</a>.
@@ -9,10 +9,17 @@
 
-- docker
-- [Resurface](https://resurface.io/installation) (free Docker container)
+- Kubernetes
+  - we officially support [microk8s](https://ubuntu.com/tutorials/install-a-local-kubernetes-with-microk8s), but
+  - if you have docker desktop, [you also have k8s](https://docs.docker.com/desktop/kubernetes/)!
+- [Graylog API Security](https://resurface.io/installation) -- first node is [free](https://go2.graylog.org/api-security-free)!
 
 ## Set up
 
-- Go to *Insomnia > Preferences > Plugins*, type in `insomnia-plugin-usage-logger` and click **Install Plugin**.
+- Go to *Insomnia > Preferences > Plugins*
+- Type in
+  ```
+  insomnia-plugin-usage-logger
+  ```
+- Click **Install Plugin**.
 
-  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/install_plugin.gif" width="768" height="400" />
+  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/insomnia_install.gif" width="768" height="498" />
 
@@ -22,3 +29,3 @@
 
-- Add the [variables](#environment-variables) used by the logger to your Base Environment (or create a separate new Sub Environment for them).
+- Add the [variables](#environment-variables) used by the logger to your Base Environment (or create a separate new Private/Shared environment for it).
 
@@ -32,3 +39,3 @@ ```json
 
-  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/insomnia_env.gif" width="768" height="400" />
+  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/insomnia_environment.gif" width="768" height="498" />
 
@@ -40,11 +47,11 @@
 
-- Make sure the plugin is enabled (also, if you created a new sub environment make sure to select it).
+- Make sure the plugin is enabled (also, if you created a new private/shared environment make sure to select it).
 - Use Insomnia as you would normally.
-- Go to `http://localhost:7700` to explore all your logs using the included <a href="https://resurface.io#explore">API Explorer</a>
+- Go to `http://localhost:7700` to explore all your logs using the included Graylog API Security web UI
 
-  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/insomnia_usage.gif" width="768" height="400" />
+  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/insomnia_usage.gif" width="768" height="498" />
 
 - You can always disable the plugin if you want stop logging API calls temporarily
 
-  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/insomnia_disable.gif" width="768" height="400" />
+  <img src="https://github.com/resurfaceio/insomnia-plugin/raw/master/assets/readme/insomnia_disable.gif" width="768" height="498" />
 
@@ -57,3 +64,3 @@ Happy loggin' 📝
 
-#### ✔ All API calls are sent to the database running inside the docker container
+#### ✔ All API calls are sent to the database running inside the `resurface` container
 The environment variable `USAGE_LOGGERS_URL` stores this address, which by default should be the string `"http://localhost:7701/message"`
@@ -60,0 +67,0 @@ #### ✔ All API calls are filtered using a set of rules (Optional)

No alert changes

Improved metrics

Number of lines in readme file

87

increased by8.75%

Worsened metrics

Total package byte prevSize

61618

decreased by-18.88%

No dependency changes