xroad_logger.h File Reference

#include <common/xroad_string.h>
#include <common/xroad_xml.h>
#include <stdio.h>

Include dependency graph for xroad_logger.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	xroad_logx_error(logger, fmt, ...)   xroad_logx(logger, xroad_log_level_error, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlogx_error(logger, fmt, ap)   xroad_vlogx(logger, xroad_log_level_error, xroad_str(fmt), ap)
#define	xroad_log_error(fmt, ...)   xroad_logx(NULL, xroad_log_level_error, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlog_error(fmt, ap)   xroad_vlogx(NULL, xroad_log_level_error, xroad_str(fmt), ap)
#define	xroad_logx_warn(logger, fmt, ...)   xroad_logx(logger, xroad_log_level_warn, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlogx_warn(logger, fmt, ap)   xroad_vlogx(logger, xroad_log_level_warn, xroad_str(fmt), ap)
#define	xroad_log_warn(fmt, ...)   xroad_logx(NULL, xroad_log_level_warn, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlog_warn(fmt, ap)   xroad_vlogx(NULL, xroad_log_level_warn, xroad_str(fmt), ap)
#define	xroad_logx_notice(logger, fmt, ...)   xroad_logx(logger, xroad_log_level_notice, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlogx_notice(logger, fmt, ap)   xroad_vlogx(logger, xroad_log_level_notice, xroad_str(fmt), ap)
#define	xroad_log_notice(fmt, ...)   xroad_logx(NULL, xroad_log_level_notice, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlog_notice(fmt, ap)   xroad_vlogx(NULL, xroad_log_level_notice, xroad_str(fmt), ap)
#define	xroad_logx_info(logger, fmt, ...)   xroad_logx(logger, xroad_log_level_info, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlogx_info(logger, fmt, ap)   xroad_vlogx(logger, xroad_log_level_info, xroad_str(fmt), ap)
#define	xroad_log_info(fmt, ...)   xroad_logx(NULL, xroad_log_level_info, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlog_info(fmt, ap)   xroad_vlogx(NULL, xroad_log_level_info, xroad_str(fmt), ap)
#define	xroad_logx_debug(logger, fmt, ...)   xroad_logx(logger, xroad_log_level_debug, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlogx_debug(logger, fmt, ap)   xroad_vlogx(logger, xroad_log_level_debug, xroad_str(fmt), ap)
#define	xroad_log_debug(fmt, ...)   xroad_logx(NULL, xroad_log_level_debug, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlog_debug(fmt, ap)   xroad_vlogx(NULL, xroad_log_level_debug, xroad_str(fmt), ap)
#define	xroad_logx_trace(logger, fmt, ...)   xroad_logx(logger, xroad_log_level_trace, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlogx_trace(logger, fmt, ap)   xroad_vlogx(logger, xroad_log_level_trace, xroad_str(fmt), ap)
#define	xroad_log_trace(fmt, ...)   xroad_logx(NULL, xroad_log_level_trace, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlog_trace(fmt, ap)   xroad_vlogx(NULL, xroad_log_level_trace, xroad_str(fmt), ap)
#define	xroad_log(llevel, fmt, ...)   xroad_logx(NULL, llevel, xroad_str(fmt), ##__VA_ARGS__)
#define	xroad_vlog(llevel, fmt, ap)   xroad_vlogx(NULL, llevel, xroad_str(fmt), ap)

Typedefs
typedef struct xroad_logger_s	xroad_logger_t

Enumerations
enum	xroad_log_level_t {   xroad_log_level_error = 0x1 , xroad_log_level_warn = 0x2 , xroad_log_level_notice = 0x4 , xroad_log_level_info = 0x8 ,   xroad_log_level_debug = 0x10 , xroad_log_level_trace = 0x20 }

Functions
xroad_errno_t	xroad_logger_create ()
xroad_errno_t	xroad_logger_configure (xroad_xml_tag_t cfg)
void	xroad_logger_destroy ()
xroad_errno_t	xroad_logger_rotate ()
void	xroad_logger_disable_alarm ()
void	xroad_logger_enable_alarm ()
xroad_logger_t *	xroad_logger_get (xroad_str_t name)
xroad_log_level_t	xroad_logger_get_level (xroad_logger_t *logger)
void	xroad_logger_set_level (xroad_logger_t *logger, xroad_log_level_t llevel)
void	xroad_logx (xroad_logger_t *logger, xroad_log_level_t llevel, xroad_str_t fmt,...)
void	xroad_vlogx (xroad_logger_t *logger, xroad_log_level_t llevel, xroad_str_t fmt, va_list ap)

Detailed Description

Author

Dmitry S. Melnikov, dmitr.nosp@m.yme@.nosp@m.gmail.nosp@m..com

Macro Definition Documentation

xroad_log

#define xroad_log	(		llevel,
			fmt,
			...
	)		xroad_logx(NULL, llevel, xroad_str(fmt), ##__VA_ARGS__)

log record using main logger

xroad_log_debug

#define xroad_log_debug	(		fmt,
			...
	)		xroad_logx(NULL, xroad_log_level_debug, xroad_str(fmt), ##__VA_ARGS__)

log record as debug using main logger

xroad_log_error

#define xroad_log_error	(		fmt,
			...
	)		xroad_logx(NULL, xroad_log_level_error, xroad_str(fmt), ##__VA_ARGS__)

log record as error using main logger

xroad_log_info

#define xroad_log_info	(		fmt,
			...
	)		xroad_logx(NULL, xroad_log_level_info, xroad_str(fmt), ##__VA_ARGS__)

log record as info using main logger

xroad_log_notice

#define xroad_log_notice	(		fmt,
			...
	)		xroad_logx(NULL, xroad_log_level_notice, xroad_str(fmt), ##__VA_ARGS__)

log record as notice using main logger

xroad_log_trace

#define xroad_log_trace	(		fmt,
			...
	)		xroad_logx(NULL, xroad_log_level_trace, xroad_str(fmt), ##__VA_ARGS__)

log record as trace using main logger

xroad_log_warn

#define xroad_log_warn	(		fmt,
			...
	)		xroad_logx(NULL, xroad_log_level_warn, xroad_str(fmt), ##__VA_ARGS__)

log record as warn using main logger

xroad_logx_debug

#define xroad_logx_debug	(		logger,
			fmt,
			...
	)		xroad_logx(logger, xroad_log_level_debug, xroad_str(fmt), ##__VA_ARGS__)

log record as debug

xroad_logx_error

#define xroad_logx_error	(		logger,
			fmt,
			...
	)		xroad_logx(logger, xroad_log_level_error, xroad_str(fmt), ##__VA_ARGS__)

log record as error

xroad_logx_info

#define xroad_logx_info	(		logger,
			fmt,
			...
	)		xroad_logx(logger, xroad_log_level_info, xroad_str(fmt), ##__VA_ARGS__)

log record as info

xroad_logx_notice

#define xroad_logx_notice	(		logger,
			fmt,
			...
	)		xroad_logx(logger, xroad_log_level_notice, xroad_str(fmt), ##__VA_ARGS__)

log record as notice

xroad_logx_trace

#define xroad_logx_trace	(		logger,
			fmt,
			...
	)		xroad_logx(logger, xroad_log_level_trace, xroad_str(fmt), ##__VA_ARGS__)

log record as trace

xroad_logx_warn

#define xroad_logx_warn	(		logger,
			fmt,
			...
	)		xroad_logx(logger, xroad_log_level_warn, xroad_str(fmt), ##__VA_ARGS__)

log record as warn

xroad_vlog

#define xroad_vlog	(		llevel,
			fmt,
			ap
	)		xroad_vlogx(NULL, llevel, xroad_str(fmt), ap)

