4c0406a69c
This commit is only to introduce new logging macros.
The current implementation is such that a statement like:
MAXSCALE_NOTICE("Refreshing configuration following SIGHUP\n");
is equivalent with
LOGIF(LM, (skygw_log_write(
LOGFILE_MESSAGE,
"Refreshing configuration following SIGHUP\n")));
The actual implementation will later be changed as the logging
mechanism itself is changed.
The names of the macros are now according to the levels of syslog
and currently the mapping is like:
MAXSCALE_ERROR (Syslog LOG_ERR) -> LOGFILE_ERROR
MAXSCALE_WARNING (Syslog LOG_WARNING) -> LOGFILE_ERROR
MAXSCALE_NOTICE (Syslof LOG_NOTICE) -> LOGFILE_MESSAGE
MAXSCALE_INFO (Syslog LOG_INFO) -> LOGFILE_TRACE
MAXSCALE_DEBUG (Syslog LOG_DEBUG) -> LOGFILE_DEBUG
When log manager is changed to deal "natively" with syslog levels
this mapping will disappear of course.
210 lines
6.2 KiB
C
210 lines
6.2 KiB
C
/*
|
|
* This file is distributed as part of the MariaDB Corporation MaxScale. It is free
|
|
* software: you can redistribute it and/or modify it under the terms of the
|
|
* GNU General Public License as published by the Free Software Foundation,
|
|
* version 2.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along with
|
|
* this program; if not, write to the Free Software Foundation, Inc., 51
|
|
* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Copyright MariaDB Corporation Ab 2013-2014
|
|
*/
|
|
#if !defined(LOG_MANAGER_H)
|
|
# define LOG_MANAGER_H
|
|
|
|
/*
|
|
* We need a common.h file that is included by every component.
|
|
*/
|
|
#if !defined(STRERROR_BUFLEN)
|
|
#define STRERROR_BUFLEN 512
|
|
#endif
|
|
|
|
typedef enum
|
|
{
|
|
BB_READY = 0x00,
|
|
BB_FULL,
|
|
BB_CLEARED
|
|
} blockbuf_state_t;
|
|
|
|
typedef enum
|
|
{
|
|
LOGFILE_ERROR = 1,
|
|
LOGFILE_FIRST = LOGFILE_ERROR,
|
|
LOGFILE_MESSAGE = 2,
|
|
LOGFILE_TRACE = 4,
|
|
LOGFILE_DEBUG = 8,
|
|
LOGFILE_LAST = LOGFILE_DEBUG
|
|
} logfile_id_t;
|
|
|
|
|
|
typedef enum
|
|
{
|
|
FILEWRITER_INIT,
|
|
FILEWRITER_RUN,
|
|
FILEWRITER_DONE
|
|
} filewriter_state_t;
|
|
|
|
/**
|
|
* Thread-specific logging information.
|
|
*/
|
|
typedef struct log_info
|
|
{
|
|
size_t li_sesid;
|
|
int li_enabled_logs;
|
|
} log_info_t;
|
|
|
|
#define LE LOGFILE_ERROR
|
|
#define LM LOGFILE_MESSAGE
|
|
#define LT LOGFILE_TRACE
|
|
#define LD LOGFILE_DEBUG
|
|
|
|
/**
|
|
* Check if specified log type is enabled in general or if it is enabled
|
|
* for the current session.
|
|
*/
|
|
#define LOG_IS_ENABLED(id) (((lm_enabled_logfiles_bitmask & id) || \
|
|
(log_ses_count[id] > 0 && \
|
|
tls_log_info.li_enabled_logs & id)) ? true : false)
|
|
|
|
|
|
#define LOG_MAY_BE_ENABLED(id) (((lm_enabled_logfiles_bitmask & id) || \
|
|
log_ses_count[id] > 0) ? true : false)
|
|
/**
|
|
* Execute the given command if specified log is enabled in general or
|
|
* if there is at least one session for whom the log is enabled.
|
|
*/
|
|
#define LOGIF_MAYBE(id,cmd) if (LOG_MAY_BE_ENABLED(id)) \
|
|
{ \
|
|
cmd; \
|
|
}
|
|
|
|
/**
|
|
* Execute the given command if specified log is enabled in general or
|
|
* if the log is enabled for the current session.
|
|
*/
|
|
#define LOGIF(id,cmd) if (LOG_IS_ENABLED(id)) \
|
|
{ \
|
|
cmd; \
|
|
}
|
|
|
|
#if !defined(LOGIF)
|
|
#define LOGIF(id,cmd) if (lm_enabled_logfiles_bitmask & id) \
|
|
{ \
|
|
cmd; \
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* UNINIT means zeroed memory buffer allocated for the struct.
|
|
* INIT means that struct members may have values, and memory may
|
|
* have been allocated. Done function must check and free it.
|
|
* RUN Struct is valid for run-time checking.
|
|
* DONE means that possible memory allocations have been released.
|
|
*/
|
|
typedef enum
|
|
{
|
|
UNINIT = 0,
|
|
INIT,
|
|
RUN,
|
|
DONE
|
|
} flat_obj_state_t;
|
|
|
|
/**
|
|
* LOG_AUGMENT_WITH_FUNCTION Each logged line is suffixed with [function-name].
|
|
*/
|
|
typedef enum
|
|
{
|
|
LOG_AUGMENT_WITH_FUNCTION = 1,
|
|
LOG_AUGMENTATION_MASK = (LOG_AUGMENT_WITH_FUNCTION)
|
|
} log_augmentation_t;
|
|
|
|
/**
|
|
* LOG_FLUSH_NO Do not flush after writing.
|
|
* LOG_FLUSH_YES Flush after writing.
|
|
*/
|
|
enum log_flush
|
|
{
|
|
LOG_FLUSH_NO = 0,
|
|
LOG_FLUSH_YES = 1
|
|
};
|
|
|
|
EXTERN_C_BLOCK_BEGIN
|
|
|
|
bool skygw_logmanager_init(int argc, char* argv[]);
|
|
void skygw_logmanager_done(void);
|
|
void skygw_logmanager_exit(void);
|
|
|
|
/**
|
|
* free private write buffer list
|
|
*/
|
|
void skygw_log_done(void);
|
|
int skygw_log_write_context(logfile_id_t id,
|
|
enum log_flush flush,
|
|
const char* file, int line, const char* function,
|
|
const char* format, ...);
|
|
int skygw_log_flush(logfile_id_t id);
|
|
void skygw_log_sync_all(void);
|
|
int skygw_log_rotate(logfile_id_t id);
|
|
int skygw_log_enable(logfile_id_t id);
|
|
int skygw_log_disable(logfile_id_t id);
|
|
void skygw_log_sync_all(void);
|
|
void skygw_set_highp(int);
|
|
void logmanager_enable_syslog(int);
|
|
void logmanager_enable_maxscalelog(int);
|
|
|
|
#define skygw_log_write(id, format, ...)\
|
|
skygw_log_write_context(id, LOG_FLUSH_NO, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)
|
|
|
|
#define skygw_log_write_flush(id, format, ...)\
|
|
skygw_log_write_context(id, LOG_FLUSH_YES, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__)
|
|
|
|
/**
|
|
* What augmentation if any should a logged message be augmented with.
|
|
*
|
|
* Currently this is a global setting and affects all loggers.
|
|
*/
|
|
void skygw_log_set_augmentation(int bits);
|
|
int skygw_log_get_augmentation();
|
|
|
|
EXTERN_C_BLOCK_END
|
|
|
|
const char* get_trace_prefix_default(void);
|
|
const char* get_trace_suffix_default(void);
|
|
const char* get_msg_prefix_default(void);
|
|
const char* get_msg_suffix_default(void);
|
|
const char* get_err_prefix_default(void);
|
|
const char* get_err_suffix_default(void);
|
|
const char* get_logpath_default(void);
|
|
|
|
/**
|
|
* Helper, not to be called directly.
|
|
*/
|
|
#define MAXSCALE_MESSAGE_FLUSH(id, format, ...)\
|
|
do { if (LOG_IS_ENABLED(id)) { skygw_log_write_flush(id, format, ##__VA_ARGS__); } } while (false)
|
|
|
|
/**
|
|
* Helper, not to be called directly.
|
|
*/
|
|
#define MAXSCALE_MESSAGE(id, format, ...)\
|
|
do { if (LOG_IS_ENABLED(id)) { skygw_log_write(id, format, ##__VA_ARGS__); } } while (false)
|
|
|
|
/**
|
|
* Log an error, warning, notice, info, or debug message.
|
|
*
|
|
* @param format The printf format of the message.
|
|
* @param ... Arguments, depending on the format.
|
|
*/
|
|
#define MAXSCALE_ERROR(format, ...) MAXSCALE_MESSAGE_FLUSH(LOGFILE_ERROR, format, ##__VA_ARGS__)
|
|
#define MAXSCALE_WARNING(format, ...) MAXSCALE_MESSAGE(LOGFILE_ERROR, format, ##__VA_ARGS__)
|
|
#define MAXSCALE_NOTICE(format, ...) MAXSCALE_MESSAGE(LOGFILE_MESSAGE, format, ##__VA_ARGS__)
|
|
#define MAXSCALE_INFO(format, ...) MAXSCALE_MESSAGE(LOGFILE_TRACE, format, ##__VA_ARGS__)
|
|
#define MAXSCALE_DEBUG(format, ...) MAXSCALE_MESSAGE(LOGFILE_DEBUG, format, ##__VA_ARGS__)
|
|
|
|
#endif /** LOG_MANAGER_H */
|