tpc_logger
Logging system for the TPC software.
The TPC Logger class provides a singleton for logging information within C++ code or in the python API. The class Logger contains an instance of spdlog::logger for both printing to the console (s_ConsoleLogger) and for logging to a file (s_FileLogger). There are four basic log levels:
Logger::info("Generic information...");
Logger::trace("Stack trace level of information...");
Logger::warn("Warning! Don't do what you're thinking of doing!");
Logger::error("ERROR! Program crashing!");
Installation
To install, simply download the repository and run the setup.py script:
python setup.py install
This will run cmake to compile the project and generate the python library. The default settings set the logger to only output to the log file, the console logger is turned off by default (CONSOLE_LOGGER=OFF). Unit tests are enabled by default, but can be turned off by swtiching BUILD_TESTS=OFF. To run the tests, either go to the "tests" directory and issue:
pytest .
or, go to the build directory (probably "build/temp.[environment]") and issue,
ctest
C++ usage
To use within a C++ class, first include the header Logger.hh. You can then invoke the log level commands:
#include "Logger.hh"
// some condition causes an error
if (condition == true)
{
Logger::error("ERROR! generic error message ...");
}
// store/print some generic info
Logger::info("Calling function foo()");
foo();
Python
Basic usage in python is to first import tpc_logger which returns an instance of the singleton class. Then, issue one of the four log level commands:
import tpc_logger as logger
import sys
# some condition causes an error
if (condition == True):
logger.error("ERROR! generic error message ...")
sys.exit()
# store/print some generic info
logger.info("Calling funcion bar()")
bar()
2 Jan 5, 2022
2 Mar 5, 2022
1 Mar 1, 2022
1 Nov 23, 2022
15 Dec 29, 2022
1 Feb 25, 2022
500 Dec 28, 2022
0 Mar 28, 2022
6 Feb 17, 2022
12.9k Jan 4, 2023
5 Jun 28, 2022
87 Dec 27, 2022
13.7k Jan 2, 2023
34 May 19, 2021
300 Dec 26, 2022
2.3k Jan 5, 2023
778 Dec 26, 2022
496 Dec 30, 2022
1.4k Nov 11, 2022
278 Dec 31, 2022
0 May 24, 2022
3 Jan 10, 2022
![Heart[BOT]](https://avatars.githubusercontent.com/u/43449017?v=4&s=60)
0 Nov 20, 2022
102 Dec 22, 2022
2.4k Dec 25, 2022
1 Nov 10, 2021
1 Feb 12, 2022
1 Feb 13, 2022
1 Nov 11, 2021
1k Jan 04, 2023
38 Jul 20, 2022
2 Oct 02, 2022
23.7k Jan 01, 2023
824 Jan 08, 2023
1.2k Dec 28, 2022
4k Dec 30, 2022
23 Oct 04, 2021