NLogAspNetCoreOptions Class

Options for ASP.NET Core and NLog

Inheritance Hierarchy

SystemObject
NLog.Extensions.LoggingNLogProviderOptions
NLog.WebNLogAspNetCoreOptions

Namespace: NLog.Web
Assembly: NLog.Web.AspNetCore (in NLog.Web.AspNetCore.dll) Version: 6.0.0+59339f2811712b446adf6dcd8a6bad39ad9f2ba1

Syntax

Copy

public sealed class NLogAspNetCoreOptions : NLogProviderOptions

Public NotInheritable Class NLogAspNetCoreOptions
	Inherits NLogProviderOptions

Dim instance As NLogAspNetCoreOptions

[<SealedAttribute>]
type NLogAspNetCoreOptions =  
    class
        inherit NLogProviderOptions
    end

The NLogAspNetCoreOptions type exposes the following members.

Constructors

	Name	Description
	NLogAspNetCoreOptions	Initializes a new instance of the NLogAspNetCoreOptions class

Top

Properties

	Name	Description
	AutoShutdown	Automatically Shutdown NLog on AppDomain.Unload or AppDomain.ProcessExit (Inherited from NLogProviderOptions.)
	CaptureEventId	Control capture of EventId as "EventId"-property. (Inherited from NLogProviderOptions.)
	CaptureMessageParameters	Enable capture of Parameters from the ILogger-State-object. Only relevant when CaptureMessageTemplates = true (Inherited from NLogProviderOptions.)
	CaptureMessageProperties	Enable capture of properties from the ILogger-State-object, both in Log``1(LogLevel, EventId, UMP, Exception, FuncUMP, Exception, String) and BeginScope``1(UMP) (Inherited from NLogProviderOptions.)
	CaptureMessageTemplates	Enable structured logging by capturing message template parameters with support for "@" and "$". Enables use of ${message:raw=true} (Inherited from NLogProviderOptions.)
	Default	The default options
	EventIdSeparator	Separator between for EventId.Id and EventId.Name. Default to _ (Inherited from NLogProviderOptions.)
	IgnoreEmptyEventId	Skip capture of EventId in Properties when default(EventId) (Inherited from NLogProviderOptions.)
	IncludeActivityIdsWithBeginScope	Obsolete. Automatically include Activity.SpanId, Activity.TraceId and Activity.ParentId. (Inherited from NLogProviderOptions.)
	IncludeActivtyIdsWithBeginScope	Obsolete. See IncludeActivityIdsWithBeginScope for documentation (Inherited from NLogProviderOptions.)
	IncludeScopes	Enable capture of scope information and inject into ScopeContext (Inherited from NLogProviderOptions.)
	LoggingConfigurationSectionName	Checks the Host Configuration for the specified section-name, and tries to load NLog-LoggingConfiguration after creation of NLogLoggerProvider (Inherited from NLogProviderOptions.)
	ParseMessageTemplates	Use the NLog engine for parsing the message template (again) and format using the NLog formatter (Inherited from NLogProviderOptions.)
	RegisterHttpContextAccessor	Register the HttpContextAccessor when not yet registed. Default true
	RegisterServiceProvider	Enable NLog Targets and Layouts to perform dependency lookup using the Microsoft Dependency Injection IServiceProvider (Inherited from NLogProviderOptions.)
	RemoveLoggerFactoryFilter	Resets the default Microsoft LoggerFactory Filter for the NLogLoggerProvider, and instead only uses NLog LoggingRules. (Inherited from NLogProviderOptions.)
	ReplaceLoggerFactory	Replace Microsoft LoggerFactory with a pure NLogLoggerFactory, and disables Microsoft Filter Logic and removes other LoggingProviders. (Inherited from NLogProviderOptions.)
	ShutdownOnDispose	Shutdown NLog on dispose of the NLogLoggerProvider (Inherited from NLogProviderOptions.)

Top

Reference

NLog.Web Namespace