;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2016 Ricardo Wurmus <rekado@elephly.net>
;;; Copyright © 2016, 2017, 2018 Ludovic Courtès <ludo@gnu.org>
;;; Copyright © 2017 Stefan Reichör <stefan@xsteve.at>
;;; Copyright © 2017 Eric Bavier <bavier@member.fsf.org>
;;; Copyright © 2018, 2019 Tobias Geerinckx-Rice <me@tobias.gr>
;;; Copyright © 2019 Gábor Boskovits <boskovits@gmail.com>
;;; Copyright © 2019 Meiyo Peng <meiyo@riseup.net>
;;; Copyright © 2020 Marius Bakke <mbakke@fastmail.com>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.

(define-module (gnu packages logging)
  #:use-module ((guix licenses) #:prefix license:)
  #:use-module (guix packages)
  #:use-module (guix utils)
  #:use-module (guix download)
  #:use-module (guix git-download)
  #:use-module (guix build-system cmake)
  #:use-module (guix build-system gnu)
  #:use-module (guix build-system python)
  #:use-module (gnu packages)
  #:use-module (gnu packages autotools)
  #:use-module (gnu packages bison)
  #:use-module (gnu packages c)
  #:use-module (gnu packages compression)
  #:use-module (gnu packages curl)
  #:use-module (gnu packages cyrus-sasl)
  #:use-module (gnu packages databases)
  #:use-module (gnu packages flex)
  #:use-module (gnu packages geo)
  #:use-module (gnu packages gnupg)
  #:use-module (gnu packages kerberos)
  #:use-module (gnu packages linux)
  #:use-module (gnu packages ncurses)
  #:use-module (gnu packages networking)
  #:use-module (gnu packages perl)
  #:use-module (gnu packages pkg-config)
  #:use-module (gnu packages python)
  #:use-module (gnu packages python-web)
  #:use-module (gnu packages python-xyz)
  #:use-module (gnu packages tcl)
  #:use-module (gnu packages tls))

(define-public log4cpp
  (package
    (name "log4cpp")
    (version "1.1.3")
    (source (origin
              (method url-fetch)
              (uri (string-append "mirror://sourceforge/log4cpp/log4cpp-"
                                  (version-major+minor version) ".x%20%28new%29"
                                  "/log4cpp-" (version-major+minor version)
                                  "/log4cpp-" version ".tar.gz"))
              (sha256
               (base32
                "07gmr3jyaf2239n9sp6h7hwdz1pv7b7aka8n06gmr2fnlmaymfrc"))))
    (build-system gnu-build-system)
    (arguments
     '(#:phases
       (modify-phases %standard-phases
         (add-after 'unpack 'do-not-call-stime
           (lambda _
             ;; Patch out use of 'stime' which was removed from glibc 2.31.
             ;; The test would not work in the build container anyway.
             (substitute* "tests/testDailyRollingFileAppender.cpp"
               (("if \\(stime\\(&now\\) == -1\\)")
                "if (1)"))
             #t)))))
    (synopsis "Log library for C++")
    (description
     "Log4cpp is library of C++ classes for flexible logging to files, syslog,
IDSA and other destinations.  It is modeled after the Log4j Java library,
staying as close to their API as is reasonable.")
    (home-page "http://log4cpp.sourceforge.net/")
    (license license:lgpl2.1+)))

(define-public glog
  (package
    (name "glog")
    (version "0.4.0")
    (home-page "https://github.com/google/glog")
    (source (origin
              (method git-fetch)
              (uri (git-reference (url home-page)
                                  (commit (string-append "v" version))))
              (sha256
               (base32
                "1xd3maiipfbxmhc9rrblc5x52nxvkwxp14npg31y5njqvkvzax9b"))
              (file-name (git-file-name name version))))
    (build-system gnu-build-system)
    (arguments
     `(#:phases (modify-phases %standard-phases
                  (add-before 'check 'disable-signal-tests
                    (lambda _
                      ;; XXX: This test fails on non x86_64.  See e.g.
                      ;; https://github.com/google/glog/issues/219 and
                      ;; https://github.com/google/glog/issues/256.
                      (substitute* "Makefile"
                        (("\tsignalhandler_unittest_sh") "\t$(EMPTY)"))
                      #t)))))
    (native-inputs
     `(("perl" ,perl)                             ;for tests
       ("autoconf" ,autoconf-wrapper)
       ("automake" ,automake)
       ("libtool" ,libtool)))
    (synopsis "C++ logging library")
    (description
     "Google glog is a library that implements application-level logging.
This library provides logging APIs based on C++-style streams and various
helper macros.  You can log a message by simply streaming things to log at a
particular severity level.  It allows logging to be controlled from the
command line.")
    (license license:bsd-3)))

(define-public tailon
  (package
    (name "tailon")
    (version "1.3.0")
    (source
     (origin
       (method url-fetch)
       (uri (pypi-uri name version))
       (sha256
        (base32
         "0wl2wm6p3pc0vkk33s7rzgcfvs9cwxfmlz997pdfhlw72r00l7s5"))))
    (build-system python-build-system)
    (inputs
     `(("python-pyyaml" ,python-pyyaml)
       ("python-sockjs-tornado" ,python-sockjs-tornado)
       ("python-tornado-http-auth" ,python-tornado-http-auth)
       ("python-tornado" ,python-tornado)))
    (arguments
     `(#:phases
       (modify-phases %standard-phases
         (add-after 'unpack 'patch-commands.py
                     (lambda args
                       (substitute* "tailon/commands.py"
                         (("self\\.first_in_path\\('grep'\\)")
                          (string-append"'" (which "grep") "'"))
                         (("self\\.first_in_path\\('gawk', 'awk'\\)")
                          (string-append"'" (which "gawk") "'"))
                         (("self\\.first_in_path\\('gsed', 'sed'\\)")
                          (string-append"'" (which "sed") "'"))
                         (("self\\.first_in_path\\('gtail', 'tail'\\)")
                          (string-append"'" (which "tail") "'")))
                       #t)))))
    (home-page "https://tailon.readthedocs.io/")
    (synopsis
     "Webapp for looking at and searching through log files")
    (description
     "Tailon provides a web interface around the tail, grep, awk and sed
commands, displaying the results via a web interface.")
    (license license:bsd-3)))

(define-public multitail
  (package
    (name "multitail")
    (version "6.5.0")
    (source
     (origin
      (method url-fetch)
      (uri (string-append "https://vanheusden.com/multitail/multitail-"
                          version ".tgz"))
      (sha256
       (base32 "1vd9vdxyxsccl64ilx542ya5vlw2bpg6gnkq1x8cfqy6vxvmx7dj"))))
    (build-system gnu-build-system)
    (arguments
     `(#:make-flags
       (list "CC=gcc"
             "PREFIX="
             (string-append "DESTDIR="
                            (assoc-ref %outputs "out")))
       #:phases
       (modify-phases %standard-phases
         (add-after 'unpack 'patch-curses-lib
           (lambda* (#:key outputs #:allow-other-keys)
             (let ((out (assoc-ref outputs "out")))
               (substitute* "mt.h"
                 (("ncursesw\\/panel.h") "panel.h")
                 (("ncursesw\\/ncurses.h") "ncurses.h")))
             #t))
         (delete 'configure))
       #:tests? #f)) ; no test suite (make check just runs cppcheck)
    (inputs `(("ncurses" ,ncurses)))
    (home-page "https://vanheusden.com/multitail/")
    (synopsis "Monitor multiple logfiles")
    (description
     "MultiTail allows you to monitor logfiles and command output in multiple
windows in a terminal, colorize, filter and merge.")
    (license license:gpl2+)))

(define-public spdlog
  (package
    (name "spdlog")
    (version "1.5.0")
    (source
     (origin
       (method git-fetch)
       (uri (git-reference
             (url "https://github.com/gabime/spdlog.git")
             (commit (string-append "v" version))))
       (file-name (git-file-name name version))
       (sha256
        (base32
         "0dn44r3xbw1w0bk9yflnxkh3rzdq2bpxkks44skfmqig0rsj1f1x"))))
    (build-system cmake-build-system)
    ;; TODO run benchmark. Currently not possible, as adding
    ;; (gnu packages benchmark) forms a dependency cycle
    (arguments
     '(#:configure-flags
       (list "-DSPDLOG_BUILD_BENCH=OFF")))
    (home-page "https://github.com/gabime/spdlog")
    (synopsis "Fast C++ logging library")
    (description "Spdlog is a very fast header-only/compiled C++ logging
library.")
    ;; spdlog is under Expat license, but the bundled fmt library in
    ;; "include/spdlog/fmt/bundled" is under BSD 2 clause license.
    (license (list license:expat license:bsd-2))))

(define-public rsyslog
  (let ((modules (list "fmhash" "fmhttp" "imbatchreport"
                       "imczmq" "imdiag" "imdocker"
                       "imfile" "imgssapi" "imkafka"
                       "imklog" "imkmsg" "immark"
                       "improg" "impstats" "imptcp" "imtcp"
                       "imtuxedoulog" "imudp" "imuxsock"
                       "mmanon" "mmaudit" "mmcount"
                       "mmdblookup" "mmexternal"
                       "mmfields" "mmjsonparse"
                       "mmkubernetes" "mmnormalize"
                       "mmpstrucdata" "mmrfc5424addhmac"
                       "mmrm1stspace" "mmsequence"
                       "mmsnmptrapd" "mmtaghostname"
                       "mmutf8fix" "omclickhouse"
                       "omczmq" "omelasticsearch"
                       "omfile-hardened" "omgssapi"
                       "omhttpfs" "omhttp" "omkafka"
                       "omlibdbi" "ommail" "ommysql" "ompgsql"
                       "omprog" "omruleset" "omsnmp"
                       "omstdout" "omtcl" "omtesting"
                       "omudpspoof" "omuxsock"
                       "pmaixforwardedfrom" "pmciscoios"
                       "pmcisconames" "pmdb2diag"
                       "pmlastmsg" "pmnormalize"
                       "pmnull" "pmpanngfw" "pmsnare")))
    (package
      (name "rsyslog")
      (version "8.2004.0")
      (source
       (origin
         (method git-fetch)
         (uri (git-reference
               (url "https://github.com/rsyslog/rsyslog.git")
               (commit (string-append "v" version))))
         (file-name (git-file-name name version))
         (sha256
          (base32
           "0h40vvrjbxkvxy1sjqjwlyjfndj81llrisp7hkqm5j4mcl4pbzb3"))))
      (build-system gnu-build-system)
      (arguments
       `(#:phases
         (modify-phases %standard-phases
           ;; autogen.sh calls configure at the end of the script.
           (replace 'bootstrap
             (lambda _ (invoke "autoreconf" "-vfi")))
           (add-after 'build 'transfer-modules
             (lambda* (#:key outputs #:allow-other-keys)
               (let* ((out (assoc-ref outputs "out"))
                      (mod (string-append out "/lib/rsyslog"))
                      (move-module
                       (lambda (name)
                         (let* ((new-dir (string-append
                                          (assoc-ref outputs name)
                                          "/lib/rsyslog")))
                           (mkdir-p new-dir)
                           (for-each
                            (lambda (old-file)
                              (let ((new-file
                                     (string-append
                                      new-dir
                                      "/"
                                      (basename old-file))))
                                (write (string-append old-file " -> "
                                                      new-file))
                                (newline)
                                (rename-file old-file new-file)))
                            (find-files mod (string-append "^" name)))))))
                 (for-each move-module (list ,@modules)))
               #t)))
         #:configure-flags
         (list
          "--enable-largefile"
          "--enable-inet"
          "--enable-regexp"
          "--enable-rsyslogrt"
          "--enable-rsyslogd"
          "--enable-unlimited_select"
          "--enable-uuid"
          "--enable-libgcrypt"
          "--enable-mmanon"
          "--enable-mmcount"
          "--enable-liblogging_stdlog"
          "--enable-kafka_static"
          "--enable-atomic_operations"
          ;; Input plugins
          "--enable-kmsg"
          "--enable-imptcp"
          "--enable-imdiag"
          "--enable-imfile"
          "--enable-imdocker"
          "--enable-impstats"
          "--enable-imczmq"
          "--enable-imbatchreport"
          "--enable-imkafka"
          "--enable-imtuxedoulog"
          "--enable-improg"
          ;; Output plugins
          "--enable-mail"
          "--enable-omfile_hardened"
          "--enable-omprog"
          "--enable-omstdout"
          "--enable-elasticsearch"
          "--enable-clickhouse"
          "--enable-omhttp"
          "--enable-omruleset"
          "--enable-omudpspoof"
          "--enable-omuxsock"
          "--enable-omczmq"
          "--enable-omhttpfs"
          "--enable-omtcl"
          "--enable-omkafka"
          ;; Parser Modules
          "--enable-pmlastmsg"
          "--enable-pmcisconames"
          "--enable-pmciscoios"
          "--enable-pmnull"
          "--enable-pmnormalize"
          "--enable-pmaixforwardedfrom"
          "--enable-pmsnare"
          "--enable-pmdb2diag"
          "--enable-pmpanngfw"
          ;; Message Modification Modules
          "--enable-mmnormalize"
          "--enable-mmjsonparse"
          "--enable-mmaudit"
          "--enable-mmsnmptrapd"
          "--enable-mmutf8fix"
          "--enable-mmrfc5424addhmac"
          "--enable-mmpstrucdata"
          "--enable-mmsequence"
          "--enable-mmdblookup"
          "--enable-mmdarwin"
          "--enable-mmfields"
          "--enable-mmrm1stspace"
          "--enable-mmkubernetes"
          "--enable-mmtaghostname"
          ;; Database Support
          "--enable-mysql"
          "--enable-libdbi"
          "--enable-pgsql"
          ;; Protocol Support
          "--enable-openssl"
          "--enable-gnutls"
          "--enable-gssapi_krb5"
          "--enable-snmp"
          ;; Function modules
          "--enable-fmhttp"
          "--enable-fmhash"
          "--enable-fmhash_xxhash")))
      (native-inputs
       `(("autoconf" ,autoconf)
         ("automake" ,automake)
         ("libtool" ,libtool)
         ("pkg-config" ,pkg-config)
         ("bison" ,bison)
         ("flex" ,flex)))
      (inputs
       `(("libestr" ,libestr)
         ("libfastjson" ,libfastjson)
         ("liblogging" ,liblogging)
         ("libz" ,zlib)
         ("libuuid" ,util-linux "lib")
         ("libgcrypt" ,libgcrypt)
         ("libcurl" ,curl)
         ("liblognorm" ,liblognorm "lib")
         ("liblognorm" ,liblognorm "dev")
         ("mariadb" ,mariadb "lib")
         ("mariadb" ,mariadb "dev")
         ("postgresql" ,postgresql)
         ("libdbi" ,libdbi)
         ("net-smnp" ,net-snmp)
         ("openssl" ,openssl)
         ("gnutls" ,gnutls)
         ("libnet" ,libnet)
         ("librdkafka" ,librdkafka)
         ("lz4" ,lz4)
         ("czmq" ,czmq)
         ("zeromq" ,zeromq)
         ("mit-krb5" ,mit-krb5)
         ("cyrus-sasl" ,cyrus-sasl)
         ("libmaxminddb" ,libmaxminddb)
         ("tcl" ,tcl)))
      (outputs `("out" ,@modules))
      (home-page "https://www.rsyslog.com/")
      (synopsis "RSYSLOG is the rocket-fast system for log processing")
      (description
       "It offers high-performance, great security features and a modular
design.  While it started as a regular syslogd, rsyslog has evolved into a
kind of swiss army knife of logging, being able to accept inputs from a wide
variety of sources, transform them, and output to the results to diverse
destinations.

Rsyslog can deliver over one million messages per second to local
destinations when limited processing is applied (based on v7, December
2013).  Even with remote destinations and more elaborate processing the
performance is usually considered \"stunning\".")
      (license (list license:gpl3
                     license:asl2.0
                     license:lgpl3)))))