Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Logging in C#: Getting the class/method name performance

Tags:

c#

logging

I've recently been tasked with adding logging statements to every method call in a solution. These log entries need to contain the class and method name.

I know I can use MethodBase.GetCurrentMethod() and the StackFrame.GetMethod() methods. Which is better? Is there a better (or more performant) way to get the class and method name?

like image 397
Zachary Yates Avatar asked Aug 25 '10 16:08

Zachary Yates


2 Answers

Well, the best/fastest way is to include a string in every function. That may not appear the most practical solution, but MethodBase.GetCurrentMethod() requires coding inside every method that using it anyway. i.e. You can write

string funcName = "MyClass.MyFunction(int, int)";

or you can write

string funcName = MethodBase.GetCurrentMethod().Name

Now, if you want to get the Name of the function that called the current function (i.e., you want to do this in one spot in your logging function), then your only option is reading through the StackFrame.

like image 72
James Curran Avatar answered Oct 22 '22 08:10

James Curran


I have two suggestions:

  1. Use ready-made AOP frameworks (like http://www.sharpcrafters.com/ ) they can handle this easily
  2. Do a custom prebuild action where you replace some kind of stub in the beginning of every method:

    void PerformSomeAction() { //PUT_LOGGING_HERE }

then in custom tool replace those stubs with method names. This is guaranteed fastest method, but requires some investments.

like image 39
Andrey Avatar answered Oct 22 '22 08:10

Andrey