a thread safe logger with optional printf style logging More...

#include <pthread.h>
#include <string.h>
#include <stdbool.h>
#include "colors.h"

Include dependency graph for logger.h:

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

Data Structures
struct	thread_logger

struct	file_logger

Typedefs
typedef int(*	mutex_fn) (pthread_mutex_t *mx)

typedef void(*	log_fn) (struct thread_logger thl, int file_descriptor, char message, LOG_LEVELS level)

typedef void(*	log_fnf) (struct thread_logger thl, int file_descriptor, LOG_LEVELS level, char message,...)

typedef struct thread_logger	thread_logger

typedef struct file_logger	file_logger

Enumerations
enum	LOG_LEVELS { LOG_LEVELS_INFO, LOG_LEVELS_WARN, LOG_LEVELS_ERROR, LOG_LEVELS_DEBUG }

Functions
thread_logger *	new_thread_logger (bool with_debug)
	returns a new thread safe logger if with_debug is false, then all debug_log calls will be ignored More...

file_logger *	new_file_logger (char *output_file, bool with_debug)
	returns a new file_logger Calls new_thread_logger internally More...

void	clear_thread_logger (thread_logger *thl)
	free resources for the threaded logger More...

void	clear_file_logger (file_logger *fhl)
	free resources for the file ogger More...

void	log_func (thread_logger thl, int file_descriptor, char message, LOG_LEVELS level)
	main function you should call, which will delegate to the appopriate *_log function More...

void	logf_func (thread_logger thl, int file_descriptor, LOG_LEVELS level, char message,...)
	like log_func but for formatted logs More...

void	debug_log (thread_logger thl, int file_descriptor, char message)
	logs a debug styled message - called by log_fn More...

void	warn_log (thread_logger thl, int file_descriptor, char message)
	logs a warned styled message - called by log_fn More...

void	error_log (thread_logger thl, int file_descriptor, char message)
	logs an error styled message - called by log_fn More...

void	info_log (thread_logger thl, int file_descriptor, char message)
	logs an info styled message - called by log_fn More...

int	write_file_log (int file_descriptor, char *message)
	used to write a log message to file More...

Detailed Description

a thread safe logger with optional printf style logging

allows writing color coded logs to stdout, with optional file output as well. timestamps all logs, and provides optional printf style logging

Note

logf_func has a bug where some format is respected and others are not, consider the following from a ss format:

[error - Jul 06 10:01:07 PM] one<insert-tab-here>two
[warn - Jul 06 10:01:07 PM] one two

warn, and info appear to not respect format, while debug and error do

Todo:

buffer logs and use a dedicated thread for writing (avoid blocking locks)
handling system signals (exit, kill, etc...)

Definition in file logger.h.

Typedef Documentation

◆ file_logger

typedef struct file_logger file_logger

◆ log_fn

specifies log_levels typically used when determining function invocation by log_fn

Definition at line 48 of file logger.h.

◆ log_fnf

typedef void(* log_fnf) (struct thread_logger *thl, int file_descriptor, LOG_LEVELS level, char *message,...)

Definition at line 56 of file logger.h.

◆ mutex_fn

typedef int(* mutex_fn) (pthread_mutex_t *mx)

Definition at line 40 of file logger.h.

◆ thread_logger

signature of pthread_mutex_unlock and pthread_mutex_lock used by the thread_logger

Parameters

mx	pointer to a pthread_mutex_t type

Enumeration Type Documentation

◆ LOG_LEVELS

enum LOG_LEVELS

Enumerator
LOG_LEVELS_INFO	indicates the message we are logging is of type info (color green)
LOG_LEVELS_WARN	indicates the message we are logging is of type warn (color yellow)
LOG_LEVELS_ERROR	indicates the message we are logging is of type error (color red)
LOG_LEVELS_DEBUG	indicates the message we are logging is of type debug (color soft red)

Definition at line 26 of file logger.h.

Function Documentation

◆ clear_file_logger()

void clear_file_logger ( file_logger * fhl )

free resources for the file ogger

Parameters

