From b759108a8f229683d43fa50db1552e0fe5ce7b91 Mon Sep 17 00:00:00 2001
From: Michiel Meeuwissen <michiel.meeuwissen@gmail.com>
Date: Sun, 19 Jan 2025 16:39:02 +0100
Subject: [PATCH] Improved perldoc.

---
 parse_tomcat_access_logs.pl | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

diff --git a/parse_tomcat_access_logs.pl b/parse_tomcat_access_logs.pl
index 1dd5e39..1162fed 100755
--- a/parse_tomcat_access_logs.pl
+++ b/parse_tomcat_access_logs.pl
@@ -1,14 +1,36 @@
 #!/usr/bin/perl
-
 #we do it in perl, since that's available on ubuntu:latest
 
+=encoding Big5
+
 =head1 parse_tomcat_access_logs()
 
-Make an abstract of the tomcat access logs
+Make an abstract of the tomcat access logs. This can be called manually,
+but it return format is also recognized by ScriptMeterBinder.java (in vpro-shared-monitoring) which will use it as gauges for micrometer.
 
 Parameters
 
-- max age in minutes (defaults to 1440, one day)
+=over 2
+
+=item - max age in minutes (defaults to 60, one hour)
+
+=back
+
+It will give of the number of requests per
+
+=over 2
+
+=item - method and (beginning of) the path
+
+=item - client
+
+=item - status code
+
+=item - what we might come up later
+
+=back
+
+January 2025 - Michiel Meeuwissen
 
 =cut