Muto::Instrumentor Class Reference

#include <Instrumentor.h>

Public Member Functions
void	BeginSession (const std::string &name, const std::string &filepath="results.json")
void	EndSession ()
	Instrumentor ()
void	InternalEndSession ()
void	WriteFooter ()
void	WriteHeader ()
void	WriteProfile (const ProfileResult &result)

Static Public Member Functions
static Instrumentor &	Get ()

Private Attributes
InstrumentationSession *	m_CurrentSession
std::mutex	m_Mutex
std::ofstream	m_OutputStream

Constructor & Destructor Documentation

Instrumentor()

Muto::Instrumentor::Instrumentor ( )

inline

            : m_CurrentSession(nullptr)
        {
        }

References m_CurrentSession.

Member Function Documentation

BeginSession()

void Muto::Instrumentor::BeginSession ( const std::string &  name, const std::string &  filepath = "results.json"  )

inline

        {
            std::lock_guard lock(m_Mutex);
            if (m_CurrentSession) {
                // If there is already a current session, end it and start new one
                if (Log::GetCoreLogger()) 
                {
                    MU_CORE_ERROR("Instrumentor::BeginSession('{0}') when session '{1}' already open.", name, m_CurrentSession->Name);
                }
                InternalEndSession();
            }
            m_OutputStream.open(filepath);
            if (m_OutputStream.is_open()) {
                m_CurrentSession = new InstrumentationSession{ name };
                WriteHeader();
            }
            else {
                if (Log::GetCoreLogger()) 
                {
                    MU_CORE_ERROR("Instrumentor could not open results file '{0}'.", filepath);
                }
            }
            WriteHeader();
            m_CurrentSession = new InstrumentationSession{ name };
        }

References InternalEndSession(), m_CurrentSession, Muto::InstrumentationSession::Name, and WriteHeader().

EndSession()

void Muto::Instrumentor::EndSession ( )

inline

        {
            std::lock_guard lock(m_Mutex);
            InternalEndSession();
        }

References InternalEndSession().

Get()

static Instrumentor & Muto::Instrumentor::Get ( )

inlinestatic

        {
            static Instrumentor instance;
            return instance;
        }

Referenced by Muto::InstrumentationTimer::Stop().

InternalEndSession()

void Muto::Instrumentor::InternalEndSession ( )

inline

        {
            if (m_CurrentSession)
            {
                WriteFooter();
                m_OutputStream.close();
                delete m_CurrentSession;
                m_CurrentSession = nullptr;
            }
        }

References m_CurrentSession, and WriteFooter().

Referenced by BeginSession(), and EndSession().

WriteFooter()

void Muto::Instrumentor::WriteFooter ( )

inline

        {
            m_OutputStream << "]}";
            m_OutputStream.flush();
        }

Referenced by InternalEndSession().

WriteHeader()

void Muto::Instrumentor::WriteHeader ( )

inline

        {
            m_OutputStream << "{\"otherData\": {},\"traceEvents\":[";
            m_OutputStream.flush();
        }

Referenced by BeginSession().

WriteProfile()

void Muto::Instrumentor::WriteProfile ( const ProfileResult &  result )

inline

        {
            m_OutputStream << ",";
 
            std::string name = result.Name;
            std::replace(name.begin(), name.end(), '"', '\'');
 
            m_OutputStream << "{";
            m_OutputStream << "\"cat\":\"function\",";
            m_OutputStream << "\"dur\":" << (result.End - result.Start) << ',';
            m_OutputStream << "\"name\":\"" << name << "\",";
            m_OutputStream << "\"ph\":\"X\",";
            m_OutputStream << "\"pid\":0,";
            m_OutputStream << "\"tid\":" << result.ThreadID << ",";
            m_OutputStream << "\"ts\":" << result.Start;
            m_OutputStream << "}";
 
            std::lock_guard lock(m_Mutex);
            if (m_CurrentSession)
            {
                //m_OutputStream << json.str();
                m_OutputStream.flush();
            }
        }

References m_CurrentSession, and Muto::ProfileResult::Name.

Referenced by Muto::InstrumentationTimer::Stop().

Member Data Documentation

m_CurrentSession

InstrumentationSession* Muto::Instrumentor::m_CurrentSession

private

Referenced by BeginSession(), Instrumentor(), InternalEndSession(), and WriteProfile().

m_Mutex

std::mutex Muto::Instrumentor::m_Mutex

private

m_OutputStream

std::ofstream Muto::Instrumentor::m_OutputStream

private

---

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

• Muto/src/Debug/Instrumentor.h