AzureTableTarget Class

SystemObject
  Target
    TargetWithLayout
      TargetWithContext
        AsyncTaskTarget
          InnerDrive.LoggingAzureTableTarget

C#

Copy

[TargetAttribute("AzureTableTarget")]
public class AzureTableTarget : AsyncTaskTarget

	Name	Description
	AzureTableTarget	Creates a new instance of AzureTableTarget
	AzureTableTarget(IConfiguration)	Creates a new instance of AzureTableTarget with configuration data
	AzureTableTarget(ISecretProvider)	Creates a new instance of AzureTableTarget with configuration data

Top

	Name	Description
	AccountKey	Gets or sets the Microsoft Azure connection string
	AccountName	Gets or sets the Microsoft Azure connection string
	ApplicationName	Gets or sets the application name to use
	BaseTableName	Gets or sets the table to use; default is time-based
	BatchSize	Gets or sets the number of log events that should be processed in a batch by the lazy writer thread. (Inherited from AsyncTaskTarget)
	Configuration	Gets or sets a IConfiguration provider
	ContextProperties	Gets the array of custom attributes to be passed into the logevent context (Inherited from TargetWithContext)
	ExcludeProperties	List of property names to exclude when IncludeEventProperties is true (Inherited from TargetWithContext)
	ForceLockingQueue	Gets or sets whether to use the locking queue, instead of a lock-free concurrent queue The locking queue is less concurrent when many logger threads, but reduces memory allocation (Inherited from AsyncTaskTarget)
	IncludeCallSite	Gets or sets a value indicating whether to include call site (class and method name) in the LogEventInfo (Inherited from TargetWithContext)
	IncludeCallSiteStackTrace	Gets or sets a value indicating whether to include source info (file name and line number) in the LogEventInfo (Inherited from TargetWithContext)
	IncludeEventProperties	Gets or sets the option to include all properties from the log events (Inherited from TargetWithContext)
	IncludeGdc	Gets or sets a value indicating whether to include contents of the GlobalDiagnosticsContext dictionary (Inherited from TargetWithContext)
	IncludeMdc	Obsolete. (Inherited from TargetWithContext)
	IncludeMdlc	Obsolete. (Inherited from TargetWithContext)
	IncludeNdc	Obsolete. (Inherited from TargetWithContext)
	IncludeNdlc	Obsolete. (Inherited from TargetWithContext)
	IncludeScopeNested	Gets or sets whether to include the contents of the ScopeContext nested-state-stack. (Inherited from TargetWithContext)
	IncludeScopeProperties	Gets or sets whether to include the contents of the ScopeContext properties-dictionary. (Inherited from TargetWithContext)
	IsInitialized	Gets a value indicating whether the target has been initialized. (Inherited from Target)
	Layout	(Inherited from TargetWithContext)
	LayoutWithLock	Obsolete. NLog Layout are by default threadsafe, so multiple threads can be rendering logevents at the same time. This ensure high concurrency with no lock-congestion for the application-threads, especially when using AsyncTargetWrapper or AsyncTaskTarget. But if using custom Layout or LayoutRenderer that are not threadsafe, then this option can enabled to protect against thread-concurrency-issues. Allowing one to update to NLog 5.0 without having to fix custom/external layout-dependencies. (Inherited from Target)
	LoggingConfiguration	Gets the logging configuration this target is part of. (Inherited from Target)
	Name	Gets or sets the name of the target. (Inherited from Target)
	OptimizeBufferReuse	Obsolete. Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit (Inherited from Target)
	OverflowAction	Gets or sets the action to be taken when the lazy writer thread request queue count exceeds the set limit. (Inherited from AsyncTaskTarget)
	QueueLimit	Gets or sets the limit on the number of requests in the lazy writer thread request queue. (Inherited from AsyncTaskTarget)
	RetryCount	How many attempts to retry the same Task, before it is aborted (Inherited from AsyncTaskTarget)
	RetryDelayMilliseconds	How many milliseconds to wait before next retry (will double with each retry) (Inherited from AsyncTaskTarget)
	Source	Gets or sets the subject of the message
	SyncRoot	Gets the object which can be used to synchronize asynchronous operations that must rely on the . (Inherited from Target)
	TablesUri	Gets or sets the Microsoft Azure connection string
	TaskDelayMilliseconds	How many milliseconds to delay the actual write operation to optimize for batching (Inherited from AsyncTaskTarget)
	TaskScheduler	Task Scheduler used for processing async Tasks (Inherited from AsyncTaskTarget)
	TaskTimeoutSeconds	How many seconds a Task is allowed to run before it is cancelled. (Inherited from AsyncTaskTarget)

