version 1.31, 2007/10/17 20:37:27
|
version 1.37, 2008/09/19 13:48:35
|
|
|
#include <Pegasus/Common/System.h> | #include <Pegasus/Common/System.h> |
#include <Pegasus/Common/MessageLoader.h> | #include <Pegasus/Common/MessageLoader.h> |
| |
// The Logger::trace optimization introduces the PEG_LOGGER_TRACE macro which |
|
// propagates branch conditions wherever it is used. The optimization is |
|
// disabled for C-Cover builds so the coverage of these branches is not |
|
// measured. |
|
#ifdef PEGASUS_CCOVER |
|
# define PEG_LOGGER_TRACE(ARGS_LIST) \ |
|
Logger::trace ARGS_LIST |
|
#else |
|
# define PEG_LOGGER_TRACE(ARGS_LIST) \ |
|
do \ |
|
{ \ |
|
if (Logger::wouldLog(Logger::TRACE)) \ |
|
{ \ |
|
Logger::trace ARGS_LIST ; \ |
|
} \ |
|
} \ |
|
while (0) |
|
#endif |
|
|
|
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class LoggerRep; | class LoggerRep; |
|
|
TRACE_LOG, | TRACE_LOG, |
STANDARD_LOG, | STANDARD_LOG, |
AUDIT_LOG, // Use only if PEGASUS_ENABLE_AUDIT_LOGGER is defined | AUDIT_LOG, // Use only if PEGASUS_ENABLE_AUDIT_LOGGER is defined |
ERROR_LOG, |
ERROR_LOG |
DEBUG_LOG |
|
}; | }; |
| |
enum { NUM_LOGS = 5 }; |
enum { NUM_LOGS = 4 }; |
| |
/** Log file Level - Defines the loglevel of the log entry irrespective of | /** Log file Level - Defines the loglevel of the log entry irrespective of |
which log file it goes into. This is actually a bit mask as defined in | which log file it goes into. This is actually a bit mask as defined in |
|
|
@param systemId - ID of the system generating the log entry within | @param systemId - ID of the system generating the log entry within |
Pegasus. This is user defined but generally breaks down into major | Pegasus. This is user defined but generally breaks down into major |
Pegasus components. | Pegasus components. |
@param level logLevel of the log entry. To be used both t0 |
@param level logLevel of the log entry. To be used both to |
mark the log entry and tested against a mask to determine if log | mark the log entry and tested against a mask to determine if log |
entry should be written. | entry should be written. |
@param messageId Message ID of the format string to load from |
@param msgParms MessageLoaderParms object containing the localizable |
the resource bundle. |
message to log. |
@param formatString Default format definition string. See the |
|
Formatter for details. This will be used as the default format string |
|
in case the resource bundle cannot be found. |
|
@param Arg0 - Arg 9 - Up to 9 arguments representing the variables |
|
that go into the log entry. |
|
<pre> |
|
Logger::put(Logger::TRACE_LOG, System::CIMSERVER, Logger::WARNING, |
|
"X=$0, Y=$1, Z=$2", 88, "Hello World", 7.5); |
|
</pre> |
|
*/ |
|
static void put_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const String& messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2, |
|
const Formatter::Arg& arg3, |
|
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
|
|
|
/** Optimized zero-argument form of put_l(). |
|
*/ |
|
static void put_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const String& messageId, |
|
const String& formatString); |
|
|
|
/** Optimized one-argument form of put_l(). |
|
*/ |
|
static void put_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const String& messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0); |
|
|
|
/** Optimized two-argument form of put_l(). |
|
*/ |
|
static void put_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const String& messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1); |
|
|
|
/** Optimized three-argument form of put_l(). |
|
*/ | */ |
static void put_l( | static void put_l( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
Uint32 logLevel, | Uint32 logLevel, |
const String& messageId, |
const MessageLoaderParms& msgParms); |
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2); |
|
| |
/** Puts a message to the define log. Should only be used for trace type |
/** Puts a trace message into the specified log. |
logs. |
|
*/ | */ |
static void trace( | static void trace( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
const Uint32 logComponent, | const Uint32 logComponent, |
const String& formatString, |
const String& message); |
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2, |
|
const Formatter::Arg& arg3, |
|
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
|
|
|
/** Optimized three-argument form of trace(). |
|
*/ |
|
static void trace( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& formatString); |
|
|
|
/** Optimized one-argument form of trace(). |
|
*/ |
|
static void trace( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& formatString, |
|
const Formatter::Arg& arg0); |
|
|
|
/** Optimized two-argument form of trace(). |
|
*/ |
|
static void trace( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1); |
|
|
|
/** Optimized three-argument form of trace(). |
|
*/ |
|
static void trace( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2); |
|
|
|
/** Puts a localized message to the log. Should only be used |
|
for trace type logs. |
|
*/ |
|
static void trace_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2, |
|
const Formatter::Arg& arg3, |
|
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
|
|
|
/** Optimized zero-argument form of trace_l(). |
|
*/ |
|
static void trace_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& messageId, |
|
const String& formatString); |
|
|
|
/** Optimized one-argument form of trace_l(). |
|
*/ |
|
static void trace_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0); |
|
|
|
/** Optimized two-argument form of trace_l(). |
|
*/ |
|
static void trace_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1); |
|
|
|
/** Optimized three-argument form of trace_l(). |
|
*/ |
|
static void trace_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const String& messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2); |
|
| |
/** setHomeDirectory | /** setHomeDirectory |
*/ | */ |
|
|
return (_severityMask & logLevel) != 0; | return (_severityMask & logLevel) != 0; |
} | } |
| |
|
#if !defined(PEGASUS_USE_SYSLOGS) |
|
static void setMaxLogFileSize (Uint32 maxLogFileSizeBytes); |
|
#endif |
|
|
private: | private: |
| |
static LoggerRep* _rep; | static LoggerRep* _rep; |
static String _homeDirectory; | static String _homeDirectory; |
static Uint32 _severityMask; | static Uint32 _severityMask; |
|
|
static const Uint32 _NUM_LOGLEVEL; | static const Uint32 _NUM_LOGLEVEL; |
| |
static void _putInternal( | static void _putInternal( |
|
|
const String& systemId, | const String& systemId, |
const Uint32 logComponent, | const Uint32 logComponent, |
Uint32 logLevel, | Uint32 logLevel, |
const String& formatString, |
const String& message); |
const String& messageId, |
|
const Formatter::Arg& arg0 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg1 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
|
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
|
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |