JsonLayout Class

A specialized layout that renders JSON-formatted events.

Inheritance Hierarchy

Namespace: NLog.Layouts
Assembly: NLog (in NLog.dll) Version: 6.0.0+cfb73701cda54e2410b006f649f072e90daef707

Syntax

public class JsonLayout : Layout

Public Class JsonLayout
	Inherits Layout

Dim instance As JsonLayout

type JsonLayout =  
    class
        inherit Layout
    end

The JsonLayout type exposes the following members.

Constructors

	Name	Description
	JsonLayout	Initializes a new instance of the JsonLayout class.

Properties

	Name	Description
	Attributes	Gets the array of attributes' configurations.
	ExcludeEmptyProperties	Gets or sets the option to exclude null/empty properties from the log event (as JSON)
	ExcludeProperties	List of property names to exclude when IncludeAllProperties is true
	IncludeEventProperties	Gets or sets the option to include all properties from the log event (as JSON)
	IncludeGdc	Gets or sets a value indicating whether to include contents of the GlobalDiagnosticsContext dictionary.
	IncludeScopeProperties	Gets or sets whether to include the contents of the ScopeContext dictionary.
	IndentJson	Auto indent and create new lines
	LoggingConfiguration	Gets the logging configuration this target is part of. (Inherited from Layout.)
	MaxRecursionLimit	How far should the JSON serializer follow object references before backing off
	RenderEmptyObject	Gets or sets the option to render the empty object value {}
	SuppressSpaces	Gets or sets the option to suppress the extra spaces in the output json.

Methods

	Name	Description
	CloseLayout	Closes the layout. (Overrides LayoutCloseLayout.)
	GetFormattedMessage	Renders formatted output using the log event as context. (Overrides LayoutGetFormattedMessage(LogEventInfo).)
	InitializeLayout	Initializes the layout. (Overrides LayoutInitializeLayout.)
	Precalculate	Precalculates the layout for the specified log event and stores the result in per-log event cache. Skips context capture when Layout have [ThreadAgnostic], and only contains layouts with [ThreadAgnostic]. (Inherited from Layout.)
	Render(LogEventInfo)	Renders formatted output using the log event as context. (Inherited from Layout.)
	Render(LogEventInfo, StringBuilder)	Optimized version of Render(LogEventInfo) that works best when override of RenderFormattedMessage(LogEventInfo, StringBuilder) is available. (Inherited from Layout.)
	RenderFormattedMessage	Renders formatted output using the log event as context. (Overrides LayoutRenderFormattedMessage(LogEventInfo, StringBuilder).)
	ResolveServiceT	Resolve from DI ServiceRepository (Inherited from Layout.)
	ToString	Returns a string that represents the current object. (Overrides ObjectToString.)

Remarks