[v20,00/14] Logging unification and improvements

Message ID 20240330164433.50144-1-stephen@networkplumber.org (mailing list archive)
Headers
Series Logging unification and improvements |

Message

Stephen Hemminger March 30, 2024, 4:42 p.m. UTC
  Improvements and unification of logging library.
This version works on all platforms: Linux, Windows and FreeBSD.

This is update to rework patch set. It adds several new features
to the console log output.

  * Putting a timestamp on console output which is useful for
    analyzing performance of startup codes. Timestamp is optional
    and must be enabled on command line.

  * Displaying console output with colors.
    It uses the standard conventions used by many other Linux commands
    for colorized display.  The default is to enable color if the
    console output is going to a terminal. But it can be always
    on or disabled by command line flag. This default was chosen
    based on what dmesg(1) command does.

    Color is used by many tools (vi, iproute2, git) because it is helpful;
    DPDK drivers and libraries print lots of not very useful messages.
    And having error messages highlighted in bold face helps.
    This might also get users to pay more attention to error messages.
    Many bug reports have earlier messages that are lost because
    there are so many info messages.

  * Add support for automatic detection of systemd journal
    protocol. If running as systemd service will get enhanced
    logging.

  * Use of syslog is optional and the meaning of the
    --syslog flag has changed. The default is *not* to use
    syslog. 

Add myself as maintainer for log because by now have added
more than previous authors.

v20 - avoid use vasprintf if possible, because it requires
      extra patch for Windows, and increases risk of missed
      message if malloc pool is corrupted.
    - fix build on FreeBSD.

Stephen Hemminger (14):
  maintainers: add for log library
  windows: make getopt functions have const properties
  windows: add os shim for localtime_r
  eal: make eal_log_level_parse common
  eal: do not duplicate rte_init_alert() messages
  eal: change rte_exit() output to match rte_log()
  log: move handling of syslog facility out of eal
  eal: initialize log before everything else
  log: drop syslog support, and make code common
  log: add hook for printing log messages
  log: add timestamp option
  log: add optional support of syslog
  log: add support for systemd journal
  log: colorize log output

 MAINTAINERS                                   |   1 +
 app/test/test_eal_flags.c                     |  64 +++++-
 doc/guides/linux_gsg/linux_eal_parameters.rst |  27 ---
 doc/guides/prog_guide/log_lib.rst             |  71 ++++++
 lib/eal/common/eal_common_debug.c             |  11 +-
 lib/eal/common/eal_common_options.c           | 137 +++++++-----
 lib/eal/common/eal_options.h                  |   7 +
 lib/eal/freebsd/eal.c                         |  64 ++----
 lib/eal/linux/eal.c                           |  68 ++----
 lib/eal/windows/eal.c                         |  49 +---
 lib/eal/windows/getopt.c                      |  23 +-
 lib/eal/windows/include/getopt.h              |   8 +-
 lib/eal/windows/include/rte_os_shim.h         |  10 +
 lib/log/log.c                                 |  80 ++++---
 lib/log/log_color.c                           | 148 ++++++++++++
 lib/log/log_freebsd.c                         |  12 -
 lib/log/log_internal.h                        |  28 ++-
 lib/log/log_journal.c                         | 200 +++++++++++++++++
 lib/log/log_linux.c                           |  61 -----
 lib/log/log_private.h                         |  34 +++
 lib/log/log_stubs.c                           |  37 +++
 lib/log/log_syslog.c                          |  88 ++++++++
 lib/log/log_timestamp.c                       | 210 ++++++++++++++++++
 lib/log/log_windows.c                         |  18 --
 lib/log/meson.build                           |  14 +-
 lib/log/version.map                           |   5 +-
 26 files changed, 1097 insertions(+), 378 deletions(-)
 create mode 100644 lib/log/log_color.c
 delete mode 100644 lib/log/log_freebsd.c
 create mode 100644 lib/log/log_journal.c
 delete mode 100644 lib/log/log_linux.c
 create mode 100644 lib/log/log_private.h
 create mode 100644 lib/log/log_stubs.c
 create mode 100644 lib/log/log_syslog.c
 create mode 100644 lib/log/log_timestamp.c
 delete mode 100644 lib/log/log_windows.c