DAOS-17989 common: Logs with unified severity

Server and engine logs to use the same severity spelling.
DBUG → DEBUG, ERR → ERROR, EMRG → FATAL

Signed-off-by: Tomasz Gromadzki <[email protected]>

Author: grom72

docs/admin/deployment.md

@@ -1329,7 +1329,7 @@ engines:
   nr_xs_helpers: 4                                # count of I/O offload threads
   fabric_iface: eth0                              # network interface to use for this engine
   fabric_iface_port: 31416                        # network port
-  log_mask: ERR                                   # debug level to start with the engine with
+  log_mask: ERROR                                   # debug level to start with the engine with
   log_file: /var/log/daos/daos_engine0.log # where to store engine logs
   storage:
   -

docs/admin/env_variables.md

@@ -86,8 +86,8 @@ Environment variables in this section only apply to the client side.
 |D\_LOG\_SIZE|DAOS debug logs (both server and client) have a 1GB file size limit by default. When this limit is reached, the current log file is closed and renamed with a .old suffix, and a new one is opened. This mechanism will repeat each time the limit is reached, meaning that available saved log records could be found in both ${D_LOG_FILE} and last generation of ${D_LOG_FILE}.old files, to a maximum of the most recent 2*D_LOG_SIZE records.  This can be modified by setting this environment variable ("D_LOG_SIZE=536870912"). Sizes can also be specified in human-readable form using `k`, `m`, `g`, `K`, `M`, and `G`. The lower-case specifiers are base-10 multipliers and the upper case specifiers are base-2 multipliers.|
 |D\_LOG\_FLUSH|Allows to specify a non-default logging level where flushing will occur. By default, only levels above WARN will cause an immediate flush instead of buffering.|
 |D\_LOG\_TRUNCATE|By default log is appended. But if set this variable will cause log to be truncated upon first open and logging start.|
