version 1.18.4.1, 2004/12/01 03:23:47
|
version 1.34, 2008/08/12 17:35:08
|
|
|
//%2004//////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development | // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. | // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
|
// IBM Corp.; EMC Corporation, The Open Group. | // IBM Corp.; EMC Corporation, The Open Group. |
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; | // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. | // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// Permission is hereby granted, free of charge, to any person obtaining a copy | // Permission is hereby granted, free of charge, to any person obtaining a copy |
// of this software and associated documentation files (the "Software"), to | // of this software and associated documentation files (the "Software"), to |
|
|
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: Dave Rosckes (rosckes@us.ibm.com) |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_Logger_h | #ifndef Pegasus_Logger_h |
|
|
#include <Pegasus/Common/Formatter.h> | #include <Pegasus/Common/Formatter.h> |
#include <Pegasus/Common/Linkage.h> | #include <Pegasus/Common/Linkage.h> |
#include <Pegasus/Common/System.h> | #include <Pegasus/Common/System.h> |
#include <Pegasus/Common/MessageLoader.h> // l10n |
#include <Pegasus/Common/MessageLoader.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
class LoggerRep; | class LoggerRep; |
| |
// REVIEW: is this still used? Are there other mechanisms? |
/** This class provides the interface for writing log records to the log. |
|
|
/** |
|
|
|
*/ | */ |
|
|
class PEGASUS_COMMON_LINKAGE Logger | class PEGASUS_COMMON_LINKAGE Logger |
{ | { |
public: | public: |
|
|
{ | { |
TRACE_LOG, | TRACE_LOG, |
STANDARD_LOG, | STANDARD_LOG, |
ERROR_LOG, |
AUDIT_LOG, // Use only if PEGASUS_ENABLE_AUDIT_LOGGER is defined |
DEBUG_LOG |
ERROR_LOG |
}; | }; |
|
|
enum { NUM_LOGS = 4 }; | enum { NUM_LOGS = 4 }; |
| |
/** Log file Level - Defines the loglevel of the |
/** Log file Level - Defines the loglevel of the log entry irrespective of |
log entry irrespective of which log file it goes into. This is |
which log file it goes into. This is actually a bit mask as defined in |
actually a bit mask as defined in logger.cpp. Thus, it serves both |
logger.cpp. Thus, it serves both as a level of indication of the |
as a level of indication of the seriousness and possibly as a mask |
seriousness and possibly as a mask to select what is logged. |
to select what is logged. |
|
ATTN: The selection test has not been done. | ATTN: The selection test has not been done. |
*/ | */ |
|
|
static const Uint32 TRACE; | static const Uint32 TRACE; |
static const Uint32 INFORMATION; | static const Uint32 INFORMATION; |
static const Uint32 WARNING; | static const Uint32 WARNING; |
static const Uint32 SEVERE; | static const Uint32 SEVERE; |
static const Uint32 FATAL; | static const Uint32 FATAL; |
| |
|
/** Puts a message to the defined log file |
/** put - Puts a message to the defined log file |
|
@param logFileType - Type of log file (Trace, etc.) | @param logFileType - Type of log file (Trace, etc.) |
@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 |
|
|
@param Arg0 - Arg 9 - Up to 9 arguments representing the variables | @param Arg0 - Arg 9 - Up to 9 arguments representing the variables |
that go into the log entry. | that go into the log entry. |
<pre> | <pre> |
Logger::put(Logger::TRACE_LOG, "CIMServer", Logger::WARNING, |
Logger::put(Logger::TRACE_LOG, System::CIMSERVER, Logger::WARNING, |
"X=$0, Y=$1, Z=$2", 88, "Hello World", 7.5); | "X=$0, Y=$1, Z=$2", 88, "Hello World", 7.5); |
</pre> | </pre> |
*/ | */ |
#if 1 |
|
static void put( | static void put( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
|
|
const String& formatString, | const String& formatString, |
const Formatter::Arg& arg0, | const Formatter::Arg& arg0, |
const Formatter::Arg& arg1, | const Formatter::Arg& arg1, |
const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg2, |
const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg3, |
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); | const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
#endif |
|
| |
|
/** Optimized zero-argument form of put(). |
|
*/ |
static void put( | static void put( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
Uint32 logLevel, | Uint32 logLevel, |
const String& formatString); | const String& formatString); |
| |
|
/** Optimized one-argument form of put(). |
|
*/ |
static void put( | static void put( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
|
|
const String& formatString, | const String& formatString, |
const Formatter::Arg& arg0); | const Formatter::Arg& arg0); |
| |
// l10n |
/** Optimized two-argument form of put(). |
#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES |
*/ |
|
static void put( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1); |
|
|
|
/** Optimized three-argument form of put(). |
|
*/ |
|
static void put( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2); |
|
|
/** put_l - Puts a localized message to the defined log file | /** put_l - Puts a localized message to the defined log file |
@param logFileType - Type of log file (Trace, etc.) | @param logFileType - Type of log file (Trace, etc.) |
@param systemId - ID of the system generating the log entry within | @param systemId - ID of the system generating the log entry within |
|
|
@param Arg0 - Arg 9 - Up to 9 arguments representing the variables | @param Arg0 - Arg 9 - Up to 9 arguments representing the variables |
that go into the log entry. | that go into the log entry. |
<pre> | <pre> |
Logger::put(Logger::TRACE_LOG, "CIMServer", Logger::WARNING, |
Logger::put(Logger::TRACE_LOG, System::CIMSERVER, Logger::WARNING, |
"X=$0, Y=$1, Z=$2", 88, "Hello World", 7.5); | "X=$0, Y=$1, Z=$2", 88, "Hello World", 7.5); |
</pre> | </pre> |
*/ | */ |
#if 1 |
|
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 char* messageId, |
const String& formatString, |
const char* formatString, |
const Formatter::Arg& arg0, | const Formatter::Arg& arg0, |
const Formatter::Arg& arg1, | const Formatter::Arg& arg1, |
const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg2, |
const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg3, |
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); | const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
#endif |
|
| |
|
/** Optimized zero-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 char* messageId, |
const String& formatString); |
const char* formatString); |
| |
|
/** Optimized one-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 char* messageId, |
const String& formatString, |
const char* formatString, |
const Formatter::Arg& arg0); | const Formatter::Arg& arg0); |
#endif |
|
| |
|
/** Optimized two-argument form of put_l(). |
|
*/ |
|
static void put_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const char* messageId, |
|
const char* formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1); |
| |
// _trace - puts a message to the define log. Should only be used |
/** Optimized three-argument form of put_l(). |
// for trace type logs |
*/ |
|
static void put_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
Uint32 logLevel, |
|
const char* messageId, |
|
const char* 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 |
|
logs. |
|
*/ |
static void trace( | static void trace( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
|
|
const String& formatString, | const String& formatString, |
const Formatter::Arg& arg0, | const Formatter::Arg& arg0, |
const Formatter::Arg& arg1, | const Formatter::Arg& arg1, |
const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg2, |
const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg3, |
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
|
|
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); | const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
| |
// l10n |
/** Optimized three-argument form of trace(). |
#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES |
*/ |
// trace - puts a localized message to the log. Should only be used |
static void trace( |
// for trace type logs |
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( | static void trace_l( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
const Uint32 logComponent, | const Uint32 logComponent, |
const String& messageId, |
const char* messageId, |
const String& formatString, | const String& formatString, |
const Formatter::Arg& arg0 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg0, |
const Formatter::Arg& arg1 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg1, |
const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg2, |
const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg3, |
const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); | const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
#endif |
|
| |
|
/** Optimized zero-argument form of trace_l(). |
|
*/ |
|
static void trace_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const char* messageId, |
|
const String& formatString); |
|
|
|
/** Optimized one-argument form of trace_l(). |
|
*/ |
|
static void trace_l( |
|
LogFileType logFileType, |
|
const String& systemId, |
|
const Uint32 logComponent, |
|
const char* 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 char* 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 char* messageId, |
|
const String& formatString, |
|
const Formatter::Arg& arg0, |
|
const Formatter::Arg& arg1, |
|
const Formatter::Arg& arg2); |
| |
/** setHomeDirectory | /** setHomeDirectory |
*/ | */ |
|
|
*/ | */ |
static void setlogLevelMask(const String logLevelList); | static void setlogLevelMask(const String logLevelList); |
| |
/** setLogWriteControlMask |
/** Returns true if the given string is one of the legal log levels. |
*/ | */ |
static void setLogWriteControlMask(const Uint32); |
|
|
|
static Boolean isValidlogLevel(const String logLevel); | static Boolean isValidlogLevel(const String logLevel); |
private: |
|
| |
|
/** Tests if a log entry would be created by this call before |
|
the logger is called. This function is intended to be used |
|
within the server for high usage log entries to avoid the |
|
overhead of doing the call when no log is created. |
|
@param logLevel Uint32 defining the level of the log to be |
|
executed. |
|
<p><b>Example:</b> |
|
<pre> |
|
if (Logger::wouldLog(Logger::TRACE)) |
|
{ |
|
Logger::put(Logger::STANDARD_LOG, System::CIMSERVER, |
|
Logger::TRACE, "HTTPMessage - HTTP header name: $0 " |
|
"HTTP header value: $1" ,name,value); |
|
} |
|
</pre> |
|
*/ |
|
static Boolean wouldLog(Uint32 logLevel) |
|
{ |
|
return (_severityMask & logLevel) != 0; |
|
} |
|
|
|
private: |
| |
static LoggerRep* _rep; | static LoggerRep* _rep; |
static String _homeDirectory; | static String _homeDirectory; |
static Uint32 _severityMask; | static Uint32 _severityMask; |
static Uint32 _writeControlMask; |
|
| |
static const char _SEPARATOR; |
|
static const Uint32 _NUM_LOGLEVEL; | static const Uint32 _NUM_LOGLEVEL; |
| |
static const Boolean _SUCCESS; |
|
static const Boolean _FAILURE; |
|
static void _putInternal( | static void _putInternal( |
LogFileType logFileType, | LogFileType logFileType, |
const String& systemId, | const String& systemId, |
const Uint32 logComponent, | const Uint32 logComponent, |
Uint32 logLevel, | Uint32 logLevel, |
const String& formatString, | const String& formatString, |
const String& messageId, // l10n |
const char* messageId, |
const Formatter::Arg& arg0 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg0 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg1 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg1 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG, |
|
|
const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, | const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG, |
const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); | const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG); |
|
|
}; | }; |
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |