diff --git a/README.md b/README.md index f596a3d..ac87305 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ docker run -d --restart always --name my-exporter -p 9439:9439 -v /path/to/my/co >docker run --name my-exporter -p 9439:9439 -v /path/to/my/conf:/app/.env --link my-wallet lepetitbloc/bitcoind-exporter >``` -## Example +## Example metrics When visiting the metrics URL http://localhost:9439/metrics the following **metrics** are produced: ``` # HELP best_block_index The block height or index @@ -105,6 +105,12 @@ address_balance_total{address="1FxZE15d8bt381EuDckdDdp7vw8FUiLzu6"} 41.00683469 address_balance_total{address="1QAm6J6jLmcm7ce87ujrSdmjPNX9fgRUYZ"} 1.72770032 ``` +## Demo +You can test this exporter with `docker-compose`: +``` +docker-compose up +``` + ## Resources * https://prometheus.io/ * https://en.bitcoin.it/wiki/API_reference_(JSON-RPC) diff --git a/docker-compose.yml b/docker-compose.yml index 5bdc520..7ab42db 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -13,6 +13,6 @@ services: exporter: build: . ports: - - "3000:3000" + - "9439:9439" links: - bitcoind \ No newline at end of file diff --git a/package.json b/package.json index 7658587..62424ae 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bitcoind-exporter", - "version": "2.3.3", + "version": "2.3.4", "description": "Bitcoind metrics prometheus exporter", "main": "index.js", "scripts": { @@ -8,7 +8,8 @@ "start": "node -r dotenv/config index.js", "build": "docker build -t lepetitbloc/bitcoind-exporter .", "push": "docker push lepetitbloc/bitcoind-exporter", - "publish": "npm run build && npm run test && npm run push" + "publish": "npm run build && npm run test && npm run push", + "demo": "docker-compose up" }, "repository": { "type": "git",