ProgressLogger Class Reference

#include <ored/utilities/log.hpp>

Inheritance diagram for ProgressLogger:

Collaboration diagram for ProgressLogger:

Public Member Functions
	ProgressLogger ()
	Constructors. More...
	ProgressLogger (const bool coutLog)
const QuantLib::ext::shared_ptr< file_sink > &	fileSink ()
const QuantLib::ext::shared_ptr< text_sink > &	coutSink ()
const QuantLib::ext::shared_ptr< text_sink > &	cacheSink ()
virtual void	removeSinks () override
	Destructor. More...
void	setCoutLog (bool flag)
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 = "ProgressLogger"
	the name "ProgressLogger" More...

Private Attributes
QuantLib::ext::shared_ptr< file_sink >	fileSink_
QuantLib::ext::shared_ptr< text_sink >	coutSink_
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

ProgressLogger //! This logger stores each log message in a separate location indicating progress of analytic runs.

Definition at line 290 of file log.hpp.

Constructor & Destructor Documentation

ProgressLogger() [1/2]

ProgressLogger

(

)

Constructors.

Definition at line 103 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));
 
    // This logger should only receive/process logs that were emitted by a ProgressMessage
    sink->set_filter(messageType == ProgressMessage::name);
 
    // Use formatter to intercept and store the message.
    auto formatter = [this](const logging::record_view& rec, logging::formatting_ostream& strm) {
        this->messages().push_back(rec[lexpr::smessage]->c_str());
 
        // If a file sink exists, then send the log record to it.
        if (this->fileSink()) {
            // Send to progress log file
            lsrc::severity_logger_mt<oreSeverity> lg;
            lg.add_attribute(messageType.get_name(), lattr::constant<string>(name));
            BOOST_LOG_SEV(lg, oreSeverity::notice) << rec[lexpr::smessage];
        }
 
        // Also send to full log file
        LOG(ProgressMessage::name << " " << rec[lexpr::smessage]);
    };
    sink->set_formatter(formatter);
    logging::core::get()->add_sink(sink);
    cacheSink_ = sink;
}

Here is the call graph for this function:

ProgressLogger() [2/2]

ProgressLogger

(

const bool

coutLog

)

Definition at line 297 of file log.hpp.

: ProgressLogger() { setCoutLog(coutLog); }

Here is the call graph for this function:

Member Function Documentation

fileSink()

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

(

)

Definition at line 298 of file log.hpp.

{ return fileSink_; }

Here is the caller graph for this function:

coutSink()

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

(

)

Definition at line 299 of file log.hpp.

{ return coutSink_; }

cacheSink()

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

(

)

Definition at line 300 of file log.hpp.

{ return cacheSink_; }

removeSinks()

void removeSinks ( )

overridevirtual

Destructor.

Implements IndependentLogger.

Definition at line 133 of file log.cpp.

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

setCoutLog()

void setCoutLog

(

bool

flag

)

Definition at line 164 of file log.cpp.

                                               {
    if (flag) {
        if (!coutSink_) {
            // 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>();
            backend->add_stream(QuantLib::ext::shared_ptr<std::ostream>(&std::clog, boost::null_deleter()));
 
            // 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 == ProgressMessage::name);
            logging::core::get()->add_sink(sink);
 
            // Store the sink for removal/retrieval later
            coutSink_ = sink;
        }
    } else if (coutSink_) {
        logging::core::get()->remove_sink(coutSink_);
        coutSink_ = nullptr;
    }
}

Here is the caller graph for this function:

setFileLog()

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

Definition at line 144 of file log.cpp.

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

Member Data Documentation

name

const string name = "ProgressLogger"

static

the name "ProgressLogger"

Definition at line 294 of file log.hpp.

fileSink_

QuantLib::ext::shared_ptr<file_sink> fileSink_

private

Definition at line 307 of file log.hpp.

coutSink_

QuantLib::ext::shared_ptr<text_sink> coutSink_

private

Definition at line 308 of file log.hpp.

cacheSink_

QuantLib::ext::shared_ptr<text_sink> cacheSink_

private

Definition at line 309 of file log.hpp.