So I've done a lot of research on this and haven't found any answers where I said, "yes, THAT". I'm hoping the ever-erudite StackOverflow crowd can help me out.
I've run into this issue in a couple of different scenarios. Say I have a C# app, and there are important things that I want to log.
public class MyClass
{
...
public void ImportantMethod()
{
DoInterestingThing();
var result = SomethingElseImportant();
if (result == null)
{
logger.Log("I wasn't expecting that. No biggie.");
return;
}
MoreInterestingStuff();
}
The thing I'm interested in is where do I get logger
from.
As I see it I have a few options.
None of these seem like great options. #3 looks to be impossible since I'm logging right in the middle of my business logic and not just doing a simple trace of my method calls, input parameters and/or exceptions thrown. #2, though simple seems like it would be really difficult to unit test. Of course, I would want to unit test everything. #1, though it would work fine, clutters up all my business logic with logging objects that have nothing to do with the business objects themselves.
Any alternative ideas, or thoughts on one of the options above? Much thanks!
EDIT: just to be clear, I already know how to do DI (I use Unity), and I already know a good logging framework (I use log4net). Just wondering a how to use logging in an architecture sense across an application in the smartest way.
* EDIT *
I marked Mark Seeman's answer as the solution. I went through my application and found that most of my logging calls were doing the same thing a decorator could do. Namely, log the entry to the method, any exceptions thrown, and exit return values.
Some cases I still needed to log directly inside a method. An example would be where I want to fail fast in a method which doesn't return anything but not throw an Exception. In those cases I have a singleton which holds a reference a LogProvider
which will in turn retrieve a named log instance. The code looks similar to this:
private ILog logger = LogProviderFactory.Instance.GetLogger(typeof(Foo));
LogProviderFactory has a method SetProvider
which allows you to swap out the singleton. So in unit testing I can do:
// LogProviderFactory.Instance now is our mock
LogProviderFactory.SetProvider(MockLogProvider);
The logging decorator uses the same LogProvider as the singleton (which it obtains through injection), so logging is unified throughout the system.
So really the end solution was mostly option #3, and a hybrid #2 (where it's the service locator pattern but the service is 'injected' into the locator).
AOP
As far as "aspect oriented programming" goes, I was a bit disappointed in the limitations of the language. Hoping AOP will be treated as a first-class citizen in future releases.
Join the DZone community and get the full member experience. Logging architecture is an important part of application health and performance monitoring in the modern distributed application architecture world.
Application developers tend to rely on application logging to troubleshoot and diagnose a variety of issues. The application logs do not tell the whole story as to why something went wrong or to determine the cause. There are a wide variety of logging solutions that scatter various files across a server.
Here is a list of 5 best application logging practices one must be aware of: A logging framework is a tool that helps you standardize the logging process in your application. A third-party tool, such as log4net or log4j, can help with this.
A logging framework is a tool that helps you standardize the logging process in your application. A third-party tool, such as log4net or log4j, can help with this. To be more explicit, a logging system may be imagined as encompassing three key concerns: recording, formatting, and adding.
Use a logging Decorator.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With