From 0c845852afe87b23fb2d5aa02b1453d102bca8bc Mon Sep 17 00:00:00 2001 From: SuperQ Date: Tue, 28 Dec 2021 14:24:40 +0100 Subject: [PATCH] Update README * Add status badges. * Add simple Docker command line. Signed-off-by: SuperQ --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6b588f7..f6de092 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ # smokeping_prober + +[![CircleCI](https://circleci.com/gh/SuperQ/smokeping_prober/tree/master.svg?style=svg)](https://circleci.com/gh/SuperQ/smokeping_prober/tree/master) +[![Docker Repository on Quay](https://quay.io/repository/superq/smokeping-prober/status "Docker Repository on Quay")](https://quay.io/repository/superq/smokeping-prober) + Prometheus style "smokeping" prober. ![Example Graph](example-graph.png) @@ -61,10 +65,20 @@ NOTE: The config is only read on startup, SIGHUP is not supported (yet). Requires Go >= 1.14 ```console -go get github.com/superq/smokeping_prober +go install github.com/superq/smokeping_prober@latest sudo setcap cap_net_raw=+ep ${GOPATH}/bin/smokeping_prober ``` +## Docker + +```bash +docker run \ + -p 9374:9374 \ + --privileged \ + quay.io/superq/smokeping-prober:latest \ + some-ping-target.example.com +``` + ## Metrics Metric Name | Type | Description