From 4099a9a5fb371579161f5859190c3d89f9f988f9 Mon Sep 17 00:00:00 2001
From: "Christian P. MOMON" <christian.momon@devinsy.fr>
Date: Sat, 15 Jan 2022 00:49:12 +0100
Subject: [PATCH] Added metrics configuration templates in README.

---
 README.md | 100 ++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 94 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 9d59708..5ee62da 100644
--- a/README.md
+++ b/README.md
@@ -19,7 +19,6 @@ I am glad to use the beautiful artwork of David Revoy (http://www.peppercarrot.c
 * Source: https://framagit.org/Deevad/cat-avatar-generator
 * Originally inspired of the code for "MonsterID" by Andreas Gohr http://www.splitbrain.org/go/monsterid.
 
-
 ### Cicle-icons
 
 I am glad to use the generous artwork of ElegantThemes.com :
@@ -90,15 +89,19 @@ Usage:
 ```
 
 
-### Generate metrics files
+## Generate metrics files
+
+### Basics
 
 Create a configuration file `/srv/statoolInfos/conf/foo.bar.org.conf`:
 
 ```
-conf.probe.types=HttpAccessLog, HttpErrorLog
-conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
-conf.probe.httperrorlog.file=/var/log/apache2/foo.bar.org-error.log*
-conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org.metrics
+conf.probe.types=<metrictype1>, <metrictype2>
+conf.probe.metrictype1param1.file=<value>
+conf.probe.metrictype1param2.file=<value>
+conf.probe.metrictype2param1.file=<value>
+conf.probe.metrictype2param2.file=<value>
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
 ```
 
 Generate the metric file for the first time:
@@ -114,3 +117,88 @@ Create a cron file to update the metric file everyday:
 ```
 
 Warning: in previous day mode, the metrics generated are overwrited for the last month, the last week and the last day. So, six weeks in logs are required.
+
+
+### Web metrics
+
+Configuration template:
+
+```
+conf.probe.types=HttpAccessLog, HttpErrorLog
+conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
+conf.probe.httperrorlog.file=/var/log/apache2/foo.bar.org-error.log*
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+```
+
+### Minetest metrics
+
+Configuration template:
+
+```
+conf.probe.types=Minetest
+conf.probe.minetest.logs=/home/cpm/Projets/StatoolInfos/EnvTest/minetest/minetest.log*
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+
+```
+
+### Mumble metrics
+
+Configuration template:
+
+```
+conf.probe.types=Mumble
+conf.probe.mumble.logs=/var/log/mumble-server/mumble-server.log*
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+```
+
+### PrivateBin metrics (experimental)
+
+Warning: works fine if database, image and comment options are disabled.
+
+Configuration template:
+
+```
+conf.probe.types=PrivateBin
+conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
+conf.probe.privatebin.data=/var/www/paste.libre-service.eu/data/
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+```
+
+### Framdadate metrics (coming soon)
+
+Configuration template:
+
+```
+conf.probe.types=Framadate
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+```
+### Gitea metrics (coming soon)
+
+Configuration template:
+
+```
+conf.probe.types=Gitea
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+```
+
+### LibreQR metrics (coming soon)
+
+Configuration template:
+
+```
+conf.probe.types=LibreQR
+conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
+conf.probe.libreqr.data=/var/www/qrcode.libre-service.eu/data/
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+```
+
+### Nextcloud metrics (coming soon)
+
+Configuration template:
+
+```
+conf.probe.types=Nextcloud
+conf.probe.httpaccesslog.file=/var/log/apache2/foo.bar.org-access.log*
+conf.probe.target=/srv/statoolinfos/well-known/statoolinfos/foo.bar.org-metrics.properties
+```
+