|
10Duke Enterprise C++ SDK
|
Logging support.
Logging for the client. This is currently very, very simple.
Classes | |
| class | DevNullLogger |
| Logger, which does not log anything. More... | |
| class | Logger |
| Simple logger interface. More... | |
| class | OStreamLogger |
| Logger that writes to an output stream, one line per message. More... | |
| class | StdErrLogger |
| Logger that writes to standard error (std::cerr), one line per message. More... | |
| class | StdOutLogger |
| Logger that writes to standard output (std::cout), one line per message. More... | |
Functions | |
| void | debug (const char *message) |
| Write message to global logger at DEBUG-level. | |
| void | debug (const std::string &message) |
| Write message to global logger at DEBUG-level. | |
| void | error (const char *message) |
| Write message to global logger at ERROR-level. | |
| void | error (const std::string &message) |
| Write message to global logger at ERROR-level. | |
| void | info (const char *message) |
| Write message to global logger at INFO-level. | |
| void | info (const std::string &message) |
| Write message to global logger at INFO-level. | |
| void | trace (const char *message) |
| Write message to global logger at TRACE-level. | |
| void | trace (const std::string &message) |
| Write message to global logger at TRACE-level. | |
| void | warning (const char *message) |
| Write message to global logger at WARNING-level. | |
| void | warning (const std::string &message) |
| Write message to global logger at WARNING-level. | |
| std::shared_ptr< tenduke::log::Logger > | getGlobalLogger () |
| Returns the global logger. | |
| ::tenduke::log::Logger::LOG_LEVEL | getGlobalLogLevel () |
| Returns log level of the global logger. | |
| bool | isEnabled (::tenduke::log::Logger::LOG_LEVEL logLevel) |
| Checks if global log level is enabled, that is, logger is writing messages at this level. | |
| bool | isDebugEnabled () |
| Checks if global logger would write messages at level LOG_LEVEL::LOG_DEBUG. | |
| bool | isTraceEnabled () |
| Checks if global logger would write messages at level LOG_LEVEL::LOG_TRACE. | |
| std::shared_ptr<::tenduke::log::Logger > | setGlobalLogger (const std::shared_ptr<::tenduke::log::Logger > &logger) |
| Sets the global logger. | |
| std::string | sanitize (const std::string &untrusted, std::size_t maxLength=DEFAULT_SANITIZED_MAX_LENGTH) |
| Makes an untrusted value (e.g. | |
| std::string | redactQueryParameters (const std::string &url, const std::vector< std::string > ¶meterNames) |
| Replaces the values of the given query parameters of a URL with REDACTED, for logging a URL that carries secrets (e.g. | |
Variables | |
| const std::size_t | DEFAULT_SANITIZED_MAX_LENGTH = 64 |
| Default maximum length of a sanitized value, see tenduke::log::sanitize(). | |
| void tenduke::log::debug | ( | const char * | message | ) |
Write message to global logger at DEBUG-level.
| message | - |
| void tenduke::log::debug | ( | const std::string & | message | ) |
Write message to global logger at DEBUG-level.
| message | - |
| void tenduke::log::error | ( | const char * | message | ) |
Write message to global logger at ERROR-level.
| message | - |
| void tenduke::log::error | ( | const std::string & | message | ) |
Write message to global logger at ERROR-level.
| message | - |
| std::shared_ptr< xdlog::Logger > tenduke::log::getGlobalLogger | ( | ) |
Returns the global logger.
| Logger::LOG_LEVEL tenduke::log::getGlobalLogLevel | ( | ) |
Returns log level of the global logger.
| void tenduke::log::info | ( | const char * | message | ) |
Write message to global logger at INFO-level.
| message | - |
| void tenduke::log::info | ( | const std::string & | message | ) |
Write message to global logger at INFO-level.
| message | - |
| bool tenduke::log::isDebugEnabled | ( | ) |
Checks if global logger would write messages at level LOG_LEVEL::LOG_DEBUG.
This is syntactic sugar for writing prettier code.
| bool tenduke::log::isEnabled | ( | ::tenduke::log::Logger::LOG_LEVEL | logLevel | ) |
Checks if global log level is enabled, that is, logger is writing messages at this level.
| logLevel | the level to check |
| bool tenduke::log::isTraceEnabled | ( | ) |
Checks if global logger would write messages at level LOG_LEVEL::LOG_TRACE.
This is syntactic sugar for writing prettier code.
| std::string tenduke::log::redactQueryParameters | ( | const std::string & | url, |
| const std::vector< std::string > & | parameterNames ) |
Replaces the values of the given query parameters of a URL with REDACTED, for logging a URL that carries secrets (e.g.
state, nonce or code). Parameter names are compared exactly, as they appear in the URL.
| url | the URL |
| parameterNames | names of the parameters whose values are redacted |
| std::string tenduke::log::sanitize | ( | const std::string & | untrusted, |
| std::size_t | maxLength = DEFAULT_SANITIZED_MAX_LENGTH ) |
Makes an untrusted value (e.g.
from an unverified token or an incoming request) safe to write to the log: Characters other than printable ASCII (including CR and LF, which could inject fake log lines) are replaced with ?, and a value longer than maxLength is truncated and ends with ....
Never use this for secrets: sanitizing does not hide the value.
| untrusted | the value |
| maxLength | maximum number of characters taken from untrusted |
| std::shared_ptr<::tenduke::log::Logger > tenduke::log::setGlobalLogger | ( | const std::shared_ptr<::tenduke::log::Logger > & | logger | ) |
Sets the global logger.
By default, the global logger is a DevNullLogger, that is, the library does not write logs anywhere. To see the logs, set e.g. a StdOutLogger: setGlobalLogger(std::make_shared<StdOutLogger>("", Logger::LOG_DEBUG));
This method is thread safe. A logger set here may be called from several threads at the same time, so its write() must be thread safe.
| logger | the new global logger. |
| void tenduke::log::trace | ( | const char * | message | ) |
Write message to global logger at TRACE-level.
| message | - |
| void tenduke::log::trace | ( | const std::string & | message | ) |
Write message to global logger at TRACE-level.
| message | - |
| void tenduke::log::warning | ( | const char * | message | ) |
Write message to global logger at WARNING-level.
| message | - |
| void tenduke::log::warning | ( | const std::string & | message | ) |
Write message to global logger at WARNING-level.
| message | - |