-|DD\_SUBSYS  |Used to specify which subsystems to enable. DD\_SUBSYS can be set to individual subsystems for finer-grained debugging ("DD\_SUBSYS=vos"), multiple facilities ("DD\_SUBSYS=bio,mgmt,misc,mem"), or all facilities ("DD\_SUBSYS=all") which is also the default setting. If a facility is not enabled, then only ERR messages or more severe messages will print.|
-|DD\_STDERR  |Used to specify the priority level to output to stderr. Options in decreasing priority level order: FATAL, CRIT, ERR, WARN, NOTE, INFO, DEBUG. By default, all CRIT and more severe DAOS messages will log to stderr ("DD\_STDERR=CRIT"), and the default for CaRT/GURT is FATAL.|
-|D\_LOG\_MASK|Used to specify what type/level of logging will be present for either all of the registered subsystems or a select few. Options in decreasing priority level order: FATAL, CRIT, ERR, WARN, NOTE, INFO, DEBUG. DEBUG option is used to enable all logging (debug messages as well as all higher priority level messages). Note that if D\_LOG\_MASK is not set, it will default to logging all messages excluding debug ("D\_LOG\_MASK=INFO"). Example: "D\_LOG\_MASK=DEBUG". This will set the logging level for all facilities to DEBUG, meaning that all debug messages, as well as higher priority messages will be logged (INFO, NOTE, WARN, ERR, CRIT, FATAL). Example 2: "D\_LOG\_MASK=DEBUG,MEM=ERR,RPC=ERR". This will set the logging level to DEBUG for all facilities except MEM & RPC (which will now only log ERR and higher priority level messages, skipping all DEBUG, INFO, NOTE & WARN messages)|
+|DD\_SUBSYS  |Used to specify which subsystems to enable. DD\_SUBSYS can be set to individual subsystems for finer-grained debugging ("DD\_SUBSYS=vos"), multiple facilities ("DD\_SUBSYS=bio,mgmt,misc,mem"), or all facilities ("DD\_SUBSYS=all") which is also the default setting. If a facility is not enabled, then only ERROR messages or more severe messages will print.|
+|DD\_STDERR  |Used to specify the priority level to output to stderr. Options in decreasing priority level order: FATAL, CRIT, ERROR, WARN, NOTE, INFO, DEBUG. By default, all CRIT and more severe DAOS messages will log to stderr ("DD\_STDERR=CRIT"), and the default for CaRT/GURT is FATAL.|
+|D\_LOG\_MASK|Used to specify what type/level of logging will be present for either all of the registered subsystems or a select few. Options in decreasing priority level order: FATAL, CRIT, ERROR, WARN, NOTE, INFO, DEBUG. DEBUG option is used to enable all logging (debug messages as well as all higher priority level messages). Note that if D\_LOG\_MASK is not set, it will default to logging all messages excluding debug ("D\_LOG\_MASK=INFO"). Example: "D\_LOG\_MASK=DEBUG". This will set the logging level for all facilities to DEBUG, meaning that all debug messages, as well as higher priority messages will be logged (INFO, NOTE, WARN, ERROR, CRIT, FATAL). Example 2: "D\_LOG\_MASK=DEBUG,MEM=ERROR,RPC=ERROR". This will set the logging level to DEBUG for all facilities except MEM & RPC (which will now only log ERROR and higher priority level messages, skipping all DEBUG, INFO, NOTE & WARN messages)|
 |DD\_MASK    |Used to enable different debug streams for finer-grained debug messages, essentially allowing the user to specify an area of interest to debug (possibly involving many different subsystems) as opposed to parsing through many lines of generic DEBUG messages. All debug streams will be enabled by default ("DD\_MASK=all"). Single debug masks can be set ("DD\_MASK=trace") or multiple masks ("DD\_MASK=trace,test,mgmt"). Note that since these debug streams are strictly related to the debug log messages, D\_LOG\_MASK must be set to DEBUG. Priority messages higher than DEBUG will still be logged for all facilities unless otherwise specified by D\_LOG\_MASK (not affected by enabling debug masks).|
 |CRT\_CTX\_NUM|For regular non-scalable endpoint mode this variable can be used to override maximum number of contexts that can be created, up to 64. By default the maximum number is set to the number of cores available on the system. For scalable endpoint mode specifies total number of contexts to be allocated by the process.|

docs/admin/troubleshooting.md

@@ -142,12 +142,12 @@ with D_LOG_MASK, which by default is set to INFO
 ("D_LOG_MASK=INFO"), which will result in all messages excluding DEBUG
 messages being logged. D_LOG_MASK can also be used to specify the
 level of logging on a per-subsystem basis as well
-("D_LOG_MASK=DEBUG,MEM=ERR").
+("D_LOG_MASK=DEBUG,MEM=ERROR").
 
 -   Log Levels:
-    debug, dbug, info, note, warn, error, err, crit, alrt, fatal, emrg, emit
+    debug, info, note, warn, error, err, crit, alrt, fatal, emit
 
-Note: debug == dbug, error == err and fatal == emrg.
+Note: error == err.
 
 ### Debug Masks/Streams:
 
@@ -214,7 +214,7 @@ values per engine for the `DD_SUBSYS` and `DD_MASK` variable assignments).
 
 -   Disable all logs for performance tuning
 
-        D_LOG_MASK=ERR -> will only log error messages from all facilities
+        D_LOG_MASK=ERROR -> will only log error messages from all facilities
         D_LOG_MASK=FATAL -> will only log system fatal messages
 
 -   Gather daos metadata logs if a pool/container resource problem is observed, using the provided group mask
@@ -224,9 +224,9 @@ values per engine for the `DD_SUBSYS` and `DD_MASK` variable assignments).
 
 -   Disable a noisy debug logging subsystem
 
-        D_LOG_MASK=DEBUG,MEM=ERR -> disables MEM facility by
+        D_LOG_MASK=DEBUG,MEM=ERROR -> disables MEM facility by
         restricting all logs from that facility to ERROR or higher priority only
