NLog.Extended.Standard 1.0.0

Implement the custom NLog target and layout renderers with .NET Standard 2.0.

Now Available Features

Targets

• AzureAppendBlob - Append log to Azure storage blobs

Layout Renderers(Layouts)

• appsetting - Access configuration in appsettings.json (or appsettings.<EnvironmentName>.json) file

How To Use

Install the NLog.Extended.Standard package from NuGet. You need add NLog 4.5 or higher, then put the syntax in your NLog configuration below:

<nlog>
    <extensions>
        <add assembly="NLog.Extended.Standard" />
    </extensions>
</nlog>

AzureAppendBlob target configuration

The target's type name is AzureAppendBlob.

• connectionString - (layout)The connection string for the storage account to use. To Retrieve this at Azure Portal.
• container - (layout)The name of the blob container where logs will be placed. Will be created when it does not exist.
• blobName - (layout)Name of the blob to write to. Will be created when it does not exist.
• layout - (layout)Content text to write.

Example:

<targets async="true">
    <target xsi:type="AzureAppendBlob" 
            name="Azure" 
            layout="${longdate} ${uppercase:${level}} - ${message}" 
            connectionString="YourConnectionString" 
            container="YourContainer" 
            blobName="logs/${shortdate}.log" />
</targets>
<rules>
    <logger name="*" minlevel="Trace" writeTo="Azure"/>
</rules>

You can see NLog Wiki for more information about configuring NLog.

Note:

If you only need AzureAppendBlob target, check this.

Appsetting layout renderer configuration

The layout renderer's name is appsetting.

Configuration Syntax & Parameters

${appsetting:name=String.String2.String3:default=String}

• name - Key in your appsettings.<EnvironmentName>.json file. If it has a multi-level hierarchy that you want to access, you can separate by a dot. Required.
• default - Default value if not present. Optional.

Example:

Target appsettings.json

{
    "Mode":"Prod",
    "Options":{
        "StorageConnectionString":"abcdefg123456789",
        "Container":"YourProdContainer"
    }
}

• ${appsetting:name=Mode} - Get "Prod" in this case.
• ${appsetting:name=Options.StorageConnectionString} - Get "abcdefg123456789" in this case.
• ${appsetting:name=Options.StorageConnectionString2:default=DefaultString} - Get "DefaultString" in this case.