Integrate spdlog #148
Integrate spdlog #148
Conversation
|
I gave some :D Many of them are bigger than just this commit. Want to get a better process and conventions nailed down. Whatever are the conclusions I can update |
baconpaul
force-pushed
the
logging-94
branch
from
0cc9f9e
to
09feb08
Compare
|
OK @jsakkine I figured out how to squash commits. That's really super duper handy. I also integrated all your comments except the typename. If you get a chance, another look would be appreciated! |
|
Looked into your update. Only one remark. What was your take on indentation BTW? |
I went to 4 spaces no tabs and set emacs to use Linux-style rather than gnu-style brace positioning which roughly matches what Xcode does by default too. I changed And I chose to not indent the first-level namespace. So Which was in the standard you circulated earlier. |
To allow us to have easy scalable logging available while developing and for error reporting and the like, I integrated spdlog. See issue surge-synthesizer#94 for further conversation on this decision. The logger initializes to write to stderr and a file (on linux and mac) both and registers a default logger at dll load time.
baconpaul
force-pushed
the
logging-94
branch
from
09feb08
to
c15b731
Compare
…anges. Restore this in a separate PR
| #include "spdlog/logger.h" | ||
| #include "spdlog/async.h" | ||
| #include <memory> | ||
| #include <filesystem.h> |
There was a problem hiding this comment.
should this be "filesystem.h" ?
| #if MAC | ||
| char lfb[ PATH_MAX ]; | ||
| sprintf(lfb, "%s/Library/Logs/Surge.log", getenv("HOME")); | ||
| auto fileSink = make_shared<spdlog::sinks::basic_file_sink_mt> (lfb); |
There was a problem hiding this comment.
Should this be opt-in instead of always on? Is the log always appended to - is there some auto-truncation size? What happens when multiple processes might be accessing the same log? Seems to me logging to the console by default is much preferred and opting in to dump to a log if necessary is a nicer default behavior. Just my 2c.
There was a problem hiding this comment.
If I had any idea at all what happened to stderr or stdout ejected from a plugin in logic, au lab, and hosting au, I would be fine to skip this. Do you know?
That said: SPD has an auto rotating log. I could use that. Or I could comment this section out and just leave it on in my development area inside an #ifdef log-to-file or some such.
There was a problem hiding this comment.
@baconpaul can you run Logic from the command line? If I run Reaper, Live, and Bitwig from command line, I get all the stdout dumped to the terminal; don't have Logic to see if it's the same, but I assume so?
There was a problem hiding this comment.
(an aside: I usually set up REAPER as the app to run in XCode with a project that just loads the plugin and opens it by default, in this case, the terminal output is just dumped to the XCode console)
|
Huh. Yeah of course that works. I am simply amazed I didn't think of that. Like really amazed. Well that's mortally embarrassing. None of this code is needed. I'm going to close this PR and delete the code. I can just use printf when I'm debugging. Sorry for the noise. |
|
@baconpaul now we can argue about tabs vs. spaces and such extremely important programming topics ;) |
|
@kzantow. Sure! spaces. |
As mentioned in #94 I banged together a small logging class which helped me a lot with getting AU running. After chatting with @jsakkine and @asimilon about how to get a useful logger, we thought about integrating someone else's written fast C++ logger.
I chose spdlog https://github.com/gabime/spdlog
With this PR, spdlog works and you can use it anywhere if you
#include "SurgeLogger.h"and then use their nativespdlog::info()or what not.And I gotta say, spdlog works great. I accidentally put a log into the render loop on every process block while debugging #146 and while my log file got big, my sound didn't waver.
@jsakkine @asimilon @kzantow and @kurasu interested in review or opinion from any of you. Especially note I added a new git submodule. I hope you like it, because wow, this is super handy for me squashing bugs.