Skip to content

Latest commit

 

History

History
159 lines (107 loc) · 11.3 KB

README.md

File metadata and controls

159 lines (107 loc) · 11.3 KB
Raw

NLog

Vote or submit ideas on UserEcho!

=== Join the chat at https://gitter.im/NLog/NLog Twitter Last News NuGet downloads codecov.io

NLog is a free logging platform for .NET with rich log routing and management capabilities. It makes it easy to produce and manage high-quality logs for your application regardless of its size or complexity.

It can process diagnostic messages emitted from any .NET language, augment them with contextual information, format them according to your preference and send them to one or more targets such as file or database.

For more information, see the website nlog-project.org or just get started with the tutorials on the NLog wiki.

Project news - including RSS feed

Packages & Status

NLog consists of multiple packages. Most of the functionality is inside the NLog (core) package. What's inside the packages? See targets and layout renderers overview!

Package | Build status | Nuget | -------- | :------------ | :------------ | :------------------ NLog (Windows / Xamarin) | AppVeyor | NuGet package | NLog (Mono) | Build Status | | NLog.Config | AppVeyor | NuGet package | NLog.Contrib.ActiveMQ | AppVeyor | NuGet package | NLog.Extended | AppVeyor | NuGet package | NLog.Elmah | AppVeyor | NuGet package | NLog.Etw | AppVeyor | NuGet package | NLog.InstallNLogConfig | AppVeyor | NuGet package | NLog.ManualFlush | AppVeyor | NuGet package | NLog.Schema | AppVeyor | NuGet package | NLog.Web | AppVeyor | NuGet package | NLog.Windows.Forms | AppVeyor | NuGet package |

Questions, bug reports or feature requests?

Do you have feature requests, questions or would you like to report a bug? Please post them on the issue list and follow these guidelines. Please also post or vote features requests on UserEcho.

Frequently Asked Questions (FAQ)

  • What is NLog?
  • NLog is a free and open source library which helps to write log messages.

  • Why should I use a log libary? I can just do file.WriteLine()

    • Beside writing to files, you can write to many different targets, like databases, event viewer, trace etc.
    • The output is templatable with many predefined template values.
    • With a simple configuration file you can decide runtime (after deployment), what to log and where! No need to restart the program or recyle the app pool!

  • Why should I use NLog?

    • NLog is fully written in C#, has many years of experience and is easy to extend!

  • Is it free?

    • It's licensed under the BSD license, so you can use it in commercial (closed sourse) programs without problems.

  • Show me the magic!

  • I can't see anything?!

  • I'm missing important stuff!

  • How do I upgrade to NLog 4.x?

    • Check the 4.0 release post, there are some breaking changes.
    • Update all the NLog packages. The latest stable version is recommend.
    • When upgrading from NLog 4.1.0, please the next question.

  • I have trouble updating NLog from 4.1.0

    • We take semver very serious! Because NLog is strong named, it's important to keep the assembly version of all major versions the same, otherwise every library build on 4.0.0 should be reompiled for every other 4.x release (4.1, 4.2 etc) - which is unwanted because of semver.
      In NLog 4.1.0 there was a mistake in the assembly version, which has been fixed in 4.1.1. Upgrading from NLog 4.1.0 to another version can give issues when using NuGet. This will result in the following error:

    Could not load file or assembly 'NLog' or one of its dependencies. The located assembly's manifest definition does not match the assembly reference. (Exception from HRESULT: 0x80131040)

    If you upgrade, remove or alter the <assemblybinding>, as explained at the 4.1.1 news post.

Contributing

As the current NLog team is a small team, we cannot fix every bug or implement every feature on our own. So contributions are really appreciated!

If you like to start with a small task, then up-for-grabs are nice to start with.

A good way to get started (flow)

  1. Fork the NLog repos.
  2. Create a new branch in you current repos from the 'master' branch.
  3. 'Check out' the code with Git or GitHub Desktop
  4. Check contributing.md
  5. push commits and create a Pull Request (PR) to NLog

License

NLog is open source software, licensed under the terms of BSD license. See LICENSE.txt for details.

How to build

Use Visual studio 2012/2013/2015 and open solution file in the 'src' folder, like 'NLog.netfx45.sln'

For building in the cloud we use:

  • AppVeyor for Windows builds, including Silverlight and Xamarin.
  • Travis for Mono builds.
  • CodeCov for code coverage

How to build your fork in the cloud

Steps to set up AppVeyor/Travis/CodeCov for your own fork.

AppVeyor:

  1. Login with your Github account to https://ci.appveyor.com
  2. Choose "projects"
  3. Select your fork and press "+" button
  4. Done. All config is in appveyor.yml already

Travis:

  1. Login with your Github account to https://travis-ci.org/
  2. Select your fork
  3. Push and wait

CodeCov: (AppVeyor needed)

  1. Login with your Github account to https://codecov.io/
  2. Press "+ Add new repository to Codecov" button
  3. Select your fork
  4. Wait for a build on AppVeyor. All the config is already in appveyor.yml. The first report can take some minutes after the first build.