-        D_LOG_MASK=DEBUG,SWIM=ERR,RPC=ERR,HG=ERR -> disables SWIM and RPC/HG facilities
+        D_LOG_MASK=DEBUG,SWIM=ERROR,RPC=ERROR,HG=ERROR -> disables SWIM and RPC/HG facilities
 
 -   Enable a subset of facilities of interest
 
@@ -358,8 +358,8 @@ ERROR: dmg: Unable to load Certificate Data: could not load cert: stat /etc/daos
 ### use daos command before daos_agent started
 ```
 $ daos cont create $DAOS_POOL
-daos ERR  src/common/drpc.c:217 unixcomm_connect() Failed to connect to /var/run/daos_agent/daos_agent.sock, errno=2(No such file or directory)
-mgmt ERR  src/mgmt/cli_mgmt.c:222 get_attach_info() failed to connect to /var/run/daos_agent/daos_agent.sock DER_MISC(-1025): 'Miscellaneous error'
+daos ERROR  src/common/drpc.c:217 unixcomm_connect() Failed to connect to /var/run/daos_agent/daos_agent.sock, errno=2(No such file or directory)
+mgmt ERROR  src/mgmt/cli_mgmt.c:222 get_attach_info() failed to connect to /var/run/daos_agent/daos_agent.sock DER_MISC(-1025): 'Miscellaneous error'
 failed to initialize daos: Miscellaneous error (-1025)
 
 
@@ -453,7 +453,7 @@ ERROR: dmg: pool create failed: DER_NOSPACE(-1007): No space on storage target
 ```
 ### daos_engine fails to start with error "Address already in use"
 ```
-09/26-15:25:38.06 node-1 DAOS[3851384/-1/0] external ERR  # [4462751.071824] mercury->cls: [error] /builddir/build/BUILD/mercury-2.2.0/src/na/na_ofi.c:3638
+09/26-15:25:38.06 node-1 DAOS[3851384/-1/0] external ERROR  # [4462751.071824] mercury->cls: [error] /builddir/build/BUILD/mercury-2.2.0/src/na/na_ofi.c:3638
 na_ofi_basic_ep_open(): fi_enable() failed, rc: -98 (Address already in use)
 
 "Address already in use" will be observed when there is more than one engine per node sharing the same NIC and fabric_iface_port of engines are too close; e.g., the difference is not larger than 3.

docs/debugging.md

@@ -27,7 +27,7 @@ All macros which output logs have a priority level, shown in descending order
 below.
 - D_FATAL(fmt, ...)		FATAL
 - D_CRIT(fmt, ...)		CRIT
-- D_ERROR(fmt, ...)		ERR
+- D_ERROR(fmt, ...)		ERROR
 - D_WARN(fmt, ...)		WARN
 - D_NOTE(fmt, ...)		NOTE
 - D_INFO(fmt, ...)		INFO
@@ -40,7 +40,7 @@ however is separate from the priority of logging to `/tmp/daos.log`. The
 priority level of logging can be set with `D_LOG_MASK`, which by default is set
 to INFO (`D_LOG_MASK=INFO`), which will result in all messages excluding DEBUG
 messages being logged. `D_LOG_MASK` can also be used to specify the level of
-logging on a per-subsystem basis as well (`D_LOG_MASK="DEBUG,MEM=ERR"`).
+logging on a per-subsystem basis as well (`D_LOG_MASK="DEBUG,MEM=ERROR"`).
 
 ## Debug Masks/Streams:
 
@@ -84,20 +84,20 @@ values per engine for the `DD_SUBSYS` and `DD_MASK` variable assignments).
 
 - Disable all logs for performance tuning
 ```bash
-  $ export D_LOG_MASK=ERR   # -> will only log error messages from all facilities
+  $ export D_LOG_MASK=ERROR   # -> will only log error messages from all facilities
   $ export D_LOG_MASK=FATAL # -> will only log system fatal messages
 ```
 
 - Disable a noisy debug logging subsystem
 ```bash
