Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzToolsFramework::TraceLogger Class Reference

Connects and disconnects TraceMessageBus and allows for logging for O3DE Tools Applications. More...

#include <TraceLogger.h>

Inherits AZ::Debug::TraceMessageBus::Handler.

Classes

struct  LogMessage
 

Public Member Functions

void OpenLogFile (const AZStd::string &logFileName, bool clearLogFile)
 Open log file and dump log sink into it.
 
void AddWindowFilter (const AZStd::string &filter)
 Add filter to ignore messages for windows with matching names.
 
void RemoveWindowFilter (const AZStd::string &filter)
 Remove window filter.
 
void ClearWindowFilter ()
 Clear window filters.
 
void AddMessageFilter (const AZStd::string &filter)
 Add filter to ignore messages with matching names.
 
void RemoveMessageFilter (const AZStd::string &filter)
 Remove message filter.
 
void ClearMessageFilter ()
 Clear message filters.
 

Protected Member Functions

bool OnOutput (const char *window, const char *message) override
 

Protected Attributes

AZStd::list< LogMessagem_startupLogSink
 
AZStd::unordered_set< AZStd::string > m_windowFilters
 
AZStd::unordered_set< AZStd::string > m_messageFilters
 
AZStd::unique_ptr< AzFramework::LogFile > m_logFile
 

Detailed Description

Connects and disconnects TraceMessageBus and allows for logging for O3DE Tools Applications.


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