common/openecomp-logging-lib/openecomp-logging-core/README

   1 The purpose of this module is to make a Web application meet the OPENECOMP logging requirements described in
   2 OPENECOMP platform application logging guidelines.
   3
   4 The default out-of-the box solution is based on SLF4J.
   5
   6 It introduces three major areas of functionality as follows:
   7
   8 1. Routing of logging messages for the Logback library, so that all logging events are written to separate files
   9 according to their type.
  10
  11 2. An AOP aspect for measuring execution time and logging it, so that the application code is not contaminated with
  12 this type of logging.
  13
  14 3. Collecting and populating the context of a Web API request and propagating it to every logging event.
  15
  16 TODO:
  17
  18 1. MetricsAspect
  19   - Configurable metrics message
  20   - Make sure there are no exceptions but applicative ones
  21
  22 2. EventTypeDiscriminator
  23   - Make event types configurable to make the names of log files easily customizable
  24
  25 3. DispatchingAppender
  26   - Read appenders from configuration, so that there is no need in EELF loggers
  27   - Simpler use of discriminator or an entirely different mechanism
  28   - Better appender name pattern, or mapping between a discriminating value and an appender name
  29   - Discard the appenders cache on configuration changes