-  $ export D_LOG_MASK=DEBUG,MEM=ERR # -> disables MEM facility by restricting all logs
+  $ export D_LOG_MASK=DEBUG,MEM=ERROR # -> disables MEM facility by restricting all logs
                                     # from that facility to ERROR or higher priority only
-  $ export D_LOG_MASK=DEBUG,SWIM=ERR,RPC=ERR,HG=ERR # -> disables SWIM and RPC/HG facilities
+  $ export D_LOG_MASK=DEBUG,SWIM=ERROR,RPC=ERROR,HG=ERROR # -> disables SWIM and RPC/HG facilities
 ```
 
 - Gather daos metadata logs if a pool/container resource problem is observed, using the provided group mask
 ```bash
-  $ export D_LOG_MASK=DEBUG,MEM=ERR # log at DEBUG level from all facilities except MEM
+  $ export D_LOG_MASK=DEBUG,MEM=ERROR # log at DEBUG level from all facilities except MEM
   $ export DD_MASK=group_metadata   # limit logging to include only streams (mgmt, plus defaults from group_default)
 ```
 

docs/user/container.md

@@ -390,7 +390,7 @@ follows:
 
 ```bash
 $ dfuse --pool tank --container mycont1 -m /tmp/dfuse
-dfuse ERR  src/client/dfuse/dfuse_core.c:873 dfuse_cont_open(0x19b9b00) daos_cont_open() failed: DER_RF(-2031): 'Failures exceed RF'
+dfuse ERROR  src/client/dfuse/dfuse_core.c:873 dfuse_cont_open(0x19b9b00) daos_cont_open() failed: DER_RF(-2031): 'Failures exceed RF'
 Failed to connect to container (5) Input/output error
 ```
 
@@ -412,8 +412,8 @@ create, try creating with valid `rd_fac`.
 
 ```bash
 $ daos container create tank mycont1 --type=POSIX
-object ERR  src/object/obj_class.c:829 dc_set_oclass() grp_size 5 > domain_nr 1, DER_INVAL(-1003): 'Invalid parameters'
-dfs  ERR  src/client/dfs/cont.c:254 dfs_cont_create() Failed to generate SB OID DER_INVAL(-1003): 'Invalid parameters'
+object ERROR  src/object/obj_class.c:829 dc_set_oclass() grp_size 5 > domain_nr 1, DER_INVAL(-1003): 'Invalid parameters'
+dfs  ERROR  src/client/dfs/cont.c:254 dfs_cont_create() Failed to generate SB OID DER_INVAL(-1003): 'Invalid parameters'
 ERROR: daos: failed to create container: DER_INVAL(-1003): Invalid parameters
 ```
 

docs/user/interface.md

@@ -161,7 +161,7 @@ except DaosApiError as e:
 #### Logging
 
 The Python DAOS API exposes functionality to log messages to the DAOS client log.
-Messages can be logged as `INFO`, `DEBUG`, `WARN`, or `ERR` log levels.
+Messages can be logged as `INFO`, `DEBUG`, `WARN`, or `ERROR` log levels.
 The DAOS log object must be initialized with the environmental context in which to run:
 
 ```python

src/cart/README.env

@@ -52,8 +52,8 @@ This file lists the environment variables used in CaRT.
    BULK, GRP, LM, HG, etc.
    Can set different log level for different subsystems, for example:
    "export D_LOG_MASK=DEBUG" will set all subsystems' loglevel as DEBUG
-   "export D_LOG_MASK=ERR,RPC=DEBUG,BULK=INFO" will set RPC's loglevel as
-   DEBUG, BULK's log level as INFO, all other subsystems' loglevel as ERR.
+   "export D_LOG_MASK=ERROR,RPC=DEBUG,BULK=INFO" will set RPC's loglevel as
+   DEBUG, BULK's log level as INFO, all other subsystems' loglevel as ERROR.
    If neither above 2 or 3 ENVs set, the default loglevel is WARN and log device
    is stdout.
 
@@ -69,7 +69,7 @@ This file lists the environment variables used in CaRT.
 
  . D_LOG_FLUSH
    Specifies priority level for flushing of messages into the log file.
