CODEWITHSUNDEEP
c#inheritancenlog
Bobby B
Bobby B

Reputation: 2402

C# derived class type needed in base for logging using NLog

We're using NLog for logging in an C# MVC3 web application. All of our controllers extend a custom base "ApplicationController" that gives us access to a constantly needed methodes and s members.

I'd like all controllers to have access to the Logger via this base class, but want the detail of knowing what derived class the log statements originated in.

Our application controller looks like this:

public abstract class ApplicationController : Controller
{
    protected Logger _logger;
    protected virtual Logger Logger
    {
        get { return _logger ?? (_logger = LogManager.GetCurrentClassLogger()); }
    }

    protected ApplicationController()
    {
        Context = new Entities();
    }

If a derived controller doesn't override the Logger than all statements will show they originated from the Application controller. Currently, I've got essentially the same Logger statement in all derived controllers. For example:

public class PropertyController : ApplicationController
{
    private readonly DatatapeService _datatapeService;
    private readonly PropertyService _propertyService;
    protected override Logger Logger
    {
        get { return _logger ?? (_logger = LogManager.GetCurrentClassLogger()); }
    }

Obviously this is poor implementation practice.

  1. How can I dry this up? Specifically, what is my understanding of C# lacking to accomplish exactly this specific task?
  2. Is there a logging pattern that I should be following where I'm not exposing the logging class (NLog) directly?

TIA!

Upvotes: 13

Views: 9291

Answers (4)

Holistic Developer
Holistic Developer

Reputation: 2526

The How to create Logger for sub classes page of the NLog wiki now suggests the following pattern:

class BaseClass
{
    protected BaseClass()
    {
        Log = LogManager.GetLogger(GetType().ToString());
    }

    protected Logger Log { get; private set; }
}

class ExactClass : BaseClass
{
    public ExactClass() : base() { }
    ...
}

Upvotes: 3

Sebastian Slutzky
Sebastian Slutzky

Reputation: 379

NLog API is slightly different than Log4net. You need to use

Logger = LogManager.GetLogger(GetType().Name);

if you only pass the type, LogManager will expect a logger type (i.e. a custom logger)

Upvotes: 6

Dr. Andrew Burnett-Thompson
Dr. Andrew Burnett-Thompson

Reputation: 21521

I am unfamiliar with NLog but in Log4Net the syntax LogManager.GetLogger(this.GetType()) will accomplish what you want. GetTypereturns the leaf type in your inheritance hierarchy, even if called in the base ApplicationController class, when the logger is first created (ie: on first access to the Logger property) it will instantiate it with type PropertyController

Upvotes: 16

Anand
Anand

Reputation: 14915

Just check nLog wiki here

In most cases you will have one logger per class, so it makes sense to give logger the same name as the current class.

Makes sense to do it like this

public abstract class ApplicationController : Controller
{
    protected Logger _logger;
    protected virtual Logger Logger(string className)
    {
       return LogManager.GetLogger(className);
    }
}


public class PropertyController : ApplicationController
{
    private readonly DatatapeService _datatapeService;
    private readonly PropertyService _propertyService;
    protected override Logger Logger()
    {
        return base.Logger("PropertyController ");
    }
}

Upvotes: -1

Related Questions