From 58a3b631542da268195c9ad8cf019e45e8584bcd Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Tue, 23 Dec 2025 23:40:36 +0000 Subject: Document tipidee-logaggregate and cgiwrapper-nollmcrawler --- doc/tipidee-logaggregate.html | 108 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) create mode 100644 doc/tipidee-logaggregate.html (limited to 'doc/tipidee-logaggregate.html') diff --git a/doc/tipidee-logaggregate.html b/doc/tipidee-logaggregate.html new file mode 100644 index 0000000..7bea86b --- /dev/null +++ b/doc/tipidee-logaggregate.html @@ -0,0 +1,108 @@ + + + + + + tipidee: the tipidee-logaggregate program + + + + + + +

+tipidee
+Software
+skarnet.org +

+ +

The `tipidee-logaggregate` program

+ +

+ tipidee-logaggregate is a very ad-hoc, quick-and-dirty log aggregator +for tipidee. +

+ +

Interface

+ +

+     tipidee-logaggregate [ -4 | -6 ]
+

+ +

tipidee-logaggregate reads a series of log entries on its stdin.
It aggregates the logs, and prints what it finds to stdout. For every +client IP that hit the server, it prints that IP, followed by all the URLs +that the client requested.

+ +

Log format

+ +

+ tipidee-logaggregate was written for a very specific situation and is only +provided as a convenience. No effort has been made to try and make it generic, +so it expects a precise log format: +

+ +

The log directive in /etc/tipidee.conf must contain at +least the following: log start ip request resource
The log lines must start with a TAI64N label. This is achieved by running +s6-log as the logging program +with the t directive.

+ +

+ If these conditions are not met, tipidee-logaggregate will not work properly. +

+ +

Common usage

+ +

+ cat *.s current | tipidee-logaggregate > result +

+ +

Exit codes

+ +

0: Success.
100: Bad usage.
111: System call failed. This usually signals an issue with the +underlying operating system.

+ +

Options

+ +

-4: Expect IPv4 addresses. Use this option when reading logs from a server listening +to an IPv4 address.
-6: Expect IPv6 addresses. Use this option when reading logs from a server listening +to an IPv6 address.

+ +

Notes

+ +

If you feed tipidee-logaggregate logs starting from a random moment in time +when tipideed has already been serving, some warnings are normal and expected. +They correspond to the already-connected clients that tipidee-logaggregate cannot +identify. Unless they repeat for a large number of lines, these warnings are harmless.

+ + + -- cgit v1.3.1