.\" Man page generated from reStructuredText.
.
.TH "GANESHA-LOG-CONFIG" "8" "Jan 20, 2023" "" "NFS-Ganesha"
.SH NAME
ganesha-log-config \- NFS Ganesha Log Configuration File
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
/etc/ganesha/ganesha.conf
.fi
.sp
.SH DESCRIPTION
.sp
NFS\-Ganesha reads the configuration data from:
| /etc/ganesha/ganesha.conf
.sp
This file lists NFS\-Ganesha Log config options.
.sp
These options may be dynamically updated by issuing a SIGHUP to the ganesha.nfsd
process.
.SS LOG {}
.sp
Default_log_level(token,default EVENT)
.INDENT 0.0
.INDENT 3.5
If this option is NOT set, the fall back log level will be that specified in
the \-N option on the command line if that is set, otherwise the fallback
level is EVENT.
.INDENT 0.0
.INDENT 3.5
If a SIGHUP is issued, any components not specified in LOG { COMPONENTS {} }
will be reset to this value.
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.sp
The log levels are:
.sp
NULL, FATAL, MAJ, CRIT, WARN, EVENT,
INFO, DEBUG, MID_DEBUG, M_DBG,
FULL_DEBUG, F_DBG
.INDENT 0.0
.TP
.B RPC_Debug_Flags(uint32, range 0 to UINT32_MAX, default 7)
Debug flags for TIRPC (default 7 matches log level default EVENT).
.sp
These flags are only used if the TIRPC component is set to DEBUG
.TP
.B Display_UTC_Timestamp(bool, default false)
Flag to enable displaying UTC date/time in log messages instead of localtime.
.UNINDENT
.SS LOG { COMPONENTS {} }
.INDENT 0.0
.TP
\fBDefault_log_level(token,default EVENT)\fP
.INDENT 7.0
.TP
.B These entries are of the form:
COMPONENT = LEVEL;
.TP
.B The components are:
ALL, LOG, MEMLEAKS, FSAL, NFSPROTO,
NFS_V4, EXPORT, FILEHANDLE, DISPATCH, CACHE_INODE,
CACHE_INODE_LRU, HASHTABLE, HASHTABLE_CACHE, DUPREQ,
INIT, MAIN, IDMAPPER, NFS_READDIR, NFS_V4_LOCK,
CONFIG, CLIENTID, SESSIONS, PNFS, RW_LOCK, NLM, RPC,
TIRPC, NFS_CB, THREAD, NFS_V4_ACL, STATE, 9P,
9P_DISPATCH, FSAL_UP, DBUS, NFS_MSK
.TP
.B Some synonyms are:
FH = FILEHANDLE
HT = HASHTABLE
INODE_LRU = CACHE_INODE_LRU
INODE = CACHE_INODE
DISP = DISPATCH
LEAKS = MEMLEAKS
NFS3 = NFSPROTO
NFS4 = NFS_V4
HT_CACHE = HASHTABLE_CACHE
NFS_STARTUP = INIT
NFS4_LOCK = NFS_V4_LOCK
NFS4_ACL = NFS_V4_ACL
9P_DISP = 9P_DISPATCH
.TP
.B The log levels are:
NULL, FATAL, MAJ, CRIT, WARN, EVENT,
INFO, DEBUG, MID_DEBUG, M_DBG,
FULL_DEBUG, F_DBG
.sp
default none
.UNINDENT
.sp
ALL is a special component that when set, sets all components to the
specified value, overriding any that are explicitly set. Note that if
ALL is then removed from the config and SIGHUP is issued, all components
will revert to what is explicitly set, or Default_Log_Level if that is
specified, or the original log level from the \-N command line option
if that was set, or the code default of EVENT.
.sp
TIRPC is a special component that also sets the active RPC_Debug_Flags.
If the level for TIRPC is DEBUG or MID_DEBUG, the custom RPC_Debug_Flags
set by that parameter will be used, otherwise flags will depend on the
level the TIRPC component is set to:
.INDENT 7.0
.INDENT 3.5
NULL or FATAL: 0
.sp
CRIT or MAJ: TIRPC_DEBUG_FLAG_ERROR
.sp
WARN: TIRPC_DEBUG_FLAG_ERROR | TIRPC_DEBUG_FLAG_WARN
.sp
EVENT or INFO: TIRPC_DEBUG_FLAG_ERROR | TIRPC_DEBUG_FLAG_WARN | TIRPC_DEBUG_FLAG_EVENT
.sp
DEBUG or MID_DEBUG: RPC_Debug_Flags
.sp
FULL_DEBUG: 0xffffffff
.UNINDENT
.UNINDENT
.UNINDENT
.SS LOG { FACILITY {} }
.sp
\fBname(string, no default)\fP
.sp
\fBdestination(string, no default, must be supplied)\fP
.INDENT 0.0
.TP
\fBmax_level(token,default FULL_DEBUG)\fP
The log levels are:
.INDENT 7.0
.INDENT 3.5
NULL, FATAL, MAJ, CRIT, WARN, EVENT,
INFO, DEBUG, MID_DEBUG, M_DBG,
FULL_DEBUG, F_DBG
.UNINDENT
.UNINDENT
.UNINDENT
.sp
\fBheaders(token, values [none, component, all], default all)\fP
.sp
\fBenable(token, values [idle, active, default], default idle)\fP
.SS LOG { FORMAT {} }
.INDENT 0.0
.TP
.B date_format(enum,default ganesha)
.INDENT 7.0
.TP
.B Possible values:
ganesha, true, local, 8601, ISO\-8601,
ISO 8601, ISO, syslog, syslog_usec,
false, none, user_defined
.UNINDENT
.TP
.B time_format(enum,default ganesha)
.INDENT 7.0
.TP
.B Possible values:
ganesha, true, local, 8601, ISO\-8601,
ISO 8601, ISO, syslog, syslog_usec,
false, none, user_defined
.UNINDENT
.UNINDENT
.sp
\fBuser_date_format(string, no default)\fP
.sp
\fBuser_time_format(string, no default)\fP
.sp
\fBEPOCH(bool, default true)\fP
.sp
\fBCLIENTIP(bool, default false)\fP
.sp
\fBHOSTNAME(bool, default true)\fP
.sp
\fBPROGNAME(bool, default true)\fP
.sp
\fBPID(bool, default true)\fP
.sp
\fBTHREAD_NAME(bool, default true)\fP
.sp
\fBFILE_NAME(bool, default true)\fP
.sp
\fBLINE_NUM(bool, default true)\fP
.sp
\fBFUNCTION_NAME(bool, default true)\fP
.sp
\fBCOMPONENT(bool, default true)\fP
.sp
\fBLEVEL(bool, default true)\fP
.SH SEE ALSO
.sp
ganesha\-config(8)
.\" Generated by docutils manpage writer.
.