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.6 and 1.21

version 1.6, 2001/06/16 23:10:04

version 1.21, 2005/10/31 16:53:08

Line 1

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

//%2005////////////////////////////////////////////////////////////////////////

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

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

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

Line 22

Line 29

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

// Modified By:

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

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

Line 31

Line 38

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Formatter.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/System.h>

#include <Pegasus/Common/MessageLoader.h>

#define PEG_LOGGER_TRACE(ARGS_LIST) \

do \

{ \

if (Logger::wouldLog(Logger::TRACE)) \

{ \

Logger::trace ARGS_LIST ; \

} \

while (0)

PEGASUS_NAMESPACE_BEGIN

class LoggerRep;

/**

/** This class provides the interface for writing log records to the log.

class PEGASUS_COMMON_LINKAGE Logger

{

Line 50

Line 69

ERROR_LOG,

DEBUG_LOG

};

enum { NUM_LOGS = 4 };

/** Log file Level - Defines the level of severity 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.

static const Uint32 TRACE;

static const Uint32 INFORMATION;

static const Uint32 WARNING;

static const Uint32 SEVERE;

static const Uint32 FATAL;

/** put - Puts a message to the defined log file

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

Pegasus components.

@param level Level of severity of the log entry. To be used both t0

@param level logLevel of the log entry. To be used both t0

mark the log entry and tested against a mask to determine if log

entry should be written.

@param formatString Format definition string for the Log. See the

Line 86

Line 104

static void put(

LogFileType logFileType,

const String& systemId,

Uint32 severity,

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

/** setHomeDirectory

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

static void setHomeDirectory(const String& homeDirectory);

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

#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

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

Pegasus components.

@param level logLevel of the log entry. To be used both t0

mark the log entry and tested against a mask to determine if log

entry should be written.

@param messageId Message ID of the format string to load from

the resource bundle.

@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, "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);

/* clean - Cleans the logger files.

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

@param directory Defines the directory that the logs are in

static void clean(const String& directory);

static void put_l(

LogFileType logFileType,

const String& systemId,

Uint32 logLevel,

const String& messageId,

const String& formatString);

/** setSeverityMask

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

static void setSeverityMask(const Uint32);

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

#endif /* PEGASUS_USE_EXPERIMENTAL_INTERFACES */

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

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

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

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

#endif /* PEGASUS_USE_EXPERIMENTAL_INTERFACES */

/** setHomeDirectory

static void setHomeDirectory(const String& homeDirectory);

/** setlogLevelMask

static void setlogLevelMask(const String logLevelList);

/** setLogWriteControlMask

static void setLogWriteControlMask(const Uint32);

/** Returns true if the given string is one of the legal log levels.

static Boolean isValidlogLevel(const String logLevel);

/** 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 bool wouldLog(Uint32 logLevel)

{

return _severityMask & logLevel;

}

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,

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

Legend:

Removed from v.1.6
changed lines
	Added in v.1.21

No CVS admin address has been configured