New file: README.md

README.md

@@ -0,0 +1,47 @@
+# PromQueen
+**PromQueen** made possible to record _prometheus_ metrics offline.
+**PromQueen** can, therefore, backfill the recorded data inside a native _prometheus_ database.
+
+**PromQueen** is composed of two primary tools:
+
+- `promrec` tapes the metrics in a specified output file.
+- `promplay` backfills the _prometheus_ database from scratch.
+
+## PromREC
+
+```
+usage: promrec [<flags>]
+
+Flags:
+      --help              Show context-sensitive help (also try --help-long and --help-man).
+      --debug             Enable debug mode.
+      --gzip              Disable gzip mode.
+  -i, --interval=60s      Timeout waiting for ping.
+  -u, --umap=UMAP ...     stringmap [eg. service.name=http://get.uri:port/uri].
+  -o, --output="metrics"  Output file.
+      --version           Show application version.
+```
+
+## PromPLAY
+
+```
+usage: promplay [<flags>]
+
+Flags:
+      --help                 Show context-sensitive help (also try --help-long and --help-man).
+      --debug                Enable debug mode.
+      --nopromcfg            Disable the generation of the prometheus cfg file (prometheus.yml)
+  -d, --dir="/tmp"           Input directory.
+      --version              Show application version.
+      --storage.path="data"  Directory path to create and fill the data store under.
+      --storage.retention-period=360h  
+                             Period of time to store data for
+      --storage.checkpoint-interval=30m  
+                             Period of time to store data for
+      --storage.checkpoint-dirty-series-limit=10000  
+                             Period of time to store data for
+```
+
+### Notes
+
+As of today **PromQueen** only supports backfilling inside _prometheus_ local storage. New storage types such as influxdb are not supported.