Top

	Name	Description
	CaptureContextGdc	Takes snapshot of GlobalDiagnosticsContext for the LogEventInfo (Inherited from TargetWithContext)
	CaptureContextMdc	Obsolete. Takes snapshot of MappedDiagnosticsContext for the LogEventInfo (Inherited from TargetWithContext)
	CaptureContextMdlc	Obsolete. Takes snapshot of MappedDiagnosticsLogicalContext for the LogEventInfo (Inherited from TargetWithContext)
	CaptureContextNdc	Obsolete. Takes snapshot of NestedDiagnosticsContext for the LogEventInfo (Inherited from TargetWithContext)
	CaptureContextNdlc	Obsolete. Takes snapshot of NestedDiagnosticsLogicalContext for the LogEventInfo (Inherited from TargetWithContext)
	CaptureScopeContextNested	Takes snapshot of nested states from ScopeContext for the LogEventInfo (Inherited from TargetWithContext)
	CaptureScopeContextProperties	Takes snapshot of ScopeContext dictionary for the LogEventInfo (Inherited from TargetWithContext)
	CloseTarget	Closes Target by updating CancellationToken (Inherited from AsyncTaskTarget)
	Dispose	Closes the target. (Inherited from Target)
	Dispose(Boolean)	Releases any managed resources (Inherited from AsyncTaskTarget)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	Flush	Flush any pending log messages (in case of asynchronous targets). (Inherited from Target)
	FlushAsync	Schedules notification of when all messages has been written (Inherited from AsyncTaskTarget)
	GenerateUniqueItemName	Generates a new unique name, when duplicate names are detected (Inherited from TargetWithContext)
	GetAllProperties(LogEventInfo)	Creates combined dictionary of all configured properties for logEvent (Inherited from TargetWithContext)
	GetAllProperties(LogEventInfo, IDictionaryString, Object)	Creates combined dictionary of all configured properties for logEvent (Inherited from TargetWithContext)
	GetContextMdc	Obsolete. Returns the captured snapshot of MappedDiagnosticsContext for the LogEventInfo (Inherited from TargetWithContext)
	GetContextMdlc	Obsolete. Returns the captured snapshot of MappedDiagnosticsLogicalContext for the LogEventInfo (Inherited from TargetWithContext)
	GetContextNdc	Obsolete. Returns the captured snapshot of NestedDiagnosticsContext for the LogEventInfo (Inherited from TargetWithContext)
	GetContextNdlc	Obsolete. Returns the captured snapshot of NestedDiagnosticsLogicalContext for the LogEventInfo (Inherited from TargetWithContext)
	GetContextProperties(LogEventInfo)	Checks if any context properties, and if any returns them as a single dictionary (Inherited from TargetWithContext)
	GetContextProperties(LogEventInfo, IDictionaryString, Object)	Checks if any context properties, and if any returns them as a single dictionary (Inherited from TargetWithContext)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetScopeContextNested	Returns the captured snapshot of nested states from ScopeContext for the LogEventInfo (Inherited from TargetWithContext)
	GetScopeContextProperties	Returns the captured snapshot of ScopeContext dictionary for the LogEventInfo (Inherited from TargetWithContext)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InitializeTarget	(Inherited from AsyncTaskTarget)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MergeEventProperties	Obsolete. Merges (copies) the event context properties from any event info object stored in parameters of the given event info object. (Inherited from Target)
	PrecalculateVolatileLayouts	Calls the Precalculate(LogEventInfo) on each volatile layout used by this target. This method won't prerender if all layouts in this target are thread-agnostic. (Inherited from Target)
	RenderLogEvent(Layout, LogEventInfo)	Renders the logevent into a string-result using the provided layout (Inherited from Target)
	RenderLogEvent``1(LayoutUMP, LogEventInfo, UMP)	Renders the logevent into a result-value by using the provided layout (Inherited from Target)
	ResolveService``1	Resolve from DI ServiceRepository (Inherited from Target)
	RetryFailedAsyncTask	Handle cleanup after failed write operation (Inherited from AsyncTaskTarget)
	SerializeItemValue	Take snapshot of a single object value (Inherited from TargetWithContext)
	SerializeMdcItem	Obsolete. Take snapshot of a single object value from MappedDiagnosticsContext (Inherited from TargetWithContext)
	SerializeMdlcItem	Obsolete. Take snapshot of a single object value from MappedDiagnosticsLogicalContext (Inherited from TargetWithContext)
	SerializeNdcItem	Obsolete. Take snapshot of a single object value from NestedDiagnosticsContext (Inherited from TargetWithContext)
	SerializeNdlcItem	Obsolete. Take snapshot of a single object value from NestedDiagnosticsLogicalContext (Inherited from TargetWithContext)
	SerializeScopeContextNestedState	Take snapshot of a single object value from ScopeContext nested states (Inherited from TargetWithContext)
	SerializeScopeContextProperty	Take snapshot of a single object value from ScopeContext dictionary (Inherited from TargetWithContext)
	ShouldIncludeProperties	Check if logevent has properties (or context properties) (Inherited from TargetWithContext)
	ToString	(Inherited from Target)
	Write(AsyncLogEventInfo)	(Inherited from AsyncTaskTarget)
	Write(IListAsyncLogEventInfo)	Block for override. Instead override WriteAsyncTask(IListLogEventInfo, CancellationToken) (Inherited from AsyncTaskTarget)
	Write(LogEventInfo)	Block for override. Instead override WriteAsyncTask(LogEventInfo, CancellationToken) (Inherited from AsyncTaskTarget)
	WriteAsyncLogEvent	Writes the log to the target. (Inherited from Target)
	WriteAsyncLogEvents(AsyncLogEventInfo)	Writes the array of log events. (Inherited from Target)
	WriteAsyncLogEvents(IListAsyncLogEventInfo)	Writes the array of log events. (Inherited from Target)
	WriteAsyncTask(IListLogEventInfo, CancellationToken)	Override this to provide async task for writing a batch of logevents. (Inherited from AsyncTaskTarget)
	WriteAsyncTask(LogEventInfo, CancellationToken)	Override this to provide async task for writing a single logevent. Example Example of how to override this method, and call custom async method C# Copy protected override Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token) { return CustomWriteAsync(logEvent, token); } private async Task CustomWriteAsync(LogEventInfo logEvent, CancellationToken token) { await MyLogMethodAsync(logEvent, token).ConfigureAwait(false); } (Overrides AsyncTaskTarget.WriteAsyncTask(LogEventInfo, CancellationToken))
	WriteAsyncThreadSafe(AsyncLogEventInfo)	Write to queue without locking SyncRoot (Inherited from AsyncTaskTarget)
	WriteAsyncThreadSafe(IListAsyncLogEventInfo)	Block for override. Instead override WriteAsyncTask(IListLogEventInfo, CancellationToken) (Inherited from AsyncTaskTarget)
	WriteFailedNotInitialized	LogEvent is written to target, but target failed to successfully initialize Enqueue logevent for later processing when target failed to initialize because of unresolved service dependency. (Inherited from AsyncTaskTarget)

Top

	Name	Description
	AccountKeyConfigurationSettingName	Gets the configuration setting name used to get the Azure storage account key
	AccountNameConfigurationSettingName	Gets the configuration setting name used to get the Azure storage account Name
	TablesUriConfigurationSettingName	Gets the configuration setting name used to get the Azure storage account Name

Top

For best security, use an ISecretProvider (such as the KeyVaultSecretProvider to hold the connection string rather than putting it in configuration files.

If you don't want to use a secret provider, the log target can use the configured IConfiguration provider to obtain the Azure storage connection string. In that case, put the storage connection string in your appSettings.json file in the azureTableTarget:connectionString value:

C#

Copy

{
   "azureTableTarget": {
      "connectionString": "super secret connection string"
   }
}

You can also put the connection string in your nLog.config file. Here is the typical nLog.config for this target:

C#

Copy

<target xsi:type="AzureTableTarget"
    name = "azureTable"
    applicationName = "Logging.Test"
    baseTableName = "NLogUnitTest"
    connectionString = "super secret connection string"
/>

Reference

InnerDrive.Logging Namespace