Skip to content

325381a6 bc36 08ac cc1c 4c68ceeb1916

Axel Kesseler edited this page Mar 1, 2023 · 2 revisions

LogLevelMessageExtension.Message(TScope) Method (ILogger, TScope, String, Exception, ValueTuple(String, Object)[])

This method writes the message and the exception for provided scope into the logger using Message as logging level.

Namespace: Plexdata.LogWriter.Extensions
Assembly: Plexdata.LogWriter.Abstraction (in Plexdata.LogWriter.Abstraction.dll) Version: 1.0.7.1

Syntax

C#

public static void Message<TScope>(
	this ILogger logger,
	TScope scope,
	string message,
	Exception exception,
	params (string , Object )[] details
)

Parameters

 

logger
Type: Plexdata.LogWriter.Abstraction.ILogger
The logger used to write the message.
scope
Type: TScope
The logging scope instance to be used.
message
Type: System.String
The message to be written.
exception
Type: System.Exception
The exception to be written.
details
Type: System.ValueTuple(String, Object)[]
An optional list of label-value-pair combinations containing additional information.

Type Parameters

 

TScope
The type or a Guid that represents the logging scope.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type ILogger. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

The logging scope is intended to be more than just the type name.  

  • If parameter scope is for example of type String then this string is used.
  • If parameter scope is for example of type Guid then the guid's string representation is taken by calling ToString(). Using a Guid as scope type can be seen as some kind of correlation ID, especially if this Guid is the same for multiple calls.
  • If parameter scope is for example of type MemberInfo then the referenced member's Name is taken instead.
  • In all other cases the scope text is either taken from the type's FullName or it is just the Name of type TScope. The usage of full or short name is determined from current settings.
  Be aware, nothing will happen if logger is null or if message is null, empty or consists only of whitespaces or if exception is null. In case of the message is invalid but the exception is valid, the message text is taken from the exception instead.

See Also

Reference

LogLevelMessageExtension Class
Message Overload
Plexdata.LogWriter.Extensions Namespace

Clone this wiki locally