fhl	the file_logger instance to free memory for. also frees memory for the embedded thread_logger and closes the open file

Definition at line 228 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear_thread_logger()

void clear_thread_logger ( thread_logger * thl )

free resources for the threaded logger

Parameters

thl	the thread_logger instance to free memory for

Definition at line 224 of file logger.c.

Here is the caller graph for this function:

◆ debug_log()

void debug_log	(	thread_logger *	thl,
		int	file_descriptor,
		char *	message
	)

logs a debug styled message - called by log_fn

Parameters

thl	pointer to an instance of thread_logger
file_descriptor	file descriptor to write log messages to in addition to stdout logging. if 0 only stdout is used
message	the actuall message to log

Definition at line 201 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ error_log()

void error_log	(	thread_logger *	thl,
		int	file_descriptor,
		char *	message
	)

logs an error styled message - called by log_fn

Parameters

thl	pointer to an instance of thread_logger
file_descriptor	file descriptor to write log messages to in addition to stdout logging. if 0 only stdout is used
message	the actuall message to log

Definition at line 183 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ info_log()

void info_log	(	thread_logger *	thl,
		int	file_descriptor,
		char *	message
	)

logs an info styled message - called by log_fn

Parameters

thl	pointer to an instance of thread_logger
file_descriptor	file descriptor to write log messages to in addition to stdout logging. if 0 only stdout is used
message	the actuall message to log

Definition at line 143 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ log_func()

void log_func	(	thread_logger *	thl,
		int	file_descriptor,
		char *	message,
		LOG_LEVELS	level
	)

main function you should call, which will delegate to the appopriate *_log function

Parameters

thl	pointer to an instance of thread_logger
file_descriptor	file descriptor to write log messages to, if 0 then only stdout is used
message	the actual message we want to log
level	the log level to use (effects color used)

Definition at line 112 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logf_func()

void logf_func	(	thread_logger *	thl,
		int	file_descriptor,
		LOG_LEVELS	level,
		char *	message,
			...
	)

like log_func but for formatted logs

Parameters

thl	pointer to an instance of thread_logger
file_descriptor	file descriptor to write log messages to, if 0 then only stdout is used
level	the log level to use (effects color used)
message	format string like `<percent-sign>sFOO<percent-sign>sBAR`
...	values to supply to message

Definition at line 95 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ new_file_logger()

file_logger* new_file_logger	(	char *	output_file,
		bool	with_debug
	)

returns a new file_logger Calls new_thread_logger internally

Parameters

output_file the file we will dump logs to. created if not exists and is appended to

Definition at line 43 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ new_thread_logger()

thread_logger* new_thread_logger ( bool with_debug )

returns a new thread safe logger if with_debug is false, then all debug_log calls will be ignored

Parameters

with_debug whether to enable debug logging, if false debug log calls will be ignored

Definition at line 28 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ warn_log()

void warn_log	(	thread_logger *	thl,
		int	file_descriptor,
		char *	message
	)

logs a warned styled message - called by log_fn

Parameters

thl	pointer to an instance of thread_logger
file_descriptor	file descriptor to write log messages to in addition to stdout logging. if 0 only stdout is used
message	the actuall message to log

Definition at line 161 of file logger.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write_file_log()

int write_file_log	(	int	file_descriptor,
		char *	message
	)

used to write a log message to file

Parameters

thl	pointer to an instance of thread_logger
file_descriptor	file descriptor to write log messages to in addition to stdout logging. if 0 only stdout is used
message	the actuall message to log

Definition at line 73 of file logger.c.

Here is the caller graph for this function:

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ file_logger

◆ log_fn

◆ log_fnf

◆ mutex_fn

◆ thread_logger

Enumeration Type Documentation

◆ LOG_LEVELS

Function Documentation

◆ clear_file_logger()

◆ clear_thread_logger()

◆ debug_log()

◆ error_log()

◆ info_log()

◆ log_func()

◆ logf_func()

◆ new_file_logger()

◆ new_thread_logger()

◆ warn_log()

◆ write_file_log()