From 897fb7ece0b10736524991a7421f6fce20e9225a Mon Sep 17 00:00:00 2001
From: Eugen Wissner <belka@caraus.de>
Date: Wed, 5 Feb 2025 10:52:16 +0100
Subject: Add read_logs.rb scripts

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 2e256cb..e5b8459 100644
--- a/README.md
+++ b/README.md
@@ -25,4 +25,29 @@ and in another session:
 curl localhost:8082
 ```
 
+## read\_logs.rb
+
+read\_logs.rb looks in the `log/` directory for files ending with `.log`,
+`.log.1`, `.log.2.gz`, `.log.3.gz` and so forth. It filters out lines starting
+with a timestamp, `yyyy-mm-ddThh:mm:ss`, followed by random characters and a
+custom string provided as the only command line parameter. Finally
+it outputs all matched content after the provided string along with the date.
+
+The log files are read in the order based on the number in the filename.
+
+For example calling the script as
+
+```sh
+./bin/read_logs.rb 'doctrine.INFO:'
+```
+
+on a log file containing
+`[2025-02-04T19:51:49.356093+01:00] doctrine.INFO: Disconnecting [] []`
+
+will print:
+
+```
+2025-02-04 (Disconnecting [])
+```
+
 ## tea-cleaner
-- 
cgit v1.2.3