1GANESHA-LOG-CONFIG(8)             NFS-Ganesha            GANESHA-LOG-CONFIG(8)
2
3
4

NAME

6       ganesha-log-config - NFS Ganesha Log Configuration File
7

SYNOPSIS

9       /etc/ganesha/ganesha.conf
10
11

DESCRIPTION

13       NFS-Ganesha  reads  the  configuration  data from: | /etc/ganesha/gane‐
14       sha.conf
15
16       This file lists NFS-Ganesha Log config options.
17
18       These options may be dynamically updated by issuing  a  SIGHUP  to  the
19       ganesha.nfsd process.
20
21   LOG {}
22       Default_log_level(token,default EVENT)
23          If  this  option  is  NOT  set, the fall back log level will be that
24          specified in the -N option on the command line if that is set,  oth‐
25          erwise the fallback level is EVENT.
26              If  a  SIGHUP  is  issued, any components not specified in LOG {
27              COMPONENTS {} } will be reset to this value.
28
29       The log levels are:
30
31       NULL, FATAL, MAJ, CRIT, WARN, EVENT,  INFO,  DEBUG,  MID_DEBUG,  M_DBG,
32       FULL_DEBUG, F_DBG
33
34       RPC_Debug_Flags(uint32, range 0 to UINT32_MAX, default 7)
35              Debug  flags  for  TIRPC  (default  7  matches log level default
36              EVENT).
37
38              These flags are only used if the TIRPC component is set to DEBUG
39
40       Display_UTC_Timestamp(bool, default false)
41              Flag to enable displaying UTC date/time in log messages  instead
42              of localtime.
43
44   LOG { COMPONENTS {} }
45       Default_log_level(token,default EVENT)
46
47              These entries are of the form:
48                     COMPONENT = LEVEL;
49
50              The components are:
51                     ALL, LOG, MEMLEAKS, FSAL, NFSPROTO, NFS_V4, EXPORT, FILE‐
52                     HANDLE,    DISPATCH,    CACHE_INODE,     CACHE_INODE_LRU,
53                     HASHTABLE, HASHTABLE_CACHE, DUPREQ, INIT, MAIN, IDMAPPER,
54                     NFS_READDIR,  NFS_V4_LOCK,  CONFIG,  CLIENTID,  SESSIONS,
55                     PNFS,   RW_LOCK,   NLM,   RPC,   TIRPC,  NFS_CB,  THREAD,
56                     NFS_V4_ACL,  STATE,  9P,  9P_DISPATCH,   FSAL_UP,   DBUS,
57                     NFS_MSK
58
59              Some synonyms are:
60                     FH  =  FILEHANDLE  HT  =  HASHTABLE INODE_LRU = CACHE_IN‐
61                     ODE_LRU INODE = CACHE_INODE DISP = DISPATCH LEAKS =  MEM‐
62                     LEAKS   NFS3   =   NFSPROTO  NFS4  =  NFS_V4  HT_CACHE  =
63                     HASHTABLE_CACHE   NFS_STARTUP   =   INIT   NFS4_LOCK    =
64                     NFS_V4_LOCK NFS4_ACL = NFS_V4_ACL 9P_DISP = 9P_DISPATCH
65
66              The log levels are:
67                     NULL, FATAL, MAJ, CRIT, WARN, EVENT, INFO, DEBUG, MID_DE‐
68                     BUG, M_DBG, FULL_DEBUG, F_DBG
69
70                     default none
71
72              ALL is a special component that when set, sets all components to
73              the  specified  value,  overriding  any that are explicitly set.
74              Note that if ALL is then removed from the config and  SIGHUP  is
75              issued, all components will revert to what is explicitly set, or
76              Default_Log_Level if that is  specified,  or  the  original  log
77              level  from  the  -N command line option if that was set, or the
78              code default of EVENT.
79
80              TIRPC is a special component that also sets the  active  RPC_De‐
81              bug_Flags.   If  the  level for TIRPC is DEBUG or MID_DEBUG, the
82              custom RPC_Debug_Flags set by that parameter will be used,  oth‐
83              erwise flags will depend on the level the TIRPC component is set
84              to:
85                 NULL or FATAL: 0
86
87                 CRIT or MAJ: TIRPC_DEBUG_FLAG_ERROR
88
89                 WARN: TIRPC_DEBUG_FLAG_ERROR | TIRPC_DEBUG_FLAG_WARN
90
91                 EVENT or INFO: TIRPC_DEBUG_FLAG_ERROR | TIRPC_DEBUG_FLAG_WARN
92                 | TIRPC_DEBUG_FLAG_EVENT
93
94                 DEBUG or MID_DEBUG: RPC_Debug_Flags
95
96                 FULL_DEBUG: 0xffffffff
97
98   LOG { FACILITY {} }
99       name(string, no default)
100
101       destination(string, no default, must be supplied)
102
103       max_level(token,default FULL_DEBUG)
104              The log levels are:
105                 NULL,  FATAL, MAJ, CRIT, WARN, EVENT, INFO, DEBUG, MID_DEBUG,
106                 M_DBG, FULL_DEBUG, F_DBG
107
108       headers(token, values [none, component, all], default all)
109
110       enable(token, values [idle, active, default], default idle)
111
112   LOG { FORMAT {} }
113       date_format(enum,default ganesha)
114
115              Possible values:
116                     ganesha, true, local, 8601, ISO-8601, ISO 8601, ISO, sys‐
117                     log, syslog_usec, false, none, user_defined
118
119       time_format(enum,default ganesha)
120
121              Possible values:
122                     ganesha, true, local, 8601, ISO-8601, ISO 8601, ISO, sys‐
123                     log, syslog_usec, false, none, user_defined
124
125       user_date_format(string, no default)
126
127       user_time_format(string, no default)
128
129       EPOCH(bool, default true)
130
131       CLIENTIP(bool, default false)
132
133       HOSTNAME(bool, default true)
134
135       PROGNAME(bool, default true)
136
137       PID(bool, default true)
138
139       THREAD_NAME(bool, default true)
140
141       FILE_NAME(bool, default true)
142
143       LINE_NUM(bool, default true)
144
145       FUNCTION_NAME(bool, default true)
146
147       COMPONENT(bool, default true)
148
149       LEVEL(bool, default true)
150

SEE ALSO

152       ganesha-config(8)
153
154
155
156
157                                 Feb 28, 2023            GANESHA-LOG-CONFIG(8)
Impressum