StructuredLogger Class Reference

#include <ored/utilities/log.hpp>

Inheritance diagram for StructuredLogger:

Collaboration diagram for StructuredLogger:

Public Member Functions
	StructuredLogger ()
	Constructors. More...
const QuantLib::ext::shared_ptr< file_sink > &	fileSink ()
const QuantLib::ext::shared_ptr< text_sink > &	cacheSink ()
virtual void	removeSinks () override
	Destructor. More...
void	setFileLog (const std::string &filepath, const boost::filesystem::path &dir, QuantLib::Size rotationSize=0)
Public Member Functions inherited from IndependentLogger
virtual	~IndependentLogger ()
	Destructor. More...
virtual void	removeSinks ()=0
std::vector< std::string > &	messages ()
void	clear ()
const std::string &	name () const
	Returns the Logger name. More...

Static Public Attributes
static const std::string	name = "StructuredLogger"
	the name "StructuredLogger" More...

Private Attributes
QuantLib::ext::shared_ptr< file_sink >	fileSink_
QuantLib::ext::shared_ptr< text_sink >	cacheSink_

Additional Inherited Members
Protected Member Functions inherited from IndependentLogger
	IndependentLogger (const std::string &name)
	Constructor. More...
Protected Attributes inherited from IndependentLogger
std::vector< std::string >	messages_

Detailed Description

StructuredLogger //! This logger stores each structured error/warning message in a separate location

Definition at line 314 of file log.hpp.

Constructor & Destructor Documentation

StructuredLogger()

StructuredLogger

(

)

Constructors.

Definition at line 185 of file log.cpp.

                                   : IndependentLogger(name) {
    // Create backend and initialize it with a stream
    QuantLib::ext::shared_ptr<lsinks::text_ostream_backend> backend = QuantLib::ext::make_shared<lsinks::text_ostream_backend>();
 
    // Wrap it into the frontend and register in the core
    QuantLib::ext::shared_ptr<text_sink> sink(new text_sink(backend));
    sink->set_filter(messageType == StructuredMessage::name);
 
    // Use formatter to intercept and store the message.
    auto formatter = [this](const logging::record_view& rec, logging::formatting_ostream& strm) {
        const string& msg = rec[lexpr::smessage]->c_str();
 
        // Emit log record if it has not been logged before
        if (this->messages().empty() ||
            std::find(this->messages().begin(), this->messages().end(), msg) == this->messages().end()) {
            // Store the message
            this->messages().push_back(msg);
            
            oreSeverity logSeverity = boost::log::extract<oreSeverity>(severity.get_name(), rec).get();
            // If a file sink has been defined, then send the log record to it.
            if (this->fileSink()) {
                // Send to structured log file
                lsrc::severity_logger_mt<oreSeverity> lg;
                lg.add_attribute(messageType.get_name(), lattr::constant<string>(name));
                BOOST_LOG_SEV(lg, logSeverity) << rec[lexpr::smessage];
            }
 
            // Also send to full log file
            MLOG(logSeverity, StructuredMessage::name << " " << rec[lexpr::smessage]);
        }
    };
    sink->set_formatter(formatter);
    logging::core::get()->add_sink(sink);
    cacheSink_ = sink;
}

Here is the call graph for this function:

Member Function Documentation

fileSink()

const QuantLib::ext::shared_ptr< file_sink > & fileSink

(

)

Definition at line 321 of file log.hpp.

{ return fileSink_; }

Here is the caller graph for this function:

cacheSink()

const QuantLib::ext::shared_ptr< text_sink > & cacheSink

(

)

Definition at line 322 of file log.hpp.

{ return cacheSink_; }

removeSinks()

void removeSinks ( )

overridevirtual

Destructor.

Implements IndependentLogger.

Definition at line 221 of file log.cpp.

                                   {
    if (fileSink_) {
        logging::core::get()->remove_sink(fileSink_);
        fileSink_ = nullptr;
    }
}

setFileLog()

void setFileLog	(	const std::string &	filepath,
		const boost::filesystem::path &	dir,
		QuantLib::Size	rotationSize = 0
	)

Definition at line 228 of file log.cpp.

                                                                                            {
    if (rotationSize == 0) {
        fileSink_ = logging::add_file_log(
            lkeywords::target = dir,
            lkeywords::file_name = filepath,
            lkeywords::filter = messageType == StructuredLogger::name,
            lkeywords::auto_flush = true
        );
    } else {
        fileSink_ = logging::add_file_log(
            lkeywords::target = dir,
            lkeywords::file_name = filepath,
            lkeywords::filter = messageType == StructuredLogger::name,
            lkeywords::scan_method = lsinks::file::scan_matching,
            lkeywords::rotation_size = rotationSize,
            lkeywords::auto_flush = true
        );
    }
}

Member Data Documentation

name

const string name = "StructuredLogger"

static

the name "StructuredLogger"

Definition at line 318 of file log.hpp.

fileSink_

QuantLib::ext::shared_ptr<file_sink> fileSink_

private

Definition at line 328 of file log.hpp.

cacheSink_

QuantLib::ext::shared_ptr<text_sink> cacheSink_

private

Definition at line 329 of file log.hpp.