ScopeContext Class

ScopeContext stores state in the async thread execution context. All LogEvents created within a scope can include the scope state in the target output. The logical context scope supports both scope-properties and scope-nested-state-stack (Similar to log4j2 ThreadContext)

Inheritance Hierarchy

SystemObject
NLogScopeContext

Namespace: NLog
Assembly: NLog (in NLog.dll) Version: 5.3.4+73d83d3161d31288ca5c554cc50d27b6bed5f28b

Syntax

Copy

public static class ScopeContext

Public NotInheritable Class ScopeContext

You do not need to declare an instance of a static class in order to access its members.

[<AbstractClassAttribute>]
[<SealedAttribute>]
type ScopeContext =  class end

The ScopeContext type exposes the following members.

Methods

	Name	Description
	Clear	Clears all the entire logical context scope, and removes any properties and nested-states
	GetAllNestedStates	Retrieves all nested states inside the logical context scope stack
	GetAllProperties	Retrieves all properties stored within the logical context scopes
	PeekNestedState	Peeks the top value from the logical context scope stack
	PushNestedState(Object)	Pushes new state on the logical context scope stack
	PushNestedStateT(T)	Pushes new state on the logical context scope stack
	PushNestedStateProperties	Pushes new state on the logical context scope stack together with provided properties
	PushProperties(IReadOnlyCollectionKeyValuePairString, Object)	Updates the logical scope context with provided properties
	PushPropertiesTValue(IReadOnlyCollectionKeyValuePairString, TValue)	Updates the logical scope context with provided properties
	PushProperty(String, Object)	Updates the logical scope context with provided property
	PushPropertyTValue(String, TValue)	Updates the logical scope context with provided property
	TryGetProperty	Lookup single property stored within the logical context scopes

Top

Remarks

MappedDiagnosticsLogicalContext (MDLC), MappedDiagnosticsContext (MDC), NestedDiagnosticsLogicalContext (NDLC) and NestedDiagnosticsContext (NDC) have been deprecated and replaced by ScopeContext. .NetCore (and .Net46) uses AsyncLocal for handling the thread execution context. Older .NetFramework uses System.Runtime.Remoting.CallContext

Reference

NLog Namespace