Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A portable logging abstraction for .NET
C# Other
Failed to load latest commit information.
doc Fix typo in ConsoleOutLoggerFactoryAdapter declarative config example
examples fixing error in example due to re-introduction of Common.Logging.Core
lib add missing NLog binaries to /lib/ folder
nuget-graphics graphics updates
package-nuget applying version-specific suffixes to all adapter assys and nuget pac…
packages/Microsoft.ApplicationInsights.0.17.0 add ApplicationInsights packages
src remove errant commit of xml comment file
test Merge branch 'master' of https://github.com/tdupont750/common-logging
tools Added support for EntLib 6.0
.gitignore update ignore list to include NLog 32 and 40 xml comment files
Common.Logging.2010-net20.sln remove inadvertent adding of ApplicationInsights adapter to Net 2.0 s…
Common.Logging.2010-net20.sln.GhostDoc.xml GhostDoc settings
Common.Logging.2010.sln adding NLog40 projects into proper solution folder
Common.Logging.2010.sln.GhostDoc.xml adding GhostDoc config files
Common.Logging.2013.sln rename projects, add to VS 2013 solution, adjust BUILD output dirs
Common.Logging.2013.sln.GhostDoc.xml adding GhostDoc config files
Common.Logging.build fix property overwrite bug in arg for covered ass'y name
Common.Logging.ndoc fixing nant refs to correct ziplib binary for packaging step
appveyor.yml wire up post-build script to post test-results to Appveyor dashboard
build-ci.cmd Revert "setting ci build script to only compile as CI box will scan a…
build-dev.cmd chain build*.cmd files to call thru to same build.cmd
build-package.cmd chain build*.cmd files to call thru to same build.cmd
build-release.cmd updating build script to set for v3.2.0
build.cmd chain build*.cmd files to call thru to same build.cmd
changelog.txt adjust explanation of PCL support strategy in notes for 3.0.0
license.txt add top level readme and license file. Remove similar in subdirs
readme.md Add Application Insights documentation section
release-checklist.txt fixed missing tools folder for release

readme.md

Common.Logging .NET

Project Build Status

Build status

Introduction

Provides a simple logging abstraction to switch between different logging implementations. There is current support for log4net, NLog and Enterprise Library logging.

Additionally Common.Logging comes with a set of base classes making the integration of any log system a breeze.

See also

Console Quickstart

This demonstrates how to configure your app to log using the built in Common.Logging console adapter.

1) Install Common.Logging via NuGet

Either open the Package Management Console and enter the following or use the built-in GUI

NuGet: PM> Install-Package Common.Logging

2) Register and configure Common.Logging

Then add the relevant sections to your app.config or web.config:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>

  <configSections>
    <sectionGroup name="common">
      <section name="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" />
    </sectionGroup>
  </configSections>

  <common>
    <logging>
      <factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging">
        <arg key="level" value="INFO" />
        <arg key="showLogName" value="true" />
        <arg key="showDateTime" value="true" />
        <arg key="dateTimeFormat" value="yyyy/MM/dd HH:mm:ss:fff" />
      </factoryAdapter>
    </logging>
  </common>

</configuration>

NLog Quickstart

There are different packages for each major NLog version. Install the correct package for your referenced NLog version. This example installs the adapter for NLog v2.0:

PM> Install-Package Common.Logging.NLog20

If you are using NLog v3.0, you should install the Common.Logging.NLog30 package and so on.

The app config should then have a common logging section like below. Be sure to match the factoryAdapter type with your installed Common.Logging.NLogXX version.

<common>
    <logging>
      <factoryAdapter type="Common.Logging.NLog.NLogLoggerFactoryAdapter, Common.Logging.NLog20">
        <arg key="configType" value="INLINE" />
      </factoryAdapter>
    </logging>
</common>

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
...
</nlog>

Application Insights Quickstart

There are different packages for each major Application Insights version. Install the correct package for your referenced Application Insights version. This example installs the adapter for Application Insights v0.17:

PM> Install-Package Microsoft.ApplicationInsights -Version 0.17.0

The app config should then have an Application Insights section like below. Be sure to set the InstrumentationKey with your InstrumentationKey retrieved from Application Insights portal https://portal.azure.com.

<common>
    <logging>
      <factoryAdapter type="Common.Logging.ApplicationInsights.ApplicationInsightsLoggerFactoryAdapter, Common.Logging.ApplicationInsights">
        <arg key="InstrumentationKey" value="[YOUR APPLICATION INSIGHTS INSTRUMENTATION KEY]" />
      </factoryAdapter>
    </logging>
</common>

See module documentation and Source Forge for other factoryAdapters and their configuration values

Solution Layout

  • bin contains the Common.Logging distribution dll files
  • doc contains reference documentation.
  • shared contains shared nant build scripts
  • modules contains the sourcecode for Common.Logging.XXXX modules
  • redist contains redistributable assemblies like log4net for your convenience

The Common Infrastructure Libraries for .NET are released under the terms of the Apache Software License (see license.txt).

Building

  • Clone the GitHub repository
  • Install Silverlight SDK 5
  • [Optional] Install Java for the documenation builder
  • Create a strong name key. c:\netcommon>sn -k common.net.snk
  • Build the the solution. c:\netcommon>build-release.cmd
Something went wrong with that request. Please try again.