dnxLogging.h File Reference

Types and definitions for DNX Server Logging functionality. More...

Go to the source code of this file.

Functions
void	dnxLog (char *fmt,...)
	Log a parameterized message to the dnx system log file.
void	dnxDebug (int level, char *fmt,...)
	Log a parameterized message to the dnx DEBUG log.
int	dnxAudit (char *fmt,...)
	Log a parameterized message to the global audit log file.
void	dnxLogInit (char *logFile, char *debugFile, char *auditFile, int *debugLevel)
	Initialize the logging sub-system with global references.

---

Detailed Description

Types and definitions for DNX Server Logging functionality.

Author:

Robert W. Ingraham (dnx-devel@lists.sourceforge.net)

Attention:

Please submit patches to http://dnx.sourceforge.net

Definition in file dnxLogging.h.

---

Function Documentation

int dnxAudit	(	char *	fmt,
			...
	)

Log a parameterized message to the global audit log file.

Returns quickly if auditing is disabled because a null or empty log file was specified on startup.

Parameters:

[in]

fmt

- a format specifier string similar to that of printf.

Returns:

Zero on success, or a non-zero error value.

Definition at line 328 of file dnxLogging.c.

References dnx_vsyslog(), openFile(), s_audFileName, s_syslogAudit, and vlogger().

Referenced by dnxAuditJob().

void dnxDebug	(	int	level,
		char *	fmt,
			...
	)

Log a parameterized message to the dnx DEBUG log.

This routine logs a debug message if the current global (configured) debug level is greater than or equal the value of level.

Parameters:

[in]	level	- the debug level at which to log the message.
[in]	fmt	- a format specifier string similar to that of printf.

Definition at line 296 of file dnxLogging.c.

References dnx_vsyslog(), openFile(), s_dbgFileName, s_debugLevel, s_syslogDebug, and vlogger().

Referenced by AllocateNodeRequest(), cleanThreadPool(), dnxAgentServer(), dnxCheckHeap(), dnxCollector(), dnxFree(), dnxGetNodeRequest(), dnxJobListAdd(), dnxJobListCollect(), dnxJobListDispatch(), dnxMalloc(), dnxPluginExecute(), dnxPostNewJob(), dnxPostResult(), dnxRegisterNode(), dnxSendJob(), dnxSendJobMsg(), dnxSendMgmtReply(), dnxSendMgmtRequest(), dnxSendNodeRequest(), dnxSendResult(), dnxTimer(), dnxUdpRead(), dnxUdpWrite(), dnxWaitForJob(), dnxWaitForMgmtReply(), dnxWaitForMgmtRequest(), dnxWaitForNodeRequest(), dnxWaitForResult(), dnxWlmDestroy(), dnxWorker(), dnxWorkerCleanup(), dnxXmlUnescapeStr(), dump_block(), ehProcessData(), ehSvcCheck(), GetAckNak(), GetMsgHeader(), main(), processCommands(), ProcessJobTransferMsg(), processRequests(), ProcessResultTransferMsg(), SendMsgResponse(), and TransferJobToServer().

void dnxLog	(	char *	fmt,
			...
	)

Log a parameterized message to the dnx system log file.

Parameters:

[in]

fmt

- a format specifier string similar to that of printf.

Definition at line 264 of file dnxLogging.c.

References dnx_vsyslog(), openFile(), s_logFileName, s_syslogLog, and vlogger().

Referenced by createPidFile(), daemonize(), dnxAgentServer(), dnxCalculateJobListSize(), dnxCfgParserParse(), dnxCollector(), dnxCollectorCreate(), dnxDispatcher(), dnxDispatcherCreate(), dnxInitAgent(), dnxJobListAdd(), dnxPluginDeInit(), dnxPluginInit(), dnxPostNewJob(), dnxReconfigure(), dnxRegisterNode(), dnxRegistrar(), dnxRegistrarCreate(), dnxResultsListener(), dnxSendJobMsg(), dnxServerInit(), dnxTcpOpen(), dnxTcpRead(), dnxTcpWrite(), dnxTimer(), dnxTimerCreate(), dnxUdpOpen(), dnxUdpRead(), dnxUdpWrite(), dnxWlmCreate(), dnxWlmDestroy(), dnxWorker(), dropPrivileges(), ehProcessData(), ehSvcCheck(), growThreadPool(), initClientComm(), initWorkerComm(), launchScript(), logConfigChanges(), logGblConfigChanges(), main(), nebmodule_deinit(), nebmodule_init(), processCommands(), processRequests(), ProcessResultTransferMsg(), validateCfg(), and workerCreate().

void dnxLogInit	(	char *	logFile,
		char *	debugFile,
		char *	auditFile,
		int *	debugLevel
	)

Initialize the logging sub-system with global references.

System and debug logging defaults to STDOUT. Both "STDOUT" and "STDERR" may be specified as log file strings for the log, debug and audit file paths. The audit log is optional, and is disabled if auditFile is null or empty.

The address of the debug flag is passed so it can change the behavior of the logging system dynamically.

Parameters:

[in]	logFile	- the global log file path.
[in]	debugFile	- the global debug file path.
[in]	auditFile	- the global audit file path (optional).
[in]	debugLevel	- the address of the global debug level indicator.

Definition at line 362 of file dnxLogging.c.

References decodeSyslogFlags(), s_audFileName, s_dbgFileName, s_debugLevel, s_logFileName, s_syslogAudit, s_syslogDebug, s_syslogLog, SLTAG, and SYSLOG_IDENT.

Referenced by main(), and nebmodule_init().