StructuredMessage Class Reference

#include <ored/utilities/log.hpp>

Inheritance diagram for StructuredMessage:

Collaboration diagram for StructuredMessage:

Public Types
enum class	Category { Error , Warning , Unknown }
enum class	Group {   Analytics , Configuration , Model , Curve ,   Trade , Fixing , Logging , ReferenceData ,   Unknown }

Public Member Functions
	StructuredMessage (const Category &category, const Group &group, const std::string &message, const std::map< std::string, std::string > &subFields=std::map< std::string, std::string >())
	StructuredMessage (const Category &category, const Group &group, const std::string &message, const std::pair< std::string, std::string > &subField=std::pair< std::string, std::string >())
virtual	~StructuredMessage ()
std::string	msg () const
	return a std::string for the log file More...
void	emitLog () const
	generate Boost log record to pass to corresponding sinks More...
Public Member Functions inherited from JSONMessage
virtual	~JSONMessage ()
virtual std::string	msg () const =0
	return a std::string for the log file More...
void	log () const
	generate Boost log record to pass to corresponding sinks More...
const std::string	json () const
	create JSON-like output from the data More...
void	set (const std::string &key, const boost::any &value)

Static Public Attributes
static constexpr const char *	name = "StructuredMessage"

Protected Member Functions
void	addSubFields (const std::map< std::string, std::string > &)
virtual void	emitLog () const =0
	generate Boost log record - this method is called by log() More...

Additional Inherited Members
Static Protected Member Functions inherited from JSONMessage
static std::string	jsonify (const boost::any &)
Protected Attributes inherited from JSONMessage
std::map< std::string, boost::any >	data_

Detailed Description

Definition at line 677 of file log.hpp.

Member Enumeration Documentation

Category

enum class Category

strong

Enumerator
Error
Warning
Unknown

Definition at line 679 of file log.hpp.

{ Error, Warning, Unknown };

Group

enum class Group

strong

Enumerator
Analytics
Configuration
Model
Curve
Trade
Fixing
Logging
ReferenceData
Unknown

Definition at line 681 of file log.hpp.

{ Analytics, Configuration, Model, Curve, Trade, Fixing, Logging, ReferenceData, Unknown };

Constructor & Destructor Documentation

StructuredMessage() [1/2]

StructuredMessage	(	const Category &	category,
		const Group &	group,
		const std::string &	message,
		const std::map< std::string, std::string > &	subFields = std::map<std::string, std::string>()
	)

Definition at line 555 of file log.cpp.

                                                                           {
    data_["category"] = to_string(category);
    data_["group"] = to_string(group);
    data_["message"] = message;
 
    if (!subFields.empty()) {
        vector<boost::any> subFieldsVector;
        bool addedSubField = false;
        for (const auto& sf : subFields) {
            if (!sf.second.empty()) {
                map<string, boost::any> subField({{"name", sf.first}, {"value", sf.second}});
                subFieldsVector.push_back(subField);
                addedSubField = true;
            }
        }
        if (addedSubField)
            data_["sub_fields"] = subFieldsVector;
    }
}

Here is the call graph for this function:

StructuredMessage() [2/2]

StructuredMessage	(	const Category &	category,
		const Group &	group,
		const std::string &	message,
		const std::pair< std::string, std::string > &	subField = std::pair<std::string, std::string>()
	)

Definition at line 686 of file log.hpp.

        : StructuredMessage(category, group, message, std::map<std::string, std::string>({subField})) {}

~StructuredMessage()

virtual ~StructuredMessage ( )

virtual

Definition at line 690 of file log.hpp.

{}

Member Function Documentation

msg()

std::string msg ( ) const

virtual

return a std::string for the log file

Implements JSONMessage.

Definition at line 695 of file log.hpp.

{ return std::string(name) + std::string(" ") + json(); }

Here is the call graph for this function:

emitLog()

void emitLog ( ) const

virtual

generate Boost log record to pass to corresponding sinks

Implements JSONMessage.

Definition at line 576 of file log.cpp.

                                      {
    lsrc::severity_logger_mt<oreSeverity> lg;
    lg.add_attribute(messageType.get_name(), lattr::constant<string>(name));
    
    auto it = data_.find("category");
    QL_REQUIRE(it != data_.end(), "StructuredMessage must have a 'category' key specified.");
    QL_REQUIRE(it->second.type() == typeid(string), "StructuredMessage category must be a string.");
 
    string category = boost::any_cast<string>(it->second);
    if (category == to_string(StructuredMessage::Category::Unknown) || category == to_string(StructuredMessage::Category::Warning)) {
        BOOST_LOG_SEV(lg, oreSeverity::warning) << json();
    } else if (category == to_string(StructuredMessage::Category::Error)) {
        BOOST_LOG_SEV(lg, oreSeverity::alert) << json();
    } else {
        QL_FAIL("StructuredMessage::log() invalid category '" << category << "'");
    }
}

Here is the call graph for this function:

addSubFields()

void addSubFields ( const std::map< std::string, std::string > &  subFields )

protected

Definition at line 594 of file log.cpp.

                                                                         {
    if (!subFields.empty()) {
 
        // First check that there is at least one non-empty subfield
        bool hasNonEmptySubField = false;
        for (const auto& sf : subFields) {
            if (!sf.second.empty()) {
                hasNonEmptySubField = true;
                break;
            }
        }
        if (!hasNonEmptySubField)
            return;
 
        if (data_.find("sub_fields") == data_.end()) {
            data_["sub_fields"] = vector<boost::any>();
        }
 
        for (const auto& sf : subFields) {
            if (!sf.second.empty()) {
                map<string, boost::any> subField({{"name", sf.first}, {"value", sf.second}});
                boost::any_cast<vector<boost::any>&>(data_.at("sub_fields")).push_back(subField);
            }
        }
 
    }
}

Member Data Documentation

name

constexpr const char* name = "StructuredMessage"

staticconstexpr

Definition at line 692 of file log.hpp.