TracingLog.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#ifndef LSST_PEX_HARNESS_TRACINGLOG_H
#define LSST_PEX_HARNESS_TRACINGLOG_H

#include "lsst/pex/logging/LogRecord.h"
#include "lsst/pex/logging/Log.h"

namespace lsst {
namespace pex {
namespace harness {

namespace logging = lsst::pex::logging;

class TracingLog : public logging::Log {
public:

    static const int TRACE;  // = logging::Log::INFO - 1

    static const std::string STATUS;

    static const std::string START;

    static const std::string END;

    TracingLog(const logging::Log& parent, const std::string& name, 
               int tracelev=TracingLog::TRACE, const std::string& funcName="");

    TracingLog(const TracingLog& that) 
        : Log(*this), _tracelev(that._tracelev), _funcName(that._funcName)
    { }

    TracingLog& operator=(const TracingLog& that) {
        Log::operator=(that);
        _tracelev = that._tracelev;
        _funcName = that._funcName;
        return *this;
    }

    TracingLog *createForTraceBlock(const std::string& name, 
                                 int tracelev=logging::Log::INHERIT_THRESHOLD,
                                    const std::string& funcName="") 
    {
        TracingLog *out = new TracingLog(*this, name, tracelev, funcName);
        // out->setShowAll(true);
        out->start();
        return out;
    }

    TracingLog *traceBlock(const std::string& name, 
                           int tracelev=logging::Log::INHERIT_THRESHOLD,
                           const std::string& funcName="") 
    {
        return createForTraceBlock(name, tracelev, funcName);
    }

    virtual ~TracingLog();

    void start() {
        if (sends(_tracelev)) {
            std::string msg("Starting ");
            msg += _funcName;
            log(_tracelev, msg, STATUS, START);
        }
    }

    void start(const std::string& funcName) {
        if (funcName.length() > 0) _funcName = funcName;
        start();
    }

    void done() {
        if (sends(_tracelev)) {
            std::string msg("Ending ");
            msg += _funcName;
            log(_tracelev, msg, STATUS, END);
        }
    }

    int getTraceLevel() const { return _tracelev; }

    const std::string& getFunctionName() const { return _funcName; }

private:
    int _tracelev;
    std::string _funcName;
};

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");

}}}     // end lsst::pex::harness

#endif  // end LSST_PEX_LOG_H