Logger.h File Reference

Helpers and Classes related to Logging. More...

#include <string>
#include <atscppapi/noncopyable.h>

Go to the source code of this file.

Classes
class	atscppapi::Logger
	Create log files that are automatically rolled and cleaned up as space is required. More...

Macros
#define	ATSCPPAPI_LOGGER_H_
#define	ATSCPPAPI_PRINTFLIKE(fmt, arg)
#define	LOG_DEBUG(log, fmt,...)
#define	LOG_INFO(log, fmt,...)
#define	LOG_ERROR(log, fmt,...)
#define	STRINGIFY0(x)   #x
#define	STRINGIFY(x)   STRINGIFY0(x)
#define	LINE_NO   STRINGIFY(__LINE__)
#define	TS_DEBUG(tag, fmt,...)
#define	TS_ERROR(tag, fmt,...)

Detailed Description

Helpers and Classes related to Logging.

Author

Brian Geffon

Manjesh Nilange

Warning

Log rolling doesn't work correctly in 3.2.x see: https://issues.apache.org/jira/browse/TS-1813 Apply the patch in TS-1813 to correct log rolling in 3.2.x

Macro Definition Documentation

#define LOG_DEBUG	(		log,
			fmt,
			...
	)

Value:

do { \
    (log).logDebug("[%s:%d, %s()] " fmt, __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__); \
  } while (false)

A helper macro for Logger objects that allows you to easily add a debug level message which will include file, line, and function name with the message. It's very easy to use:

// Suppose you have already created a Logger named logger:
LOG_DEBUG(logger, "This is a test DEBUG message: %s", "hello");
// Outputs [file.cc:125, function()] [DEBUG] This is a test DEBUG message: hello.

#define LOG_ERROR	(		log,
			fmt,
			...
	)

Value:

do { \
    (log).logError("[%s:%d, %s()] " fmt, __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__); \
  } while (false)

A helper macro for Logger objects that allows you to easily add a error level message which will include file, line, and function name with the message. See example in LOG_DEBUG

#define LOG_INFO	(		log,
			fmt,
			...
	)

Value:

do { \
    (log).logInfo("[%s:%d, %s()] " fmt, __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__); \
  } while (false)

A helper macro for Logger objects that allows you to easily add a info level message which will include file, line, and function name with the message. See example in LOG_DEBUG

#define TS_DEBUG	(		tag,
			fmt,
			...
	)

Value:

do { \
    TSDebug(tag "." __FILE__ ":" LINE_NO , "[%s()] " fmt, __FUNCTION__, ## __VA_ARGS__); \
  } while (false)

A helper macro to get access to the Diag messages available in traffic server. These can be enabled via traffic_server -T "tag.*" or since this macro includes the file can you further refine to an individual file or even a particular line! This can also be enabled via records.config.

#define TS_ERROR	(		tag,
			fmt,
			...
	)

Value:

do { \
    TS_DEBUG(tag, "[ERROR] " fmt, ## __VA_ARGS__); \
    TSError("[%s] [%s:%d, %s()] " fmt, tag, __FILE__, __LINE__, __FUNCTION__, ## __VA_ARGS__); \
  } while (false)

A helper macro to get access to the error.log messages available in traffic server. This will also output a DEBUG message visible via traffic_server -T "tag.*", or by enabling the tag in records.config.