10Duke Enterprise C++ SDK
Loading...
Searching...
No Matches
tenduke::log Namespace Reference

Detailed Description

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 > &parameterNames)
 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().

Function Documentation

◆ debug() [1/2]

void tenduke::log::debug ( const char * message)

Write message to global logger at DEBUG-level.

Parameters
message-

◆ debug() [2/2]

void tenduke::log::debug ( const std::string & message)

Write message to global logger at DEBUG-level.

Parameters
message-

◆ error() [1/2]

void tenduke::log::error ( const char * message)

Write message to global logger at ERROR-level.

Parameters
message-

◆ error() [2/2]

void tenduke::log::error ( const std::string & message)

Write message to global logger at ERROR-level.

Parameters
message-

◆ getGlobalLogger()

std::shared_ptr< xdlog::Logger > tenduke::log::getGlobalLogger ( )

Returns the global logger.

Returns
-

◆ getGlobalLogLevel()

Logger::LOG_LEVEL tenduke::log::getGlobalLogLevel ( )

Returns log level of the global logger.

Returns
-

◆ info() [1/2]

void tenduke::log::info ( const char * message)

Write message to global logger at INFO-level.

Parameters
message-

◆ info() [2/2]

void tenduke::log::info ( const std::string & message)

Write message to global logger at INFO-level.

Parameters
message-

◆ isDebugEnabled()

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.

Returns
true if the LOG_DEBUG is enabled

◆ isEnabled()

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.

Parameters
logLevelthe level to check
Returns
true if the given level is enabled. false otherwise.

◆ isTraceEnabled()

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.

Returns
true if the LOG_TRACE is enabled

◆ redactQueryParameters()

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.

Parameters
urlthe URL
parameterNamesnames of the parameters whose values are redacted
Returns
the URL with the values redacted

◆ sanitize()

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.

Parameters
untrustedthe value
maxLengthmaximum number of characters taken from untrusted
Returns
the sanitized value

◆ setGlobalLogger()

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.

Parameters
loggerthe new global logger.
Returns
the old global logger.

◆ trace() [1/2]

void tenduke::log::trace ( const char * message)

Write message to global logger at TRACE-level.

Parameters
message-

◆ trace() [2/2]

void tenduke::log::trace ( const std::string & message)

Write message to global logger at TRACE-level.

Parameters
message-

◆ warning() [1/2]

void tenduke::log::warning ( const char * message)

Write message to global logger at WARNING-level.

Parameters
message-

◆ warning() [2/2]

void tenduke::log::warning ( const std::string & message)

Write message to global logger at WARNING-level.

Parameters
message-