Update READM to update packages (#18)

Author: mikhail-vl

.gitignore

@@ -1,2 +1,3 @@
 node_modules/
 .DS_Store
+data/

README.md

@@ -38,12 +38,42 @@ docker run -p 6379:6379 --name=redis-jsg ghcr.io/redisgrafana/redis-jsg:latest
 
 ## Collect statistics
 
-Collect and store statistics for all Grafana plugins using [RedisTimeSeries](https://oss.redis.com/redistimeseries/).
+Collect and store statistics for all Grafana plugins using [RedisTimeSeries](https://oss.redis.com/redistimeseries/) and RedisJSON modules.
 
 ```bash
 node src/stats.ts
 ```
 
+## Create RediSearch index to search plugins
+
+RediSearch does not support JSON array, which means that JSON with all plugins should be separated to individial JSON keys and the easiest way to do it is using RedisGears.
+
+```
+import json
+
+
+def update(x):
+    """
+    Update plugins
+    """
+    j = json.loads(execute('json.get', x['key'], '.items'))
+    for i in j:
+        execute('SADD', 'set:plugins', i['slug'])
+        execute("JSON.SET", "plugin:" + i['slug'], ".", json.dumps(i))
+
+
+gb = GearsBuilder('KeysReader')
+gb.map(update)
+gb.register(prefix='plugins')
+```
+
+This RedisGears script automatically parse and updates indivial plugins keys when `plugins` key updated every hour.
+To create RediSearch schema:
+
+```
+FT.CREATE pluginIdx ON JSON SCHEMA $.name AS name TEXT $.description AS description TEXT
+```
+
 ## Visualize data
 
 To visualize the collected data start Docker containers:

package.json

@@ -2,11 +2,11 @@
   "author": "Volkov Labs",
   "dependencies": {
     "axios": "^0.24.0",
-    "ioredis": "^4.28.0"
+    "ioredis": "^4.28.2"
   },
   "description": "How many times Redis Data Source for Grafana was downloaded?",
   "devDependencies": {
-    "@types/node": "^16.11.9"
+    "@types/node": "^16.11.12"
   },
   "license": "Apache-2.0",
   "name": "grafana-plugin-stats",

provisioning/datasources/redis.yaml

@@ -9,7 +9,7 @@ datasources:
     version: 1
     url: redis://host.docker.internal:6379
     editable: true
-  - name: RedisMod
+  - name: RedisJSG
     type: redis-datasource
     access: proxy
     orgId: 1

yarn.lock

@@ -2,10 +2,10 @@
 # yarn lockfile v1
 
 
-"@types/node@^16.11.9":
-  version "16.11.9"
-  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.11.9.tgz#879be3ad7af29f4c1a5c433421bf99fab7047185"
-  integrity sha512-MKmdASMf3LtPzwLyRrFjtFFZ48cMf8jmX5VRYrDQiJa8Ybu5VAmkqBWqKU8fdCwD8ysw4mQ9nrEHvzg6gunR7A==
+"@types/node@^16.11.12":
+  version "16.11.12"
+  resolved "https://registry.yarnpkg.com/@types/node/-/node-16.11.12.tgz#ac7fb693ac587ee182c3780c26eb65546a1a3c10"
+  integrity sha512-+2Iggwg7PxoO5Kyhvsq9VarmPbIelXP070HMImEpbtGCoyWNINQj4wzjbQCXzdHTRXnqufutJb5KAURZANNBAw==
 
 axios@^0.24.0:
   version "0.24.0"
@@ -20,9 +20,9 @@ cluster-key-slot@^1.1.0:
   integrity sha512-2Nii8p3RwAPiFwsnZvukotvow2rIHM+yQ6ZcBXGHdniadkYGZYiGmkHJIbZPIV9nfv7m/U1IPMVVcAhoWFeklw==
 
 debug@^4.3.1:
-  version "4.3.2"
-  resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.2.tgz#f0a49c18ac8779e31d4a0c6029dfb76873c7428b"
-  integrity sha512-mOp8wKcvj7XxC78zLgw/ZA+6TSgkoE2C/ienthhRD298T7UNwAg9diBpLRxC0mOezLl4B0xV7M0cCO6P/O0Xhw==
+  version "4.3.3"
+  resolved "https://registry.yarnpkg.com/debug/-/debug-4.3.3.tgz#04266e0b70a98d4462e6e288e38259213332b664"
+  integrity sha512-/zxw5+vh1Tfv+4Qn7a5nsbcJKPaSvCDhojn6FEl9vupwK2VCSDtEiEtqr8DFtzYFOdz63LBkxec7DYuc2jon6Q==
   dependencies:
     ms "2.1.2"
 
@@ -36,10 +36,10 @@ follow-redirects@^1.14.4:
   resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.5.tgz#f09a5848981d3c772b5392309778523f8d85c381"
   integrity sha512-wtphSXy7d4/OR+MvIFbCVBDzZ5520qV8XfPklSN5QtxuMUJZ+b0Wnst1e1lCDocfzuCkHqj8k0FpZqO+UIaKNA==
 
-ioredis@^4.28.0:
-  version "4.28.0"
-  resolved "https://registry.yarnpkg.com/ioredis/-/ioredis-4.28.0.tgz#5a2be3f37ff2075e2332f280eaeb02ab4d9ff0d3"
-  integrity sha512-I+zkeeWp3XFgPT2CtJKxvaF5FjGBGt4yGYljRjQecdQKteThuAsKqffeF1lgHVlYnuNeozRbPOCDNZ7tDWPeig==
+ioredis@^4.28.2:
+  version "4.28.2"
+  resolved "https://registry.yarnpkg.com/ioredis/-/ioredis-4.28.2.tgz#493ccd5d869fd0ec86c96498192718171f6c9203"
+  integrity sha512-kQ+Iv7+c6HsDdPP2XUHaMv8DhnSeAeKEwMbaoqsXYbO+03dItXt7+5jGQDRyjdRUV2rFJbzg7P4Qt1iX2tqkOg==
   dependencies:
     cluster-key-slot "^1.1.0"
     debug "^4.3.1"