log record using main logger

xroad_vlog_debug

#define xroad_vlog_debug	(		fmt,
			ap
	)		xroad_vlogx(NULL, xroad_log_level_debug, xroad_str(fmt), ap)

log record as debug using main logger

xroad_vlog_error

#define xroad_vlog_error	(		fmt,
			ap
	)		xroad_vlogx(NULL, xroad_log_level_error, xroad_str(fmt), ap)

log record as error using main logger

xroad_vlog_info

#define xroad_vlog_info	(		fmt,
			ap
	)		xroad_vlogx(NULL, xroad_log_level_info, xroad_str(fmt), ap)

log record as info using main logger

xroad_vlog_notice

#define xroad_vlog_notice	(		fmt,
			ap
	)		xroad_vlogx(NULL, xroad_log_level_notice, xroad_str(fmt), ap)

log record as notice using main logger

xroad_vlog_trace

#define xroad_vlog_trace	(		fmt,
			ap
	)		xroad_vlogx(NULL, xroad_log_level_trace, xroad_str(fmt), ap)

log record as trace using main logger

xroad_vlog_warn

#define xroad_vlog_warn	(		fmt,
			ap
	)		xroad_vlogx(NULL, xroad_log_level_warn, xroad_str(fmt), ap)

log record as warn using main logger

