rcutils
master
C API providing common utilities and data structures.
|
Go to the documentation of this file.
15 #ifndef RCUTILS__LOGGING_H_
16 #define RCUTILS__LOGGING_H_
34 #define RCUTILS_LOGGING_SEPARATOR_CHAR '.'
35 #define RCUTILS_LOGGING_SEPARATOR_STRING "."
41 #define RCUTILS_DEFAULT_LOGGER_DEFAULT_LEVEL RCUTILS_LOG_SEVERITY_INFO
510 const
char * format,
va_list * args);
518 #define RCUTILS_LOGGING_AUTOINIT \
519 if (RCUTILS_UNLIKELY(!g_rcutils_logging_initialized)) { \
520 rcutils_ret_t ret = rcutils_logging_initialize(); \
521 if (ret != RCUTILS_RET_OK) { \
522 RCUTILS_SAFE_FWRITE_TO_STDERR( \
523 "[rcutils|" __FILE__ ":" RCUTILS_STRINGIFY(__LINE__) \
524 "] error initializing logging: "); \
525 RCUTILS_SAFE_FWRITE_TO_STDERR(rcutils_get_error_string().str); \
526 RCUTILS_SAFE_FWRITE_TO_STDERR("\n"); \
527 rcutils_reset_error(); \
535 #endif // RCUTILS__LOGGING_H_
bool rcutils_logging_logger_is_enabled_for(const char *name, int severity)
Determine if a logger is enabled for a severity level.
rcutils_ret_t rcutils_logging_severity_level_from_string(const char *severity_string, rcutils_allocator_t allocator, int *severity)
Get a severity value from its string representation (e.g. DEBUG).
rcutils_ret_t rcutils_logging_initialize_with_allocator(rcutils_allocator_t allocator)
Initialize the logging system using the specified allocator.
rcutils_ret_t rcutils_logging_shutdown(void)
Shutdown the logging system.
rcutils_ret_t rcutils_logging_set_logger_level(const char *name, int level)
Set the severity level for a logger.
int rcutils_logging_get_default_logger_level()
Get the default level for loggers.
#define RCUTILS_ATTRIBUTE_PRINTF_FORMAT(format_string_index, first_to_check_index)
Definition: macros.h:94
@ RCUTILS_LOG_SEVERITY_DEBUG
The debug log level.
Definition: logging.h:168
rcutils_ret_t rcutils_logging_initialize(void)
Initialize the logging system.
struct rcutils_log_location_t rcutils_log_location_t
The structure identifying the caller location in the source code.
int rcutils_logging_get_logger_level(const char *name)
Get the severity level for a logger.
RCUTILS_LOG_SEVERITY
The severity levels of log messages / loggers.
Definition: logging.h:165
void rcutils_logging_set_output_handler(rcutils_logging_output_handler_t function)
Set the current output handler.
void(* rcutils_logging_output_handler_t)(const rcutils_log_location_t *, int, const char *, rcutils_time_point_value_t, const char *, va_list *)
The function signature to log messages.
Definition: logging.h:211
int g_rcutils_logging_default_logger_level
The default severity level for loggers.
const char * function_name
The name of the function containing the log call.
Definition: logging.h:157
@ RCUTILS_LOG_SEVERITY_INFO
The info log level.
Definition: logging.h:169
bool g_rcutils_logging_initialized
The flag if the logging system has been initialized.
rcutils_logging_output_handler_t rcutils_logging_get_output_handler()
Get the current output handler.
rcutils_logging_output_handler_t g_rcutils_logging_output_handler
The function pointer of the current output handler.
int rcutils_ret_t
Definition: rcutils_ret.h:23
void void rcutils_logging_console_output_handler(const rcutils_log_location_t *location, int severity, const char *name, rcutils_time_point_value_t timestamp, const char *format, va_list *args)
The default output handler outputs log messages to the standard streams.
int rcutils_logging_get_logger_leveln(const char *name, size_t name_length)
Get the level for a logger and its name length.
void rcutils_logging_set_default_logger_level(int level)
Set the default severity level for loggers.
@ RCUTILS_LOG_SEVERITY_UNSET
The unset log level.
Definition: logging.h:167
void rcutils_log(const rcutils_log_location_t *location, int severity, const char *name, const char *format,...) RCUTILS_ATTRIBUTE_PRINTF_FORMAT(4
Log a message.
#define RCUTILS_WARN_UNUSED
Definition: macros.h:24
int64_t rcutils_time_point_value_t
A single point in time, measured in nanoseconds since the Unix epoch.
Definition: time.h:46
@ RCUTILS_LOG_SEVERITY_FATAL
The fatal log level.
Definition: logging.h:172
The structure identifying the caller location in the source code.
Definition: logging.h:154
rcutils_ret_t rcutils_logging_format_message(const rcutils_log_location_t *location, int severity, const char *name, rcutils_time_point_value_t timestamp, const char *msg, rcutils_char_array_t *logging_output)
Formats a log message according to RCUTILS_CONSOLE_OUTPUT_FORMAT.
Encapsulation of an allocator.
Definition: allocator.h:45
const char *const g_rcutils_log_severity_names[RCUTILS_LOG_SEVERITY_FATAL+1]
The names of severity levels.
#define RCUTILS_PUBLIC
Definition: visibility_control.h:23
@ RCUTILS_LOG_SEVERITY_ERROR
The error log level.
Definition: logging.h:171
@ RCUTILS_LOG_SEVERITY_WARN
The warn log level.
Definition: logging.h:170
Definition: char_array.h:29
int rcutils_logging_get_logger_effective_level(const char *name)
Determine the effective level for a logger.
size_t line_number
The line number containing the log call.
Definition: logging.h:161
const char * file_name
The name of the source file containing the log call.
Definition: logging.h:159