Update Readme, docker and packages (#8)

Author: mikhail-vl

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+
+## 2.0.0 (2021-10-11)
+
+### Features / Enhancements
+
+- Added Streaming dashboard
+- Update screenshots and dashboards for Grafana 8.2
+- Added demo on https://demo.volkovlabs.io
+
+## v1.0.0 (2020-07-12)
+
+### Features / Enhancements
+
+- Initial release

LICENSE

@@ -1,12 +1,11 @@
-# Pop-up store demo using RedisTimeSeries, RedisGears and Redis Data Source for Grafana</h1>
+# Pop-up store demo using RedisTimeSeries, RedisGears and Redis plugins for Grafana</h1>
 
 ![Pop-up](https://github.com/RedisTimeSeries/redis-pop-up-store/blob/master/images/pop-up.gif)
 
-[![Grafana 7](https://img.shields.io/badge/Grafana-7-orange)](https://www.grafana.com)
-[![RedisTimeSeries](https://img.shields.io/badge/RedisTimeSeries-inspired-yellowgreen)](https://oss.redislabs.com/redistimeseries/)
-[![RedisGears](https://img.shields.io/badge/RedisGears-powered-green)](https://oss.redislabs.com/redisgears/) [![Redis Data Source](https://img.shields.io/badge/dynamic/json?color=blue&label=Redis%20Data%20Source&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fredis-datasource)](https://grafana.com/grafana/plugins/redis-datasource) [![Redis Application](https://img.shields.io/badge/dynamic/json?color=blue&label=Redis%20Data%20Source&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fredis-app)](https://grafana.com/grafana/plugins/redis-app)
+[![Grafana 8](https://img.shields.io/badge/Grafana-8-orange)](https://www.grafana.com)
+[![Redis Data Source](https://img.shields.io/badge/dynamic/json?color=blue&label=Redis%20Data%20Source&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fredis-datasource)](https://grafana.com/grafana/plugins/redis-datasource) [![Redis Application](https://img.shields.io/badge/dynamic/json?color=blue&label=Redis%20Application&query=%24.version&url=https%3A%2F%2Fgrafana.com%2Fapi%2Fplugins%2Fredis-app)](https://grafana.com/grafana/plugins/redis-app)
 
-The Pop-up store demo is using [Redis Streams](https://redis.io/topics/streams-intro), [RedisTimeSeries](https://oss.redislabs.com/redistimeseries/), [RedisGears](https://oss.redislabs.com/redisgears/) and [Redis Datasource](https://github.com/RedisTimeSeries/grafana-redis-datasource) to visualize data pipeline in Grafana.
+The Pop-up store demo is using [Redis Streams](https://redis.io/topics/streams-intro), [RedisTimeSeries](https://oss.redis.com/redistimeseries/), [RedisGears](https://oss.redis.com/redisgears/) and [Redis plugins](https://redisgrafana.github.io) to visualize data pipeline in Grafana.
 
 ## How it works
 
@@ -50,7 +49,7 @@ gb.map(complete)
 gb.register(prefix='queue:orders', batch=3, trimStream=True)
 ```
 
-- Grafana query streams and Time-Series keys every 5 seconds to display samples using Grafana Redis Datasource.
+- Grafana query streams and Time-Series keys every 5 seconds to display samples using Grafana plugins.
 
 ## What is displayed on Grafana dashboard
 
@@ -70,29 +69,29 @@ gb.register(prefix='queue:orders', batch=3, trimStream=True)
 
 ## Start Redis with RedisTimeSeries and RedisGears modules installed and Grafana
 
-For detailed instructions please take a look at [redismod - a Docker image with select Redis Labs modules](https://hub.docker.com/r/redislabs/redismod).
-
 ```
-npm run start:docker
+npm run start
 ```
 
-## Register [StreamReaders](https://oss.redislabs.com/redisgears/readers.html#streamreader)
+## Register [StreamReaders](https://oss.redis.com/redisgears/readers.html#streamreader)
 
 Install Readers to add Time-Series and complete orders
 
 ```
-npm run register:gears
+npm run register
 ```
 
 ## Install [ioredis](https://github.com/luin/ioredis) module and run simulation
 
 Script `pop-up-store.js` will add customers to stream `queue:customers` and their orders to `queue:orders`.
 
 ```
-npm run start:simulation
+npm run simulation
 ```
 
-## Open Grafana Dashboard using browser http://localhost:3000
+## Grafana Dashboards
+
+Open Grafana Dashboard using browser http://localhost:3000
 
 ## Redis-cli
 

README.md

@@ -2,18 +2,14 @@ version: "3.4"
 
 services:
   redis:
-    container_name: redismod
-    image: redislabs/redismod:latest
+    container_name: redis
+    image: ghcr.io/redisgrafana/redis-prophet:latest
     ports:
       - "6379:6379"
-    # Uncomment and edit the local path in the following line to have
-    # Redis' data persisted to the host's filesystem.
-    # volumes:
-    #   - ./dump.rdb:/data/dump.rdb
 
   grafana:
     container_name: grafana
-    image: grafana/grafana:latest
+    image: ghcr.io/redisgrafana/redis-app:latest
     ports:
       - "3000:3000"
     environment:
@@ -22,9 +18,5 @@ services:
       - GF_AUTH_BASIC_ENABLED=false
       - GF_ENABLE_GZIP=true
       - GF_USERS_DEFAULT_THEME=light
-      - GF_INSTALL_PLUGINS=redis-app
     volumes:
       - ./provisioning:/etc/grafana/provisioning
-      - ./dashboards:/var/lib/grafana/dashboards
-      # Uncomment to preserve Grafana configuration
-      # - ./data:/var/lib/grafana

docker-compose.yml

@@ -1,5 +1,5 @@
 # Install StreamReader to add Queue to Time-Series
-cat gears/timeseries.py | docker exec -i redismod redis-cli -x RG.PYEXECUTE
+cat gears/timeseries.py | docker exec -i redis redis-cli -x RG.PYEXECUTE
 
 # Install StreamReader to complete orders
-cat gears/complete.py | docker exec -i redismod redis-cli -x RG.PYEXECUTE
+cat gears/complete.py | docker exec -i redis redis-cli -x RG.PYEXECUTE

gears-execute.sh

@@ -1,17 +1,19 @@
 {
   "author": "Mikhail Volkov",
   "dependencies": {
-    "ioredis": "^4.17.3"
+    "ioredis": "^4.17.3",
+    "lodash": "^4.17.21"
   },
   "description": "Pop-up store using RedisTimeSeries, RedisGears and Redis Datasource for Grafana",
   "license": "Apache-2.0",
   "name": "redis-pop-up-store",
   "scripts": {
-    "start:simulation": "npm i; node src/pop-up-store.js",
-    "start:docker": "docker-compose up",
-    "stop:docker": "docker-compose down",
-    "register:gears": "./gears-execute.sh && docker exec -it redismod redis-cli RG.DUMPREGISTRATIONS",
-    "redis-cli": "docker exec -it redismod redis-cli"
+    "redis-cli": "docker exec -it redis redis-cli",
+    "register": "./gears-execute.sh && docker exec -it redis redis-cli RG.DUMPREGISTRATIONS",
+    "simulation": "npm i; node src/pop-up-store.js",
+    "start": "docker-compose pull && docker-compose up",
+    "stop": "docker-compose down",
+    "upgrade": "yarn upgrade --latest"
   },
-  "version": "1.1.0"
+  "version": "2.0.0"
 }

package-lock.json

@@ -0,0 +1,83 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+"cluster-key-slot@^1.1.0":
+  "integrity" "sha512-2Nii8p3RwAPiFwsnZvukotvow2rIHM+yQ6ZcBXGHdniadkYGZYiGmkHJIbZPIV9nfv7m/U1IPMVVcAhoWFeklw=="
+  "resolved" "https://registry.npmjs.org/cluster-key-slot/-/cluster-key-slot-1.1.0.tgz"
+  "version" "1.1.0"
+
+"debug@^4.3.1":
+  "integrity" "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ=="
+  "resolved" "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz"
+  "version" "4.3.1"
+  dependencies:
+    "ms" "2.1.2"
+
+"denque@^1.1.0":
+  "integrity" "sha512-CYiCSgIF1p6EUByQPlGkKnP1M9g0ZV3qMIrqMqZqdwazygIA/YP2vrbcyl1h/WppKJTdl1F85cXIle+394iDAQ=="
+  "resolved" "https://registry.npmjs.org/denque/-/denque-1.5.0.tgz"
+  "version" "1.5.0"
+
+"ioredis@^4.17.3":
+  "integrity" "sha512-HxZHYYSC7URouhGKI7l7PhVuSMk6VcdnBMjUcIkW4DhKVqzutF7eixZHKHf51X0SCnbI0eljMtToEydCMIrA2g=="
+  "resolved" "https://registry.npmjs.org/ioredis/-/ioredis-4.24.6.tgz"
+  "version" "4.24.6"
+  dependencies:
+    "cluster-key-slot" "^1.1.0"
+    "debug" "^4.3.1"
+    "denque" "^1.1.0"
+    "lodash.defaults" "^4.2.0"
+    "lodash.flatten" "^4.4.0"
+    "p-map" "^2.1.0"
+    "redis-commands" "1.7.0"
+    "redis-errors" "^1.2.0"
+    "redis-parser" "^3.0.0"
+    "standard-as-callback" "^2.1.0"
+
+"lodash.defaults@^4.2.0":
+  "integrity" "sha1-0JF4cW/+pN3p5ft7N/bwgCJ0WAw="
+  "resolved" "https://registry.npmjs.org/lodash.defaults/-/lodash.defaults-4.2.0.tgz"
+  "version" "4.2.0"
+
+"lodash.flatten@^4.4.0":
+  "integrity" "sha1-8xwiIlqWMtK7+OSt2+8kCqdlph8="
+  "resolved" "https://registry.npmjs.org/lodash.flatten/-/lodash.flatten-4.4.0.tgz"
+  "version" "4.4.0"
+
+"lodash@^4.17.21":
+  "integrity" "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
+  "resolved" "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz"
+  "version" "4.17.21"
+
+"ms@2.1.2":
+  "integrity" "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w=="
+  "resolved" "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz"
+  "version" "2.1.2"
+
+"p-map@^2.1.0":
+  "integrity" "sha512-y3b8Kpd8OAN444hxfBbFfj1FY/RjtTd8tzYwhUqNYXx0fXx2iX4maP4Qr6qhIKbQXI02wTLAda4fYUbDagTUFw=="
+  "resolved" "https://registry.npmjs.org/p-map/-/p-map-2.1.0.tgz"
+  "version" "2.1.0"
+
+"redis-commands@1.7.0":
+  "integrity" "sha512-nJWqw3bTFy21hX/CPKHth6sfhZbdiHP6bTawSgQBlKOVRG7EZkfHbbHwQJnrE4vsQf0CMNE+3gJ4Fmm16vdVlQ=="
+  "resolved" "https://registry.npmjs.org/redis-commands/-/redis-commands-1.7.0.tgz"
+  "version" "1.7.0"
+
+"redis-errors@^1.0.0", "redis-errors@^1.2.0":
+  "integrity" "sha1-62LSrbFeTq9GEMBK/hUpOEJQq60="
+  "resolved" "https://registry.npmjs.org/redis-errors/-/redis-errors-1.2.0.tgz"
+  "version" "1.2.0"
+
+"redis-parser@^3.0.0":
+  "integrity" "sha1-tm2CjNyv5rS4pCin3vTGvKwxyLQ="
+  "resolved" "https://registry.npmjs.org/redis-parser/-/redis-parser-3.0.0.tgz"
+  "version" "3.0.0"
+  dependencies:
+    "redis-errors" "^1.0.0"
+
+"standard-as-callback@^2.1.0":
+  "integrity" "sha512-qoRRSyROncaz1z0mvYqIE4lCd9p2R90i6GxW3uZv5ucSu8tU7B5HXUP1gG8pVZsYNVaXjk8ClXHPttLyxAL48A=="
+  "resolved" "https://registry.npmjs.org/standard-as-callback/-/standard-as-callback-2.1.0.tgz"
+  "version" "2.1.0"