Add example database and make target to run demo

matchilling · matchilling · commit db4dd2200f6c · 2019-04-16T14:33:24.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -225,5 +225,6 @@ typings/
 # End of https://www.gitignore.io/api/node,intellij,webstorm
 
 *.db
+!data/example.db
 
-dist
+dist
diff --git a/Makefile b/Makefile
@@ -0,0 +1,32 @@
+.PHONY: default
+default: help;
+
+CARBON_PLAINTEXT_PORT :=2003
+STACK_SLUG := 'github-pr-metrics-graphite-exporter'
+
+help:     ## Show this help
+	@echo '----------------------------------------------------------------------'
+	@echo $(STACK_SLUG)
+	@echo '----------------------------------------------------------------------'
+	@fgrep -h "##" $(MAKEFILE_LIST) | fgrep -v fgrep | sed -e 's/\\$$//' | sed -e 's/##//'
+	@echo '----------------------------------------------------------------------'
+
+test:     ## Execute tests
+	@npm test
+
+run:      ## Builds and runs the graphite stack with some sample data
+	@docker run -d \
+	  --name $(STACK_SLUG)\
+	  --restart=always\
+	  -p 80:80\
+	  -p $(CARBON_PLAINTEXT_PORT)-2004:$(CARBON_PLAINTEXT_PORT)-2004\
+	  -p 2023-2024:2023-2024\
+	  -p 8125:8125/udp\
+	  -p 8126:8126\
+	  graphiteapp/graphite-statsd
+	@npm install
+	@PULL_REQUESTS_DATABASE_PATH=data/example.db npm start | nc localhost $(CARBON_PLAINTEXT_PORT)
+	@open 'http://localhost/?target=prs.time_to_merge&from=00%3A00_20190101&until=23%3A59_20190416'
+
+stop:     ## Stop the graphite stack
+	@docker stop github-pr-metrics-graphite-exporter
diff --git a/README.md b/README.md
@@ -1,33 +1,25 @@
-# Github PR metrics graphite exporter
+# Github PR Metrics Graphite Exporter
 
-### Description
-Converts raw github PR data to time series.
-
-The data point is the number of seconds elapsed between the creation of the PR and the merging of the PR.
+This exporter converts raw GitHub pull request data to time series. The exported data points represent the number of seconds elapsed between the creation of the pull request and the merging of the pull request.
 
 The timestamp is the creation time of the PR.
 
-Metrics name: `prs.time_to_merge`
+Exposed metrics name: `prs.time_to_merge`
 
-### Example output:
+## Usage
 
-```
-prs.time_to_merge 3450 1554125772
-prs.time_to_merge 935617 1553187544
-```
+```sh
+$ npm install
 
-### Requirements
-Node v10+
+# Path to the SQLite db file containing the PR data retrieved from GitHub.
+$ export PULL_REQUESTS_DATABASE_PATH=data/example.db
 
-### Installation
-`npm install`
+$ npm start
 
-### Required environment variables
-`PULL_REQUESTS_DATABASE_PATH`: path to the SQLite db file containing the PR data retrieved from GitHub. 
-
-###Usage
-```
-PULL_REQUESTS_DATABASE_PATH=sample.db node ./node_modules/ts-node/dist/bin.js src/index.ts
+# The generated time series will be written to `stdout`.
+# prs.time_to_merge 3450 1554125772
+# prs.time_to_merge 935617 1553187544
+# ...
 ```
 
-The generated time series will be written to `stdout`.
+If you have docker installed, try `make run` to explore the metric, the target which spins up a Graphite stack and injects some [sample data](./data/example.db). The Graphite UI is being exposed on [localhost:80](http://localhost).
diff --git a/data/example.db b/data/example.db
diff --git a/package.json b/package.json
@@ -4,9 +4,9 @@
   "description": "",
   "main": "index.ts",
   "scripts": {
-    "start": "ts-node src/index.ts",
-    "test": "jest",
-    "tsc": "tsc"
+    "dist": "tsc",
+    "start": "node ./node_modules/.bin/ts-node src/index.ts",
+    "test": "node ./node_modules/.bin/jest"
   },
   "author": "Csongor Zalatnai",
   "license": "ISC",
