lsst::pex::harness Namespace Reference

Namespaces
	Clipboard
	dataset
	Directories
	EventStage
	IOStage
	Pipeline
	Queue
	run
	ShutdownThread
	simpleStageTester
	Slice
	SliceThread
	stage
	startPipeline
	SymLinkStage
	Utils
	version

Classes
class	LogUtils
	Pipeline class manages the operation of a multi-stage parallel pipeline. More...
class	TracingLog

Functions
BlockTimingLog *	setupHarnessLogging (const std::string &runId, int sliceId, const std::string &eventBrokerHost="", const std::string &pipename="unnamed", const std::string &workerid="-1", std::ostream *messageStrm=0, const std::string &logname="harness", int resourceUsageFlags=0)
	create and configure logging for a harness application More...
TracingLog *	setupHarnessLogging (const std::string &runId, int sliceId, const std::string &eventBrokerHost="", const std::string &pipename="unnamed", const std::string &workerid="-1", std::ostream *messageStrm=0, const std::string &logname="harness")
	create and configure logging for a harness application More...

Function Documentation

TracingLog * lsst::pex::harness::setupHarnessLogging	(	const std::string &	runId,
		int	sliceId,
		const std::string &	eventBrokerHost = "",
		const std::string &	pipename = "unnamed",
		const std::string &	workerid = "-1",
		std::ostream *	messageStrm = 0,
		const std::string &	logname = "harness"
	)

create and configure logging for a harness application

This will create and configure a default log needed to send all log messages through the event system. It then creates a child log to be used by a harness class instance (i.e. Pipeline or Slice).

Parameters

runId	the production run identifier that harness is running under
sliceId	the slice identifier (-1 for the master process)
eventBrokerHost	the hostname where the desired event broker is running
pipename	the name used to identify the pipeline
messageStrm	if non-null, a (file) stream to replicate the messages in.
logname	the name to give to the harness logger (default: "harness")

Definition at line 71 of file TracingLog.cc.

{
    if (eventBrokerHost.length() > 0) {
        /*  Move this to LogUtils.cc and only call for the Pipeline 
            Re-examine this for MPI Slices 
        EventSystem& eventSystem = EventSystem::getDefaultEventSystem();
        eventSystem.createTransmitter(eventBrokerHost, "LSSTLogging");
        */ 
        EventLog::createDefaultLog(runId, sliceId);
    }
    Log& root = Log::getDefaultLog();
    root.addPreambleProperty("PIPELINE", pipename);
    root.addPreambleProperty("workerid", workerid);

    if (messageStrm != 0) {
        boost::shared_ptr<LogFormatter> frmtr(new IndentedFormatter(true));
        boost::shared_ptr<LogDestination> 
            dest(new LogDestination(messageStrm, frmtr, Log::DEBUG));
        root.addDestination(dest);
    }

    TracingLog *out = 0;
    try {
        out = new TracingLog(root, logname);
        out->format(Log::INFO, 
                    "Harness Logger initialized with message threshold = %i", 
                    out->getThreshold());
        return out;
    }
    catch (...) {
        delete out;
        throw;
    }
}

lsst::pex::logging::BlockTimingLog * lsst::pex::harness::setupHarnessLogging	(	const std::string &	runId,
		int	sliceId,
		const std::string &	eventBrokerHost = "",
		const std::string &	pipename = "unnamed",
		const std::string &	workerid = "-1",
		std::ostream *	messageStrm = 0,
		const std::string &	logname = "harness",
		int	resourceUsageFlags = 0
	)

create and configure logging for a harness application

This will create and configure a default log needed to send all log messages through the event system. It then creates a child log to be used by a harness class instance (i.e. Pipeline or Slice).

Parameters

runId	the production run identifier that harness is running under
sliceId	the slice identifier (-1 for the master process)
eventBrokerHost	the hostname where the desired event broker is running
pipename	the name used to identify the pipeline
messageStrm	if non-null, a (file) stream to replicate the messages in.
logname	the name to give to the harness logger (default: "harness")
resourceUsageFlags	the OR-ed flags that control the resource usage data to collect; see BlockTimingLog. (default: NOUDATA, no resource usage data.)

Definition at line 168 of file LogUtils.cc.

{
    if (eventBrokerHost.length() > 0) {
        /*  Move this to LogUtils.cc and only call for the Pipeline 
            Re-examine this for MPI Slices 
        EventSystem& eventSystem = EventSystem::getDefaultEventSystem();
        eventSystem.createTransmitter(eventBrokerHost, "LSSTLogging");
        */ 
        EventLog::createDefaultLog(runId, sliceId);
    }
    Log& root = Log::getDefaultLog();
    root.addPreambleProperty("PIPELINE", pipename);
    root.addPreambleProperty("workerid", workerid);

    if (messageStrm != 0) {
        boost::shared_ptr<LogFormatter> frmtr(new IndentedFormatter(true));
        boost::shared_ptr<LogDestination> 
            dest(new LogDestination(messageStrm, frmtr, Log::DEBUG));
        root.addDestination(dest);
    }

    BlockTimingLog *out = 0;
    try {
        out = new BlockTimingLog(root, logname);
        out->setUsageFlags(resourceUsageFlags);
        out->format(Log::INFO, 
                    "Harness Logger initialized with message threshold = %i", 
                    out->getThreshold());
        return out;
    }
    catch (...) {
        delete out;
        throw;
    }
}