diff options
Diffstat (limited to 'python/knot_exporter/README.md')
| -rw-r--r-- | python/knot_exporter/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/python/knot_exporter/README.md b/python/knot_exporter/README.md new file mode 100644 index 0000000..5b09c2d --- /dev/null +++ b/python/knot_exporter/README.md @@ -0,0 +1,20 @@ +# knot-exporter + +A Prometheus exporter for [Knot DNS](https://www.knot-dns.cz/)'s server and query statistics. + +# Getting Started + +The Knot instance also needs to be configured to collect statistics using +[Statistics module](https://www.knot-dns.cz/docs/latest/html/modules.html?highlight=mod%20stats#stats-query-statistics) + +The exporter can be started via: + +```bash +$ knot-exporter +``` + +To get a complete list of the available options, run: + +```bash +$ knot-exporter --help +``` |