Feature Request Need to exclude a method from the console stack trace

We wrote our own custom logger which is a wrapper for Debug.Log() and we currently have to use it in a .dll form so that the wrapper itself does not appear in the console stack trace. This is so that when we double-click on a console log we are taken directly to the proper script/line instead of landing in the logger code itself.

Which is kind of a hack.

What we would need instead is a custom method attribute called (for example) "HideInStackTrace" in order to simply exclude a method from the console stack trace.

Needless to say, double-clicking on the log itself would send the user to the script/line that called the method (not the "hidden" method itself).

Something like this:

Code (csharp):

1. [HideInStackTrace]
2. public void MyCustomLogger(string _message)
3.     {
4.     ...
5.     }

(By the way, we do know about the callback to catch when something is logged (https://forum.unity.com/threads/excluding-a-method-frame-from-stack-trace-in-debug-log.259638/) but that doesn't give us what we need as this only gets us the log content but has no effects on what the console actually shows)

 

I was looking for something like this and it turned out this feature was already present in the asset I've been using for 2+ years already xD. It's the Editor Console Pro asset: https://assetstore.unity.com/packages/tools/utilities/editor-console-pro-11889. Just checked, and the feature works!

Clearly, it only works for the editor though, so if you want something like that in custom log files then you'd need to register a custom callback for `Application.logMessageReceived`, but I've never tried that myself.

EDIT: also see https://answers.unity.com/questions...912.2118931545.1640108494-59164945.1639945624

 

This would be really helpful for me, because I use/make C# libraries that might have a dependency on NLog for example.
If I want the library to work in my Unity project, I can write a custom target to output to the UnityEngine.Debug.LogXXX methods, but it has all these NLog methods in the stacktrace that I don't care about.

However, there might be hope coming soon for this feature in a year or two?
I found this on Unity's Editor roadmap, under the "Under Consideration" section at the time of writing today:


EDIT: I also found it on their Engineering roadmap too.

 

[StackTraceHidden] was made public in .NET 6 (actually this existed before, but internal), so when Unity upgrade to it (which could take a while), it should come for free...

 

Ooh, thanks for sharing!
This is very helpful and the docs page is great with the explanation and code example.

The only thing is I wish it could take in a bool to also apply its effect to any methods called recursively underneath the method that I mark as [HideInCallstack].

For example, if I'm calling into some logging class I made, which calls NLog, I can apply [HideInCallstack] to my logging method, but I'll still see all the details of NLog's method calls that I don't want to see. Maybe a bool recursive parameter or something, where I could write [HideInCallstack(recursive: true)] would solve this

 

The only thing is that I wish it could accept a bool so that it would also affect any recursively called methods below the method I mark as [HideInCallstack].

backrooms game
​

 

That's cool, although I wish you'd used the standard one instead. Such attributes can usually be redeclared without conflict (like we used to inject ExtensionMethodAttribute in old .NET versions).

 

Great stuff, can it be included into LTS versions?

 

Good one, but can it be added to LTS versions? The same question like the guy above.

backrooms​

 

Same question. It would be great to have this in 2021 LTS.

 

This is handy, but is there a way to have this also so when you double click on the entry in the console, it doesn't take you to that method if it had [HideInCallstackAttribute]. We are usually using this for debugging with custom print methods, so its not useful for the double click in the console to open up the Hidden print method.

 

That attribute doesn't work for me, if implemented exactly as the example given in the APi doc. What gives?

Neither the callstack is filtered, nor does double-click take me to the highest expected point in the callstack, it takes me to the very debug log line.

(2022.2.18f1)

 

Yup, broken for me as well (2022.2.16f1)

 

Don't forget to enable call stack stripping in the console options. Seems to work as of 2022.2.21.

For usability this feature should absolutely bring you to the correct line in editor when double-clicking. Seems to me than everyone looking for this feature is being a bit deceived.

 

I'm puzzled, I have 2021.3.21f but no sign of [HideInCallstackAttribute], the API docs says it should exist but nothing on the UnityEngine namespace??

 

I highly suspect it was added only very recently to the 2021.3 LTS version, as I remember the docs showing it was 2022+ only for a while.

 

Maybe just a docs slip up, thanks for confirming.

 

It does not help at all.

Once I set the Strip Logging Callstack option in the Console menu it no longer APPEARS in the text.

But double clicking the log entry still takes me to the function annotated as hidden!

 

Booo! I also want double click on log entry ignore method with [HideInCallstack].

 

My replacement console has something like this. You exclude wrapper methods by right-clicking on them (in the callstack) and marking them as wrappers. Then when you double-click the main entry, it takes you to the correct place.

 

Just tried it owning the asset for sometimes now, it works perfectly and its non intrusive ... best solution IMO.

 

It doesn't even work for exception stack traces :/
I use an extension method for preserving stack trace when doing an exception rethrow (

ExceptionDispatchInfo.Capture(e.InnerException ?? e).Throw();

) which I don't want to show in the callstack.

 

would love to get the method ignored when double clicking.
We also have some custom logging methods and opening these when double clicking in the Editor is just painful.
We need to navigate to the root custom log call

 

It's a great start but 50% of it's purpose is missing making it useless as a whole.
When you double click the log entry it should also respect the modified stacktrace. Now, you get stripped stacktrace but double-clicking the log entry it takes you to the hidden method call.
Is it a bug or by design?

 

I'm also looking for a solution for this. I want to redirect a console click to different location away from a wrapper method.