xroad_vlogx_debug

#define xroad_vlogx_debug	(		logger,
			fmt,
			ap
	)		xroad_vlogx(logger, xroad_log_level_debug, xroad_str(fmt), ap)

log record as debug

xroad_vlogx_error

#define xroad_vlogx_error	(		logger,
			fmt,
			ap
	)		xroad_vlogx(logger, xroad_log_level_error, xroad_str(fmt), ap)

log record as error

xroad_vlogx_info

#define xroad_vlogx_info	(		logger,
			fmt,
			ap
	)		xroad_vlogx(logger, xroad_log_level_info, xroad_str(fmt), ap)

log record as info

xroad_vlogx_notice

#define xroad_vlogx_notice	(		logger,
			fmt,
			ap
	)		xroad_vlogx(logger, xroad_log_level_notice, xroad_str(fmt), ap)

log record as notice

xroad_vlogx_trace

#define xroad_vlogx_trace	(		logger,
			fmt,
			ap
	)		xroad_vlogx(logger, xroad_log_level_trace, xroad_str(fmt), ap)

log record as trace

xroad_vlogx_warn

#define xroad_vlogx_warn	(		logger,
			fmt,
			ap
	)		xroad_vlogx(logger, xroad_log_level_warn, xroad_str(fmt), ap)

log record as warn

Enumeration Type Documentation

xroad_log_level_t

enum xroad_log_level_t

log level

Function Documentation

xroad_logger_configure()

xroad_errno_t xroad_logger_configure

(

xroad_xml_tag_t

cfg

)

configure logger

Parameters

[in]

cfg

- logger configuration

Returns

XROAD_OK - reconfigured, else failed

xroad_logger_create()

xroad_errno_t xroad_logger_create

(

)

create logger. NOTE: Alarming is disable by default. call xroad_logger_enable_alarm to enable it

Returns

XROAD_OK - created, else failed

xroad_logger_destroy()

void xroad_logger_destroy

(

)

destroy logger

xroad_logger_disable_alarm()

void xroad_logger_disable_alarm

(

)

disable alarm sending

xroad_logger_enable_alarm()

void xroad_logger_enable_alarm

(

)

enable alarm senging

xroad_logger_get_level()

xroad_log_level_t xroad_logger_get_level

(

xroad_logger_t *

logger

)

get current log level

Parameters

[in]

logger

- logger to set. if NULL, main logger alarm is set

xroad_logger_rotate()

xroad_errno_t xroad_logger_rotate

(

)

create new log file

Returns

XROAD_OK - rotated, else failed

xroad_logger_set_level()

void xroad_logger_set_level	(	xroad_logger_t *	logger,
		xroad_log_level_t	llevel
	)

set log level

Parameters

[in]	logger	- logger. if NULL, main logger is set (for stub logger all loggers will be set)
[in]	llevel	- new log level

xroad_logx()

void xroad_logx	(	xroad_logger_t *	logger,
		xroad_log_level_t	llevel,
		xroad_str_t	fmt,
			...
	)

log with setting level in variable.

Parameters

[in]	logger	- logger
[in]	llevel	- log level
[in]	fmt	- log pettern

xroad_vlogx()

void xroad_vlogx	(	xroad_logger_t *	logger,
		xroad_log_level_t	llevel,
		xroad_str_t	fmt,
		va_list	ap
	)

log with setting level in variable.

Parameters

[in]	logger	- logger
[in]	llevel	- log level
[in]	fmt	- log pettern
[in]	ap	- argument list