index.html

---
layout: default
---
<section class="content">
    <section>
        <h1 class="page-header" id="welcome">
            Welcome to NLog!
        </h1>
        <p class="lead">
            NLog is a flexible and free logging platform for various .NET platforms, including .NET standard.

            NLog makes it easy to write to several <a href="{{ site.baseurl }}/config/?tab=targets">targets</a>. (console, file, database, etc.) and change the logging configuration on-the-fly.
        </p>
      
        <p>
            NLog supports both <a href="https://github.com/NLog/NLog/wiki/How-to-use-structured-logging">structured</a>
            and traditional logging.
        </p>

        <p>
            The focus for NLog: high performance, easy-to-use, easy to extend and flexible to configure. 
        </p>
    </section>
    <section>
        <h1 class="page-header" id="features">Features</h1>
        <div id="features-list">
            <div class="row">
                <div class="col-sm-4">
                    <h4>Easy to configure</h4>
                    <p>
                        NLog is very easy to configure, both through <a href="https://github.com/nlog/NLog/wiki/Configuration-file">configuration file</a>
                        and <a href="https://github.com/NLog/NLog/wiki/Configure-from-code">programmatically</a>.
                        Even without restarting the application, the configuration can be changed.
                    </p>
                </div>
                <div class="col-sm-4">
                    <h4>Output formats</h4>
                    <p>
                        NLog Layouts are available for several output formats like
                        <a href="https://github.com/NLog/NLog/wiki/SimpleLayout">Simple Text</a>,
                        <a href="https://github.com/NLog/NLog/wiki/JsonLayout">JSON</a>,
                        <a href="https://github.com/NLog/NLog/wiki/XmlLayout">XML</a>,
                        <a href="https://github.com/NLog/NLog/wiki/CsvLayout">CSV</a> etc.,
                        The logging output can be enriched with additional context details using <a href="{{ site.baseurl }}/config/?tab=layout-renderers">layout renders</a>.
                    </p>
                </div>
                <div class="col-sm-4">
                    <h4>Extensible</h4>
                    <p>
                        NLog already includes several targets and pre-defined layouts, but you can also extend
                        with your own <a href="https://github.com/NLog/NLog/wiki/Extending-NLog">custom targets and layouts</a>
                        or include own <a href="https://github.com/NLog/NLog/wiki/Context">custom context values</a>
                    </p>
                </div>
            </div>
            <div class="row">
                <div class="col-sm-4">
                    <h4>Structured logging</h4>
                    <p>
                        Full support for <a href="https://github.com/NLog/NLog/wiki/How-to-use-structured-logging"> structured logging</a> and
                        handles both message-templates and custom logevent properties.
                    </p>
                </div>
                <div class="col-sm-4">
                    <h4>Microsoft Extension Logging</h4>
                    <p>
                        NLog can be fully integrated with <a href="https://github.com/NLog/NLog.Extensions.Logging/wiki">Microsoft Extensible Logging</a> (and ASP.NET Core), without it needing to replace the standard Microsoft LoggerFactory.
                        NLog automatically captures <a href="https://github.com/NLog/NLog.Extensions.Logging/wiki/NLog-properties-with-Microsoft-Extension-Logging">LogEvent properties</a> and can use them in structured logging target output.
                    </p>
                </div>
                <div class="col-sm-4">
                    <h4>appsettings.json</h4>
                    <p>
                        NLog configuration can be loaded from <a href="https://github.com/NLog/NLog.Extensions.Logging/wiki/NLog-configuration-with-appsettings.json">appsettings.json</a>
                        as an alternative to the <a href="https://github.com/NLog/NLog/wiki/Tutorial">NLog.config</a> XML file. It is also possible
                        to configure NLog targets using values from appsettings.json with <a href="https://github.com/NLog/NLog/wiki/ConfigSetting-Layout-Renderer">${configsetting}</a>
                    </p>
                </div>

            </div>
        </div>
    </section>
    <section>
        <h1 class="page-header" id="targets">Targets</h1>
        <p class="lead">
            NLog Targets handles the writing of log events to their destination, after having formatted the LogEvent using the configured NLog Layout.
            NLog supports sending the same LogEvent to multiple destination targets, and each target can have their own unique output format.
        </p>
        <p>There are more than 20 targets provided out-of-the-box, including:</p>
        <div id="targets-list">
            <div class="row">
                <div class="col-sm-4">
                    <h4>
                        <i class="fa fa-file fa-fw"></i>
                        Files
                    </h4>
                    Write logs to any number of files, 
                    with <a href="https://github.com/nlog/NLog/wiki/File-target">automatic file naming and archival</a>.
                </div>
                <div class="col-sm-4">
                    <h4>
                        <i class="fa fa-warning fa-fw"></i>
                        Event Log
                    </h4> Write to event log <a href="https://github.com/nlog/NLog/wiki/EventLog-target">local or remote</a>
                </div>
                <div class="col-sm-4">
                    <h4>
                        <i class="fa fa-database fa-fw"></i>
                        Database
                    </h4>
                    Store your logs in <a href="https://github.com/nlog/NLog/wiki/Database-target">databases</a> supported by .NET
                </div>
            </div>
            <div class="row">
                <div class="col-sm-4">
                    <h4>
                        <i class="fa fa-terminal fa-fw"></i>
                        Console
                    </h4>
                    Write real-time to the command-line console
                    including <a href="https://github.com/nlog/NLog/wiki/ColoredConsole-target">color coding</a> of messages
                </div>
                <div class="col-sm-4">
                    <h4><i class="fa fa-envelope fa-fw"></i> E-mail</h4>
                    You can send <a href="https://github.com/nlog/NLog/wiki/Mail-target">emails</a> whenever application errors occur
                </div>
                <div class="col-sm-4">
                    <h4> <i class="fa fa-file-o fa-fw"></i>
                        Debugger output
                    </h4>
                    Write to the <a href="https://github.com/NLog/NLog/wiki/Debugger-target">Debugger</a> Output Window, when debugging the application.
                </div>
            </div>
        </div>
        <p id="targets-after">
            There are also <a href="https://github.com/nlog/nlog/wiki/Targets#user-content-wrapper-targets">wrapper targets</a> which provide
            <a href="https://github.com/nlog/NLog/wiki/BufferingWrapper-target">buffering</a>,
            <a href="https://github.com/nlog/NLog/wiki/RoundRobinGroup-target">load balancing</a>,
            <a href="https://github.com/nlog/NLog/wiki/FallbackGroup-target">failover situations</a>,
            <a href="https://github.com/nlog/NLog/wiki/AsyncWrapper-target">asynchronous writing</a> and many more scenarios.

            The full list of targets is available on the <a href="{{ site.baseurl }}/config/?tab=targets">config options page</a>.
            If you didn't find the target to fit your needs, you can
            <a href="https://github.com/NLog/NLog/wiki/Extending-NLog">easily extend NLog with a custom target</a>.

        </p>
    </section>
      <section>
        <h1 class="page-header" id="support">Support</h1>
        <div>
            NLog supports the following platforms:
            <ul>
                <li>.NET 6, 7, 8, 9 &amp; 10 (.NET Standard)</li>
                <li>.NET Framework 3.5 - 4.8</li>
                <li>.NET Core 2.0 - 3.1 (.NET Standard)</li>
                <li>MAUI (.NET Standard)</li>
                <li>UWP (.NET Standard)</li>
                <li>Xamarin Android + iOS (.NET Standard)</li>
                <li>Mono 4</li>
                <li>ASP.NET Core (NLog.Web.AspNetCore package)</li>
                <li>ASP.NET Classic (NLog.Web package)</li>
            </ul>
          </div>
    </section>
     
    
    <section>
        <h1 class="page-header" id="license">License</h1>
        <p>
            The source code is available under the terms of <a href="https://github.com/NLog/NLog/blob/master/LICENSE.txt">BSD license</a>.
        </p>
    </section>
</section>
<script>
    $(function () {
        // Highlight the nav link.
        $('#homeNavItem').addClass("active");
    });
</script>