pegasus/src/Pegasus/Common/Logger.h - diff

Return to Logger.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/Logger.h between version 1.17 and 1.31

version 1.17, 2003/10/22 14:26:03

version 1.31, 2007/10/17 20:37:27

Line 1

//%2003////////////////////////////////////////////////////////////////////////

//%2006////////////////////////////////////////////////////////////////////////

// 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; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; Symantec Corporation; The Open Group.

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to

Line 23

Line 29

//==============================================================================

// Author: Mike Brasher (mbrasher@bmc.com)

// Modified By: Dave Rosckes (rosckes@us.ibm.com)

//%/////////////////////////////////////////////////////////////////////////////

#ifndef Pegasus_Logger_h

Line 36

Line 38

#include <Pegasus/Common/Formatter.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/System.h>

#include <Pegasus/Common/MessageLoader.h> // l10n

#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

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

{

public:

Line 56

Line 73

{

TRACE_LOG,

STANDARD_LOG,

AUDIT_LOG, // Use only if PEGASUS_ENABLE_AUDIT_LOGGER is defined

ERROR_LOG,

DEBUG_LOG

};

enum { NUM_LOGS = 4 };

/** Log file Level - Defines the loglevel of the

enum { NUM_LOGS = 5 };

log entry irrespective of which log file it goes into. This is

actually a bit mask as defined in logger.cpp. Thus, it serves both

/** Log file Level - Defines the loglevel of the log entry irrespective of

as a level of indication of the seriousness and possibly as a mask

which log file it goes into. This is actually a bit mask as defined in

to select what is logged.

logger.cpp. Thus, it serves both as a level of indication of the

seriousness and possibly as a mask to select what is logged.

ATTN: The selection test has not been done.

static const Uint32 TRACE;

static const Uint32 INFORMATION;

static const Uint32 WARNING;

static const Uint32 SEVERE;

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 systemId - ID of the system generating the log entry within

Pegasus. This is user defined but generally breaks down into major

Line 89

Line 105

@param Arg0 - Arg 9 - Up to 9 arguments representing the variables

that go into the log entry.

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

</pre>

Line 98

Line 114

const String& systemId,

Uint32 logLevel,

const String& formatString,

const Formatter::Arg& arg0 = Formatter::Arg(),

const Formatter::Arg& arg0,

const Formatter::Arg& arg1 = Formatter::Arg(),

const Formatter::Arg& arg1,

const Formatter::Arg& arg2 = Formatter::Arg(),

const Formatter::Arg& arg2,

const Formatter::Arg& arg3 = Formatter::Arg(),

const Formatter::Arg& arg3,

const Formatter::Arg& arg4 = Formatter::Arg(),

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::Arg(),

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::Arg(),

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::Arg(),

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::Arg(),

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::Arg());

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

/** Optimized zero-argument form of put().

static void put(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& formatString);

/** Optimized one-argument form of put().

static void put(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& formatString,

const Formatter::Arg& arg0);

/** Optimized two-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);

/** 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);

// l10n

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

/** put_l - Puts a localized message to the defined log file

@param logFileType - Type of log file (Trace, etc.)

@param systemId - ID of the system generating the log entry within

Line 127

Line 179

@param Arg0 - Arg 9 - Up to 9 arguments representing the variables

that go into the log entry.

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

</pre>

Line 137

Line 189

Uint32 logLevel,

const String& messageId,

const String& formatString,

const Formatter::Arg& arg0 = Formatter::Arg(),

const Formatter::Arg& arg0,

const Formatter::Arg& arg1 = Formatter::Arg(),

const Formatter::Arg& arg1,

const Formatter::Arg& arg2 = Formatter::Arg(),

const Formatter::Arg& arg2,

const Formatter::Arg& arg3 = Formatter::Arg(),

const Formatter::Arg& arg3,

const Formatter::Arg& arg4 = Formatter::Arg(),

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::Arg(),

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::Arg(),

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::Arg(),

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::Arg(),

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::Arg());

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

#endif

/** 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(

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

/** Puts a message to the define log. Should only be used for trace type

logs.

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,

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

// _trace - puts a message to the define log. Should only be used

/** Optimized one-argument form of trace().

// for trace type logs

static void trace(

LogFileType logFileType,

const String& systemId,

const Uint32 logComponent,

const String& formatString,

const Formatter::Arg& arg0 = Formatter::Arg(),

const Formatter::Arg& arg0);

const Formatter::Arg& arg1 = Formatter::Arg(),

const Formatter::Arg& arg2 = Formatter::Arg(),

/** Optimized two-argument form of trace().

const Formatter::Arg& arg3 = Formatter::Arg(),

const Formatter::Arg& arg4 = Formatter::Arg(),

static void trace(

const Formatter::Arg& arg5 = Formatter::Arg(),

LogFileType logFileType,

const Formatter::Arg& arg6 = Formatter::Arg(),

const String& systemId,

const Formatter::Arg& arg7 = Formatter::Arg(),

const Uint32 logComponent,

const Formatter::Arg& arg8 = Formatter::Arg(),

const String& formatString,

const Formatter::Arg& arg9 = Formatter::Arg());

const Formatter::Arg& arg0,

const Formatter::Arg& arg1);

// 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,

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 = Formatter::Arg(),

const Formatter::Arg& arg0,

const Formatter::Arg& arg1 = Formatter::Arg(),

const Formatter::Arg& arg1,

const Formatter::Arg& arg2 = Formatter::Arg(),

const Formatter::Arg& arg2,

const Formatter::Arg& arg3 = Formatter::Arg(),

const Formatter::Arg& arg3,

const Formatter::Arg& arg4 = Formatter::Arg(),

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::Arg(),

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::Arg(),

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::Arg(),

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::Arg(),

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::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 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

Line 200

Line 369

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

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 String _homeDirectory;

static Uint32 _severityMask;

static Uint32 _writeControlMask;

static const char _SEPARATOR;

static const Uint32 _NUM_LOGLEVEL;

static const Boolean _SUCCESS;

static const Boolean _FAILURE;

static void _putInternal(

LogFileType logFileType,

const String& systemId,

const Uint32 logComponent,

Uint32 logLevel,

const String& formatString,

const String& messageId, // l10n

const String& messageId,

const Formatter::Arg& arg0 = Formatter::Arg(),

const Formatter::Arg& arg0 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg1 = Formatter::Arg(),

const Formatter::Arg& arg1 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg2 = Formatter::Arg(),

const Formatter::Arg& arg2 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg3 = Formatter::Arg(),

const Formatter::Arg& arg3 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg4 = Formatter::Arg(),

const Formatter::Arg& arg4 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg5 = Formatter::Arg(),

const Formatter::Arg& arg5 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg6 = Formatter::Arg(),

const Formatter::Arg& arg6 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg7 = Formatter::Arg(),

const Formatter::Arg& arg7 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg8 = Formatter::Arg(),

const Formatter::Arg& arg8 = Formatter::DEFAULT_ARG,

const Formatter::Arg& arg9 = Formatter::Arg());

const Formatter::Arg& arg9 = Formatter::DEFAULT_ARG);

};

PEGASUS_NAMESPACE_END

Legend:

Removed from v.1.17
changed lines
	Added in v.1.31

No CVS admin address has been configured