ORE Studio 0.0.4
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions
ores::logging Namespace Reference

Implements logging infrastructure for ORE Studio. More...

Classes

class  lifecycle_manager
 Manages the starting and stopping of logging for an application. More...
 
class  logging_configuration
 Centralized manager for logging configuration parsing. More...
 
class  logging_exception
 An exception has occurred during logging. More...
 
struct  logging_options
 Options related to logging. More...
 
class  logging_options_validator
 Checks the validity of the supplied logging options. More...
 

Typedefs

using logger_t = boost::log::sources::severity_channel_logger_mt< boost_severity, std::string_view >
 

Enumerations

enum  boost_severity {
  trace , debug , info , warn ,
  error
}
 Internal Boost.Log severity level enum. More...
 
enum class  severity_level : std::uint8_t {
  trace = 1 , debug = 5 , info = 9 , warn = 13 ,
  error = 17 , fatal = 21
}
 Log severity levels following OpenTelemetry conventions. More...
 

Functions

boost_severity to_boost_severity (const std::string &s)
 Converts a string to boost_severity.
 
boost_severity to_boost_severity (severity_level level)
 Converts domain severity_level to internal boost_severity.
 
severity_level to_domain_severity (boost_severity sev)
 Converts internal boost_severity to domain severity_level.
 
template<typename CharT , typename TraitsT >
std::basic_ostream< CharT, TraitsT > & operator<< (std::basic_ostream< CharT, TraitsT > &stream, boost_severity level)
 Inserter for boost_severity enum.
 
std::ostream & operator<< (std::ostream &s, const logging_options &v)
 
logger_t make_logger (std::string_view component_name)
 

Detailed Description

Implements logging infrastructure for ORE Studio.

This namespace contains the core logging infrastructure built on top of Boost.Log. It provides:

For telemetry integration (OTLP log export, trace correlation), use the ores::telemetry namespace which extends this infrastructure.

Enumeration Type Documentation

◆ boost_severity

Internal Boost.Log severity level enum.

This must be a C++03 enum due to Boost.Log internals. It is used only internally for Boost.Log integration. External code should use ores::logging::severity_level instead.

Note
This is an implementation detail and should not be used directly by client code.

◆ severity_level

enum class severity_level : std::uint8_t
strong

Log severity levels following OpenTelemetry conventions.

These severity levels are compatible with OpenTelemetry's log data model and map to standard logging frameworks. The numeric values match the OpenTelemetry specification for interoperability.

Function Documentation

◆ to_boost_severity() [1/2]

boost_severity to_boost_severity ( const std::string &  s)

Converts a string to boost_severity.

Parameters
sString representation (trace, debug, info, warn, error).
Returns
Corresponding boost_severity value.
Exceptions
std::invalid_argumentif the string is not a valid severity.
Here is the caller graph for this function:

◆ to_boost_severity() [2/2]

boost_severity to_boost_severity ( severity_level  level)

Converts domain severity_level to internal boost_severity.

Parameters
levelThe domain severity level.
Returns
Corresponding boost_severity value.

◆ to_domain_severity()

severity_level to_domain_severity ( boost_severity  sev)

Converts internal boost_severity to domain severity_level.

Parameters
sevThe boost severity.
Returns
Corresponding domain severity_level value.
Here is the caller graph for this function:

◆ operator<<()

template<typename CharT , typename TraitsT >
std::basic_ostream< CharT, TraitsT > & operator<< ( std::basic_ostream< CharT, TraitsT > &  stream,
boost_severity  level 
)

Inserter for boost_severity enum.

Required for interoperability with Boost.Log.