Merge pull request #2607 from SlowMo24/traefik-clf

feat(settings): add traefik log format

Author: allinurl

ChangeLog

@@ -1,3 +1,5 @@
+  - Added support for Traefik log format
+
 Changes to GoAccess 1.8.1 - Tuesday, October 31, 2023
 
   - Added latest Android and macOS versions to the list of OSs.

README.md

@@ -78,6 +78,7 @@ not limited to:
 * Squid Native Format.
 * W3C format (IIS).
 * Caddy's JSON Structured format.
+* Traefik's CLF flavor
 
 ## Why GoAccess? ##
 GoAccess was designed to be a fast, terminal-based log analyzer. Its core idea

config/goaccess.conf

@@ -115,6 +115,9 @@
 # CADDY JSON Structured
 #log-format {"ts":"%x.%^","request":{"remote_ip":"%h","proto":"%H","method":"%m","host":"%v","uri":"%U","headers":{"User-Agent":["%u","%^"]},"tls":{"cipher_suite":"%k","proto": "%K"}},"duration": "%T","size": "%b","status": "%s","resp_headers":{"Content-Type":["%M;%^"]}}
 
+# Treaefik CLF flavor
+#log-format %h - %e [%d:%t %^] "%r" %s %b "%R" "%u" %^ "%v" "%U" %Lms
+
 # In addition to specifying the raw log/date/time formats, for
 # simplicity, any of the following predefined log format names can be
 # supplied to the log/date/time-format variables. GoAccess  can  also
@@ -132,6 +135,7 @@
 #log-format AWSELB
 #log-format AWSS3
 #log-format CADDY
+#log-format TRAEFIKCLF
 
 ######################################
 # UI Options

goaccess.1

@@ -245,6 +245,7 @@ one variable and another predefined name in another variable.
   AWSS3        - Amazon Simple Storage Service (S3)
   AWSALB       - Amazon Application Load Balancer
   CADDY        - Caddy's JSON Structured format
+  TRAEFIKCLF   - Traefik's CLF flavor
 .IP
 .I Note:
 Piping data into GoAccess won't prompt a log/date/time configuration dialog,

src/settings.c

@@ -63,6 +63,7 @@ static GEnum LOGTYPE[] = {
   {"AWSS3"        , AWSS3}        ,
   {"CADDY"        , CADDY}        ,
   {"AWSALB"       , AWSALB}       ,
+  {"TRAEFIKCLF"   , TRAEFIKCLF}   ,
 };
 
 static const GPreConfLog logs = {
@@ -84,7 +85,9 @@ static const GPreConfLog logs = {
   "\"%k\", \"proto\": \"%K\" } }, \"duration\": \"%T\", \"size\": \"%b\","
   "\"status\": \"%s\", \"resp_headers\": { \"Content-Type\": [\"%M\"] } }",
 
-  "%^ %dT%t.%^ %v %h:%^ %^ %^ %T %^ %s %^ %^ %b \"%r\" \"%u\" %k %K %^" /* Amazon ALB */
+  "%^ %dT%t.%^ %v %h:%^ %^ %^ %T %^ %s %^ %^ %b \"%r\" \"%u\" %k %K %^", /* Amazon ALB */
+
+  "%h - %e [%d:%t %^] \"%r\" %s %b \"%R\" \"%u\" %^ \"%v\" \"%U\" %Lms" /* Traefik's CLF flavor with header */
 };
 
 static const GPreConfTime times = {
@@ -399,6 +402,8 @@ get_selected_format_idx (void) {
     return CADDY;
   else if (strcmp (conf.log_format, logs.awsalb) == 0)
     return AWSALB;
+  else if (strcmp (conf.log_format, logs.traefikclf) == 0)
+    return TRAEFIKCLF;
   else
     return (size_t) -1;
 }
@@ -448,6 +453,9 @@ get_selected_format_str (size_t idx) {
   case AWSALB:
     fmt = alloc_string (logs.awsalb);
     break;
+  case TRAEFIKCLF:
+    fmt = alloc_string (logs.traefikclf);
+    break;
   }
 
   return fmt;
@@ -467,6 +475,7 @@ get_selected_date_str (size_t idx) {
   case COMBINED:
   case VCOMBINED:
   case AWSS3:
+  case TRAEFIKCLF:
     fmt = alloc_string (dates.apache);
     break;
   case AWSELB:
@@ -505,6 +514,7 @@ get_selected_time_str (size_t idx) {
   case VCOMMON:
   case W3C:
   case AWSS3:
+  case TRAEFIKCLF:
     fmt = alloc_string (times.fmt24);
     break;
   case CLOUDSTORAGE:

src/settings.h

@@ -58,6 +58,7 @@ typedef enum LOGTYPE {
   AWSS3,
   CADDY,
   AWSALB,
+  TRAEFIKCLF,
 } GLogType;
 
 /* predefined log times */
@@ -89,6 +90,7 @@ typedef struct GPreConfLog_ {
   const char *awss3;
   const char *caddy;
   const char *awsalb;
+  const char *traefikclf;
 } GPreConfLog;
 
 /* *INDENT-OFF* */

src/ui.c

@@ -1311,6 +1311,7 @@ render_confdlg (Logs *logs, GSpinner *spinner) {
     "AWS Simple Storage Service (S3)",
     "CADDY JSON Structured",
     "AWS Application Load Balancer",
+    "Traefik CLF flavor"
   };
   n = ARRAY_SIZE (choices);
   getmaxyx (stdscr, y, x);