GemStone::GemFire::Cache::Log

GemStone::GemFire::Cache::Log Class Reference

Detailed Description

Defines methods available to clients that want to write a log message to their GemFire system's shared log file.

Any attempt to use an instance after its connection is disconnected will throw a NotConnectedException.

For any logged message the log file will contain:

The message's log level.
The time the message was logged.
The ID of the connection and thread that logged the message.
The message itself, perhaps with an exception including the exception's stack trace.

A message always has a level. Logging levels are ordered. Enabling logging at a given level also enables logging at higher levels. The higher the level the more important and urgent the message.

The levels, in descending order of severity, are:

Error (highest severity) is a message level indicating a serious failure. In general error messages should describe events that are of considerable importance and which will prevent normal program execution. They should be reasonably intelligible to end users and to system administrators.
Warning is a message level indicating a potential problem. In general warning messages should describe events that will be of interest to end users or system managers, or which indicate potential problems.
Info is a message level for informational messages. Typically info messages should be reasonably significant and should make sense to end users and system administrators.
Config is a message level for static configuration messages. config messages are intended to provide a variety of static configuration information, to assist in debugging problems that may be associated with particular configurations.
Fine is a message level providing tracing information. In general the fine level should be used for information that will be broadly interesting to developers. This level is for the lowest volume, and most important, tracing messages.
Finer indicates a moderately detailed tracing message. This is an intermediate level between fine and finest.
Finest indicates a very detailed tracing message. Logging calls for entering, returning, or throwing an exception are traced at the finest level.
Debug (lowest severity) indicates a highly detailed tracing message. In general the debug level should be used for the most voluminous detailed tracing messages.


Static Public Member Functions
static void	Close ()
static void	Config (String^ format,...array< Object^ >^args)
static void	Debug (String^ format,...array< Object^ >^args)
static Boolean	Enabled (LogLevel level)
static void	Error (String^ format,...array< Object^ >^args)
static void	Fine (String^ format,...array< Object^ >^args)
static void	Finer (String^ format,...array< Object^ >^args)
static void	Finest (String^ format,...array< Object^ >^args)
static void	Info (String^ format,...array< Object^ >^args)
static void	Init (LogLevel level, String^ logFileName, Int32 logFileLimit)
static void	Init (LogLevel level, String^ logFileName)
static LogLevel	Level ()
static void	LogCatch (LogLevel level, String^ msg, System::Exception^ ex)
static String^	LogFileName ()
static void	LogThrow (LogLevel level, String^ msg, System::Exception^ ex)
static void	SetLevel (LogLevel level)
static void	Warning (String^ format,...array< Object^ >^args)
static void	Write (LogLevel level, String^ msg)

Member Function Documentation

static void GemStone::GemFire::Cache::Log::Close ( ) [static]

Closes logging facility (until next init).

static void GemStone::GemFire::Cache::Log::Config	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Config level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Log::Debug	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Debug level logging with variable number of arguments using format as in System.String.Format.

static Boolean GemStone::GemFire::Cache::Log::Enabled ( LogLevel level ) [static]

True if log messages at the given level are enabled.

static void GemStone::GemFire::Cache::Log::Error	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Error level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Log::Fine	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Fine level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Log::Finer	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Finer level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Log::Finest	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Finest level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Log::Info	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Info level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Log::Init	(	LogLevel	level,
		String^	logFileName,
		Int32	logFileLimit
	)			`[static]`

Initializes logging facility with given level, filename, and file size limit.

Parameters:

	level	the logging level
	logFileName	the log file name
	logFileLimit	maximum allowable size of the log file, in bytes, or 0 for the default (1 Gbyte)

static void GemStone::GemFire::Cache::Log::Init	(	LogLevel	level,
		String^	logFileName
	)			`[static]`

Initializes the logging facility with the given level and filename.

Parameters:

	level	the logging level
	logFileName	the log file name

static LogLevel GemStone::GemFire::Cache::Log::Level ( ) [static]

Returns the current log level.

static void GemStone::GemFire::Cache::Log::LogCatch	(	LogLevel	level,
		String^	msg,
		System::Exception^	ex
	)			`[static]`

Logs both a message and a caught exception.

static String ^ GemStone::GemFire::Cache::Log::LogFileName ( ) [static]

Returns the name of the current log file. NOTE: This function is for debugging only, as it is not completely thread-safe!

static void GemStone::GemFire::Cache::Log::LogThrow	(	LogLevel	level,
		String^	msg,
		System::Exception^	ex
	)			`[static]`

Logs both a message and a thrown exception.

static void GemStone::GemFire::Cache::Log::SetLevel ( LogLevel level ) [static]

Sets the current log level.

static void GemStone::GemFire::Cache::Log::Warning	(	String^	format,
		...array< Object^ >^	args
	)			`[inline, static]`

Warning level logging with variable number of arguments using format as in System.String.Format.

static void GemStone::GemFire::Cache::Log::Write	(	LogLevel	level,
		String^	msg
	)			`[static]`

Logs a message at the given level.

GemFire C++ Cache .NET API Documentation

GemStone::GemFire::Cache::Log Class Reference

Detailed Description

Static Public Member Functions

Member Function Documentation