-   Can be set to one of the following "DBUG,INFO,NOTE,WARN,ERR,CRIT,ALRT,EMRG,EMIT"
+   Can be set to one of the following "DEBUG,INFO,NOTE,WARN,ERROR,CRIT,ALRT,FATAL,EMIT"
    If not set will default to "WARN".
 
  . DD_STDERR

src/common/debug.c

@@ -242,7 +242,7 @@ daos_debug_init_ex(char *logfile, d_dbug_t logmask)
 
 int daos_debug_init(char *logfile)
 {
-	/* for client side, by default use ERR level */
+	/* for client side, by default use ERROR level */
 	return daos_debug_init_ex(logfile, DLOG_ERR);
 }
 

src/control/cmd/daos/main.go

@@ -118,7 +118,7 @@ or query/manage an object inside a container.`
 		if opts.Debug {
 			log.SetLevel(logging.LogLevelTrace)
 			if os.Getenv("D_LOG_MASK") == "" {
-				os.Setenv("D_LOG_MASK", "DEBUG,OBJECT=ERR,PLACEMENT=ERR")
+				os.Setenv("D_LOG_MASK", "DEBUG,OBJECT=ERROR,PLACEMENT=ERROR")
 			}
 			if os.Getenv("DD_MASK") == "" {
 				os.Setenv("DD_MASK", "mgmt")

src/control/cmd/dmg/server.go

@@ -28,7 +28,7 @@ type serverSetLogMasksCmd struct {
 	ctlInvokerCmd
 	hostListCmd
 	cmdutil.JSONOutputCmd
-	Masks      *string `short:"m" long:"masks" description:"Set log masks for a set of facilities to a given level. The input string should look like PREFIX1=LEVEL1,PREFIX2=LEVEL2,... where the syntax is identical to what is expected by 'D_LOG_MASK' environment variable. If the 'PREFIX=' part is omitted, then the level applies to all defined facilities (e.g. a value of 'WARN' sets everything to WARN). If unset then reset engine log masks to use the 'log_mask' value set in the server config file (for each engine) at the time of DAOS system format. Supported levels are FATAL, CRIT, ERR, WARN, NOTE, INFO, DEBUG"`
+	Masks      *string `short:"m" long:"masks" description:"Set log masks for a set of facilities to a given level. The input string should look like PREFIX1=LEVEL1,PREFIX2=LEVEL2,... where the syntax is identical to what is expected by 'D_LOG_MASK' environment variable. If the 'PREFIX=' part is omitted, then the level applies to all defined facilities (e.g. a value of 'WARN' sets everything to WARN). If unset then reset engine log masks to use the 'log_mask' value set in the server config file (for each engine) at the time of DAOS system format. Supported levels are FATAL, CRIT, ERROR, WARN, NOTE, INFO, DEBUG"`
 	Streams    *string `short:"d" long:"streams" description:"Employ finer grained control over debug streams. Mask bits are set as the first argument passed in D_DEBUG(mask, ...) and this input string (DD_MASK) can be set to enable different debug streams. The expected syntax is a comma separated list of stream identifiers and accepted DAOS Debug Streams are md,pl,mgmt,epc,df,rebuild,daos_default and Common Debug Streams (GURT) are any,trace,mem,net,io. If not set, streams will be read from server config file and if set to an empty string then all debug streams will be enabled"`
 	Subsystems *string `short:"s" long:"subsystems" description:"This input string is equivalent to the use of the DD_SUBSYS environment variable and can be set to enable logging for specific subsystems or facilities. The expected syntax is a comma separated list of facility identifiers. Accepted DAOS facilities are common,tree,vos,client,server,rdb,pool,container,object,placement,rebuild,tier,mgmt,bio,tests, Common facilities (GURT) are MISC,MEM and CaRT facilities RPC,BULK,CORPC,GRP,LM,HG,ST,IV If not set, subsystems to enable will be read from server config file and if set to an empty string then logging all subsystems will be enabled"`
 }