lsst::ctrl::events::EventAppender Class Reference

log4cxx appender class which sends logging messages out on the event stream More...

#include <EventAppender.h>

Inheritance diagram for lsst::ctrl::events::EventAppender:

Public Member Functions
	EventAppender ()
	~EventAppender ()
	destructor More...
virtual void	setOption (const LogString &option, const LogString &value)
	log4cxx methods for setting options; for this class options are BROKER - host name of event broker (required) PORT - port number on which the event broker is listening (optional) TOPIC - topic name on which to send logging messages (optional) More...
virtual void	activateOptions (log4cxx::helpers::Pool &p)
	prepares EventAppender for use More...
void	append (const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)
	handles a log event. For this appender, this means sending an event to the logging topic. More...
void	close ()
	shuts down the appender More...
bool	requiresLayout () const
	this appender does not require a layout to format the text More...

Protected Member Functions
lsst::ctrl::events::EventTransmitter *	getTransmitter ()

Protected Attributes
lsst::ctrl::events::EventTransmitter *	_transmitter
LogString	_broker
LogString	_topic
int	_port
LogString	_runid

Detailed Description

log4cxx appender class which sends logging messages out on the event stream

Definition at line 75 of file EventAppender.h.

Constructor & Destructor Documentation

lsst::ctrl::events::EventAppender::EventAppender

(

)

Definition at line 62 of file EventAppender.cc.

                             {
    _transmitter = NULL;
    _port = ctrlEvents::EventBroker::DEFAULTHOSTPORT;
    _topic = ctrlEvents::LogEvent::LOGGING_TOPIC;
}

lsst::ctrl::events::EventAppender::~EventAppender

(

)

destructor

Definition at line 70 of file EventAppender.cc.

                              {
    if (_transmitter != NULL)
        delete _transmitter;
    _transmitter = NULL;
}

Member Function Documentation

void lsst::ctrl::events::EventAppender::activateOptions ( log4cxx::helpers::Pool &  p )

virtual

prepares EventAppender for use

Definition at line 90 of file EventAppender.cc.

{
    if (_broker.empty()) {
        LogLog::error((LogString) LOG4CXX_STR("Appender requires broker option to be specified"));
        return;
    }
    try {
        _transmitter = new EventTransmitter(_broker, _topic, _port);
    } catch (pexExceptions::RuntimeError& rte) {
        std::ostringstream msg;
        msg << "Couldn't reach broker " << _broker << " at port " << _port;
        LogLog::error((LogString) LOG4CXX_STR(msg.str()));
        _transmitter = NULL;
    }
}

void lsst::ctrl::events::EventAppender::append	(	const spi::LoggingEventPtr &	event,
		log4cxx::helpers::Pool &	p
	)

handles a log event. For this appender, this means sending an event to the logging topic.

Definition at line 118 of file EventAppender.cc.

                                                                          {
    PropertySet::Ptr psp(new PropertySet);

    psp->set("logger", event->getLoggerName());
    psp->set("message", event->getMessage());
    psp->set("timestamp", event->getTimeStamp());
    psp->set("threadname", event->getThreadName());
    psp->set("level", event->getLevel()->toInt());

    spi::LocationInfo location = event->getLocationInformation();

    PropertySet::Ptr loc(new PropertySet);
    loc->set("filename", location.getFileName());
    loc->set("classname", location.getClassName());
    loc->set("methodname", location.getMethodName());
    loc->set("linenumber", location.getLineNumber());

    psp->set("location", loc);

    ctrlEvents::Event e;
    if (_runid.empty()) {
        e = ctrlEvents::Event(*psp);
    } else {
        e = ctrlEvents::Event(_runid, *psp);
    }

    EventTransmitter *transmitter = getTransmitter();

    if (_transmitter == NULL)
        return;

    try {
        transmitter->publishEvent(e);
    } catch (Exception& e) {
        LogLog::error((LogString) LOG4CXX_STR("event transmitter failed"));
        delete _transmitter;
        _transmitter = NULL;
    }
}

void lsst::ctrl::events::EventAppender::close

(

)

shuts down the appender

Definition at line 158 of file EventAppender.cc.

                          {
    if (this->closed)
        return;
    this->closed = true;
}

EventTransmitter * lsst::ctrl::events::EventAppender::getTransmitter ( )

protected

Definition at line 107 of file EventAppender.cc.

                                                {
    if (_transmitter == NULL) {
        try {
            _transmitter = new EventTransmitter(_broker, _topic, _port);
        } catch (Exception& e) {
        }
    }
    return _transmitter;
}

bool lsst::ctrl::events::EventAppender::requiresLayout ( ) const

inline

this appender does not require a layout to format the text

Returns

always returns false

Definition at line 119 of file EventAppender.h.

{ return false; }

void lsst::ctrl::events::EventAppender::setOption ( const LogString &  option, const LogString &  value  )

virtual

log4cxx methods for setting options; for this class options are BROKER - host name of event broker (required) PORT - port number on which the event broker is listening (optional) TOPIC - topic name on which to send logging messages (optional)

Parameters

option	option name
value	option value

Definition at line 76 of file EventAppender.cc.

                                                                             {
    if (StringHelper::equalsIgnoreCase(option, LOG4CXX_STR("BROKER"), LOG4CXX_STR("broker"))) {
        _broker = value;
    } else if (StringHelper::equalsIgnoreCase(option, LOG4CXX_STR("PORT"), LOG4CXX_STR("port"))) {
        _port = atoi(value.c_str());
    } else if (StringHelper::equalsIgnoreCase(option, LOG4CXX_STR("TOPIC"), LOG4CXX_STR("topic"))) {
        _topic = value;
    } else if (StringHelper::equalsIgnoreCase(option, LOG4CXX_STR("RUNID"), LOG4CXX_STR("runid"))) {
        _runid = value;
    } else {
        AppenderSkeleton::setOption(option, value);
    }
}

Member Data Documentation

LogString lsst::ctrl::events::EventAppender::_broker

protected

Definition at line 125 of file EventAppender.h.

int lsst::ctrl::events::EventAppender::_port

protected

Definition at line 127 of file EventAppender.h.

LogString lsst::ctrl::events::EventAppender::_runid

protected

Definition at line 128 of file EventAppender.h.

LogString lsst::ctrl::events::EventAppender::_topic

protected

Definition at line 126 of file EventAppender.h.

lsst::ctrl::events::EventTransmitter* lsst::ctrl::events::EventAppender::_transmitter

protected

Definition at line 123 of file EventAppender.h.

---

The documentation for this class was generated from the following files:

• /home/lsstsw/stack/Linux64/ctrl_events/11.0-2-g68503cd/include/lsst/ctrl/events/EventAppender.h
• /home/lsstsw/stack/Linux64/ctrl_events/11.0-2-g68503cd/src/EventAppender.cc