README.md

NLog.Appsettings.Standard

An NLog layout renderer be used to access appsettings.json and supported .NET Standard 1.6/2.0.

Attention

The older package NLog.Appsetting.Standard is no longer updated and maintained. It is recommended to be replaced this new version.

How To Use

Install the NLog.Appsettings.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.Appsettings.Standard" />
    </extensions>
</nlog>

Configuration Syntax & Parameters

The name of layout renderer is appsettings, and syntax is ${appsettings: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"
    }
}

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

Set Explicit Configuration

In some cases, the library may not work correctly (e.g., always access incorrect appsettings.json). You can set the configuration directly by use the global property AppSettings before you start logging work as follows

using NLog.Appsettings.Standard;

..........

AppSettingsLayoutRenderer.AppSettings = new ConfigurationBuilder().SetBasePath(Directory.GetCurrentDirectory())
                                            .AddJsonFile("appsettings.json").AddJsonFile($"appsettings.Development.json", optional: true)
                                            .Build();
..........

Test App

NLog.Appsettings.Standard.Test is a console program that is preconfigured to use the appsettings layout renderer. It is a good sample that you can follow.

Note

If you need other NLog extensions(Target or Layout Renderer) that built by me or prefer all in one like me. You can refer this and its document!!!

Reference

NLog.Extended by NLog