Skip to content

Commit

Permalink
Merge pull request #14 from kanga333/update-readme-for-v3
Browse files Browse the repository at this point in the history
Update readme for v3
  • Loading branch information
jirwin authored Mar 17, 2018
2 parents af62c34 + 0e69a7f commit 65ce76d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
3 changes: 2 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ COPY --from=glide /go/src/github.com/jirwin/burrow_exporter/burrow-exporter .
ENV BURROW_ADDR http://localhost:8000
ENV METRICS_ADDR 0.0.0.0:8080
ENV INTERVAL 30
CMD ./burrow-exporter --burrow-addr $BURROW_ADDR --metrics-addr $METRICS_ADDR --interval $INTERVAL
ENV API_VERSION 2
CMD ./burrow-exporter --burrow-addr $BURROW_ADDR --metrics-addr $METRICS_ADDR --interval $INTERVAL --api-version $API_VERSION
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,22 @@ An address to run prometheus on is required. Default: 0.0.0.0:8080
#### INTERVAL
A scrape interval is required. Default: 30

#### API_VERSION
Burrow API version to leverage (default: 2)

### Example

```sh
# build docker image
docker build -t burrow_exporter .

# with env variables
docker run \
docker run -d -p 8080:8080 \
-e BURROW_ADDR="http://localhost:8000" \
-e METRICS_ADDR="0.0.0.0:8080" \
-e INTERVAL="30" \
saada/burrow_exporter
-e API_VERSION="2" \
burrow_exporter
# with custom command
docker run -d saada/burrow_exporter ./burrow-exporter --burrow-addr http://localhost:8000 --metrics-addr 0.0.0.0:8080 --interval 30
docker run -d burrow_exporter -p 8080:8080 ./burrow-exporter --burrow-addr http://localhost:8000 --metrics-addr 0.0.0.0:8080 --interval 30 --api-version 2
```

0 comments on commit 65ce76d

Please sign in to comment.