github.com/klaytn/klaytn@v1.12.1/log/doc.go (about)

     1  // Copyright 2018 The klaytn Authors
     2  // This file is part of the klaytn library.
     3  //
     4  // The klaytn library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The klaytn library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the klaytn library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  /*
    18  Package log provides an opinionated, simple toolkit for best-practice logging.
    19  
    20  Overview of log package
    21  
    22  Logger is the interface for various implementation of logging.
    23  There are log15 and zap logger and log15 is the default logger.
    24  
    25  Source Files
    26  
    27    - format.go         : contains formatting functions for log15 logger
    28    - handler.go        : provides various types of log handling methods for log15 logger
    29    - handler_glog.go   : contains implementation of GlogHandler
    30    - handler_go13.go   : contains implementation of swapHandler in go1.3
    31    - handler_go14.go   : contains implementation of swapHandler in go1.4
    32    - handler_syslog.go : contains functions to use syslog package, but currently not used
    33    - interface.go      : defines Logger interface to support various implementations of loggers
    34    - log15_logger.go   : contains implementation of log15 logger, modified by go-ethereum
    35    - log_modules.go    : defines log modules, used to categorize logs
    36    - zap_logger.go     : contains functions and variables to use zap logger with Logger interface
    37  */
    38  package log