external/bsd/bind/dist/contrib/zkt/README.logging

   1 #
   2 #       README.logging
   3 #
   4 #       Introduction into the new logging feature
   5 #       available since v0.96
   6 #
   7
   8 In previous version of dnssec-signer every message was written
   9 to the default stdout and stderr channels, and the logging itself
  10 was handled by a redirection of those chanels to the logger command
  11 or to a file.
  12
  13 Now, since version v0.96, the dnssec-signer command is able to log all
  14 messages by itself. File and SYSLOG logging is supported.
  15
  16 To enable the logging into a file channel, you have to specify
  17 the file or directory name via the commandline option -L (--logfile)
  18 or via the config file parameter "LogFile".
  19         LogFile: ""|"<file>"|"<directory>"      (default is "")
  20 If a file is specified, than each run of dnssec-signer will append the
  21 messages to that file. If a directory is specified, than a file with a
  22 name of zkt-<ISOdate&timeUTC>.log" will be created on each dnssec-signer run.
  23
  24 Logging into the syslog channel could be enabled via the config file
  25 parameter "SyslogFacility".
  26         SyslogFacility: NONE|USER|DAEMON|LOCAL0|..|LOCAL7 (default is USER)
  27
  28 For both channels, the log level could be set to one of six log levels:
  29         LG_FATAL, LG_ERROR, LG_WARNING
  30         LB_NOTICE, LG_INFO, LG_DEBUG
  31
  32 The loglevel is settable via the config file parameter :
  33         SyslogLevel: FATAL|ERROR|WARNING|NOTICE|INFO|DEBUG
  34                 (default is ERROR)
  35 and
  36         LogLevel: FATAL|ERROR|WARNING|NOTICE|INFO|DEBUG
  37                 (default is NOTICE)
  38
  39 All the log parameters are settable on the commandline via the generic
  40 option -O "optstring" (--config-option="optstring").
  41
  42 A verbose message output to stdout could be achieved by the commandline
  43 option -v (or -v -v).
  44 If you like to have this verbose messages also logged with a level of LG_DEBUG
  45 you should enable this by setting the config file option
  46 "VerboseLog" to a value of 1 or 2.
  47
  48 Current logging messages:
  49         LG_FATAL: Not all of the fatal errors are logged
  50                 (e.g.: config file or command line option fatal errors are
  51                 not logged)
  52         LG_ERROR: All error messages will be logged
  53         LG_WARNING: KSK lifetime expiration
  54         LG_NOTICE:
  55                 Start and stop of dnssec-signer
  56                 Re-signing events
  57                 Key rollover events
  58                 KSK key generation and revoking
  59                 Zone reload resp. freeze/thaw of dynamic zone
  60         LG_INFO: Currently none
  61                 planned:
  62                 Mesages for key generation and key status change
  63                 (e.g.: pre-publish -> activate; revoked -> removed etc.)
  64         LG_DEBUG: all "verbose" (-v) and "very verbose" (-v -v)  messages
  65
  66 Some recomended and useful logging settings
  67
  68 - The default setting
  69         LogFile: ""
  70         SyslogFacility: USER
  71         SyslogLevel: NOTICE
  72         VerboseLog: 0
  73
  74 - Setting as in version v0.95
  75         LogFile: "zkt-error.log"        # or a directory for separate logfiles
  76         LogLevel: ERROR
  77         SyslogFacility: NONE
  78         VerboseLog: 0
  79
  80 - Setting as in previous versions
  81         LogFile: ""
  82         SyslogFacility: NONE
  83         VerboseLog: 0
  84
  85 - Recommended setting for normal usage
  86         LogFile: "zkt.log"      # or a directory for separate logfiles
  87         LogLevel: ERROR
  88         SyslogFacility: USER
  89         SyslogLevel: NOTICE
  90         VerboseLog: 0
  91
  92 - Recommended setting for debugging
  93         LogFile: "zkt.log"      # or a directory for separate logfiles
  94         LogLevel: DEBUG
  95         SyslogFacility: USER
  96         SyslogLevel: NOTICE
  97         VerboseLog: 2
  98
  99 -