From 594d9f26a115d0d4c70dcc8854a4dcacabce57fa Mon Sep 17 00:00:00 2001 From: Hector Date: Thu, 22 Jun 2023 14:22:31 +0000 Subject: [PATCH] chore: rename examples folder (!94) * Rename the `examples` folder to `_examples` to distinguish it from source code folders https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/merge_requests/94 --- README.md | 5 ++++- {examples => _examples}/grafana/dashboard.json | 0 {examples => _examples}/systemd/README.md | 0 {examples => _examples}/systemd/fail2ban_exporter.service | 0 4 files changed, 4 insertions(+), 1 deletion(-) rename {examples => _examples}/grafana/dashboard.json (100%) rename {examples => _examples}/systemd/README.md (100%) rename {examples => _examples}/systemd/fail2ban_exporter.service (100%) diff --git a/README.md b/README.md index 33fbd9c..585f083 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,9 @@ $ fail2ban_exporter --collector.f2b.socket=/var/run/fail2ban/fail2ban.sock --web Binary files for each release can be found on the [releases](https://gitlab.com/hectorjsmith/fail2ban-prometheus-exporter/-/releases) page. +There is also an [example systemd service file](/_examples/systemd/fail2ban_exporter.service) included in the repository. +This is a starting point to run the exporter as a service. + ### 1.2. Docker **Docker run** @@ -100,7 +103,7 @@ Status for the jail: sshd ### 2.1. Grafana The metrics exported by this tool are compatible with Prometheus and Grafana. -A sample grafana dashboard can be found in the [grafana.json](/examples/grafana/dashboard.json) file. +A sample grafana dashboard can be found in the [grafana.json](/_examples/grafana/dashboard.json) file. Just import the contents of this file into a new Grafana dashboard to get started. The dashboard supports displaying data from multiple exporters. Use the `instance` dashboard variable to select which ones to display. diff --git a/examples/grafana/dashboard.json b/_examples/grafana/dashboard.json similarity index 100% rename from examples/grafana/dashboard.json rename to _examples/grafana/dashboard.json diff --git a/examples/systemd/README.md b/_examples/systemd/README.md similarity index 100% rename from examples/systemd/README.md rename to _examples/systemd/README.md diff --git a/examples/systemd/fail2ban_exporter.service b/_examples/systemd/fail2ban_exporter.service similarity index 100% rename from examples/systemd/fail2ban_exporter.service rename to _examples/systemd/fail2ban_exporter.service