Skip to content

Commit

Permalink
Update readme for docker
Browse files Browse the repository at this point in the history
  • Loading branch information
horazont committed Jul 2, 2019
1 parent 2b18465 commit ecfad11
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Prometheus XMPP Blackbox Exporter

[![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/xsfjonas/prometheus-xmpp-blackbox-exporter.svg)](https://hub.docker.com/r/xsfjonas/prometheus-xmpp-blackbox-exporter)

This project is a [Prometheus exporter](https://prometheus.io/docs/instrumenting/exporters/)
which allows to probe XMPP services and export metrics from the probes to
Prometheus.
Expand All @@ -16,12 +18,22 @@ See also the [example configuration](example.yml).

## Build & Usage

### Building from Source

```
$ export GO111MODULE=on
$ go build cmd/prometheus-xmpp-blackbox-exporter/xmpp_blackbox_exporter.go
$ ./xmpp_blackbox_exporter -config.file example.yml
```

### Running using Docker

```
$ docker run --rm -p 9604:9604 horazont/prometheus-xmpp-blackbox-exporter:latest
```

### Example Probe

Issue an example probe:

```
Expand Down

0 comments on commit ecfad11

Please sign in to comment.