Class LoggedRenderer

Decorates an IRenderer so that all event messages are logged.

Every single event message causes two log messages: one is logged before rendering, and other one is logged after rendering. If any exception is thrown it is also logged with the log level Serilog.Events.LogEventLevel.Error (regardless of Level configuration).

Inheritance

Object

LoggedRenderer

LoggedActionRenderer

Implements

IRenderer

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Libplanet.Blockchain.Renderers

Assembly: Libplanet.dll

Syntax

public class LoggedRenderer : IRenderer

Remarks

Since IActionRenderer is a subtype of IRenderer, LoggedRenderer(IRenderer, ILogger, LogEventLevel) constructor can take an IActionRenderer instance as well. However, even it takes an action renderer, action-level fine-grained events will not be logged. For action renderers, please use LoggedActionRenderer instead.

Examples

IRenderer renderer = new SomeRenderer();
// Wraps the renderer with LoggedRenderer:
renderer = new LoggedRenderer(
    renderer,
    Log.Logger,
    LogEventLevel.Information,
);

Constructors

LoggedRenderer(IRenderer, ILogger, LogEventLevel)

Creates a new LoggedRenderer instance which decorates the given renderer.

Declaration

public LoggedRenderer(IRenderer renderer, ILogger logger, LogEventLevel level = LogEventLevel.Debug)

Parameters

Type	Name	Description
IRenderer	renderer	The actual renderer to forward all event messages to and actually render things.
Serilog.ILogger	logger	The logger to write log messages to. Note that all log messages this decorator writes become in the context of the renderer's type (with the context property SourceContext).
Serilog.Events.LogEventLevel	level	The log event level. All log messages become this level.

Remarks

Since IActionRenderer is a subtype of IRenderer, LoggedRenderer(IRenderer, ILogger, LogEventLevel) constructor can take an IActionRenderer instance as well. However, even it takes an action renderer, action-level fine-grained events will not be logged. For action renderers, please use LoggedActionRenderer instead.

Properties

Level

The log event level. All log messages become this level.

Declaration

public LogEventLevel Level { get; }

Property Value

Type	Description
Serilog.Events.LogEventLevel

Remarks

Since IActionRenderer is a subtype of IRenderer, LoggedRenderer(IRenderer, ILogger, LogEventLevel) constructor can take an IActionRenderer instance as well. However, even it takes an action renderer, action-level fine-grained events will not be logged. For action renderers, please use LoggedActionRenderer instead.

Logger

The logger to write log messages to. Note that all log messages this decorator writes become in the context of the Renderer's type (with the context property SourceContext).

Declaration

protected ILogger Logger { get; }

Property Value

Type	Description
Serilog.ILogger

Remarks

Since IActionRenderer is a subtype of IRenderer, LoggedRenderer(IRenderer, ILogger, LogEventLevel) constructor can take an IActionRenderer instance as well. However, even it takes an action renderer, action-level fine-grained events will not be logged. For action renderers, please use LoggedActionRenderer instead.

Renderer

The inner renderer to forward all event messages to and actually render things.

Declaration

public IRenderer Renderer { get; }

Property Value

Type	Description
IRenderer

Remarks

Since IActionRenderer is a subtype of IRenderer, LoggedRenderer(IRenderer, ILogger, LogEventLevel) constructor can take an IActionRenderer instance as well. However, even it takes an action renderer, action-level fine-grained events will not be logged. For action renderers, please use LoggedActionRenderer instead.

Methods

LogBlockRendering(String, Block, Block, Action<Block, Block>)

Decorates an IRenderer so that all event messages are logged.

Every single event message causes two log messages: one is logged before rendering, and other one is logged after rendering. If any exception is thrown it is also logged with the log level Serilog.Events.LogEventLevel.Error (regardless of Level configuration).

Declaration

protected void LogBlockRendering(string methodName, Block oldTip, Block newTip, Action<Block, Block> callback)

Parameters

Type	Name	Description
String	methodName
Block	oldTip
Block	newTip
Action<Block, Block>	callback

Remarks

Since IActionRenderer is a subtype of IRenderer, LoggedRenderer(IRenderer, ILogger, LogEventLevel) constructor can take an IActionRenderer instance as well. However, even it takes an action renderer, action-level fine-grained events will not be logged. For action renderers, please use LoggedActionRenderer instead.

Examples

IRenderer renderer = new SomeRenderer();
// Wraps the renderer with LoggedRenderer:
renderer = new LoggedRenderer(
    renderer,
    Log.Logger,
    LogEventLevel.Information,
);

RenderBlock(Block, Block)

Does things that should be done right after a new Block is appended to a BlockChain (so that its Tip has changed).

Declaration

public void RenderBlock(Block oldTip, Block newTip)

Parameters

Type	Name	Description
Block	oldTip	The previous Tip.
Block	newTip	The current Tip.

Remarks

It is guaranteed to be called only once for a block, and only after applied to the blockchain, unless it has been stale due to reorg.

Implements

IRenderer