Logging

Configurable, parallel logging. More...

Classes
struct	config
	Specification for Flog operation. More...
struct	guard
	Scope guard for categorizing output. More...
struct	message< Policy >
	The message type provides a basic log message type that is customized with a formatting policy. More...
class	state
	The state type provides access to logging parameters and configuration. More...
struct	tag
	A tag for labeling output to enable. More...
class	tee_buffer_t
	The tee_buffer_t type provides a stream buffer that allows output to multiple targets. More...
struct	tee_stream_t
	The tee_stream_t type provides a stream class that writes to multiple output buffers. More...

Macros
#define	fixme()
	Alias for severity level warn.
#define	flog(severity)
	This handles all of the different logging modes for the insertion style logging interface.
#define	flog_assert(test, message)
	Flog assertion interface.
#define	flog_error(stream)
	Method style interface for error level severity log entries.
#define	flog_fatal(message)
	Throw a runtime exception with the provided message.
#define	flog_info(stream)
	Method style interface for info level severity log entries.
#define	flog_trace(stream)
	Method style interface for trace level severity log entries.
#define	flog_warn(stream)
	Method style interface for warn level severity log entries.

Functions
void	add_output_stream (std::string const &label, std::ostream &stream, bool colorize=false)
	Add an output stream to FLOG.
void	flush ()
	Explicitly flush buffered flog output.
template<char C>
std::string	rstrip (const char *file)
	Strip path from string up to last character C.
auto	tags ()
	Get all defined tags.
std::string	timestamp (bool underscores=false)
	Create a timestamp.

Detailed Description

Configurable, parallel logging.

If disabled at configuration time, no output is produced.

Contents are in flecsi::flog unless otherwise specified. The name flecsi::log may also be used, but is deprecated.

#include "flecsi/flog.hh"

Macro Definition Documentation

flog

#define flog

(

severity

)

This handles all of the different logging modes for the insertion style logging interface.

Parameters

severity

The severity level of the log entry.

Usage

int value{20};
 
// Print the value at info severity level
flog(info) << "Value: " << value << std::endl;
 
// Print the value at warn severity level
flog(warn) << "Value: " << value << std::endl;

flog_trace

#define flog_trace

(

stream

)

Method style interface for trace level severity log entries.

Parameters

stream

The stream to be printed.

Usage

int value{20};
 
// Print the value at trace severity level
flog_trace("Value: " << value);

flog_info

#define flog_info

(

stream

)

Method style interface for info level severity log entries.

Parameters

stream

The stream to be printed.

Usage

int value{20};
 
// Print the value at info severity level
flog_info("Value: " << value);

flog_warn

#define flog_warn

(

stream

)

Method style interface for warn level severity log entries.

Parameters

stream

The stream to be printed.

Usage

int value{20};
 
// Print the value at warn severity level
flog_warn("Value: " << value);

flog_error

#define flog_error

(

stream

)

Method style interface for error level severity log entries.

Parameters

stream

The stream to be printed.

Usage

int value{20};
 
// Print the value at error severity level
flog_error("Value: " << value);

fixme

#define fixme

(

)

Alias for severity level warn.

flog_fatal

#define flog_fatal

(

message

)

Throw a runtime exception with the provided message.

If FLECSI_BACKTRACE is set in the environment and NDEBUG is not defined, produce a backtrace.

Parameters

message

The stream message to be printed.

Note

Fatal level severity log entires are not disabled by tags or by the ENABLE_FLOG or FLOG_STRIP_LEVEL build options, i.e., they are always active. Nor do they use Flog's output streams, because they cannot be aggregated across processes.

Usage

int value{20};
 
// Print the value and exit
flog_fatal("Value: " << value);

flog_assert

#define flog_assert	(		test,
			message )

Flog assertion interface.

Assertions allow the developer to catch invalid program state. This call will invoke flog_fatal if the test condition is false.

Parameters

test	The test condition.
message	The stream message to be printed.

Note

Failed assertions are not disabled by tags or by the ENABLE_FLOG or FLOG_STRIP_LEVEL build options, i.e., they are always active.

Usage

int value{20};
 
// Print the value and exit
flog_assert(value == 20, "invalid value");

Function Documentation

flush()

void flush

(

)

Explicitly flush buffered flog output.

#include "flecsi/execution.hh"

The inclusion of flecsi/runtime.hh by this header is deprecated.

tags()

auto tags

(

)

Get all defined tags.

Returns

a range of std::string objects

add_output_stream()

void add_output_stream	(	std::string const &	label,
		std::ostream &	stream,
		bool	colorize = false )

Add an output stream to FLOG.

Parameters

label	An identifier for the stream. This can be used to access or update an output stream after it has been added.
stream	The output stream to add.
colorize	Indicates whether the output to this stream should be colorized. It is useful to turn colorization off for non-interactive output (default).

timestamp()

std::string timestamp

(

bool

underscores = false

)

Create a timestamp.

rstrip()

template<char C>

std::string rstrip

(

const char *

file

)

Strip path from string up to last character C.

Template Parameters

C	The character to strip.