MySQL 8.4.2
Source Code Documentation
anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig Class Reference
Inheritance diagram for anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig:
[legend]

Public Member Functions

 LoggingPluginConfig (const std::string &sink_name, const mysql_harness::LoaderConfig &config, const std::string &default_log_filename, const mysql_harness::logging::LogLevel default_log_level, const mysql_harness::logging::LogTimestampPrecision default_log_timestamp_precision)
 
std::string get_default (std::string_view) const override
 Gets the default for the given option. More...
 
bool is_required (std::string_view) const override
 Returns whether the given option is required. More...
 
- Public Member Functions inherited from mysql_harness::BasePluginConfig
 BasePluginConfig ()=default
 
 BasePluginConfig (const BasePluginConfig &)=default
 
 BasePluginConfig (BasePluginConfig &&)=default
 
BasePluginConfigoperator= (const BasePluginConfig &)=default
 
BasePluginConfigoperator= (BasePluginConfig &&)=default
 
virtual ~BasePluginConfig ()=default
 destructor More...
 
std::string get_option_description (const mysql_harness::ConfigSection *section, std::string_view option) const
 get description of the option. More...
 
template<class Func >
decltype(auto) get_option (const mysql_harness::ConfigSection *section, std::string_view option, Func &&transformer) const
 get option value. More...
 
template<class Func >
decltype(auto) get_option_no_default (const mysql_harness::ConfigSection *section, std::string_view option, Func &&transformer) const
 get option value. More...
 
std::string get_option_string (const mysql_harness::ConfigSection *section, std::string_view option) const
 Gets value of given option as string. More...
 
template<class T >
get_uint_option (const mysql_harness::ConfigSection *section, std::string_view option, T min_value=0, T max_value=std::numeric_limits< T >::max()) const
 Gets an unsigned integer using the given option. More...
 
std::chrono::milliseconds get_option_milliseconds (const mysql_harness::ConfigSection *section, std::string_view option, double min_value=0.0, double max_value=std::numeric_limits< double >::max()) const
 Gets a number of milliseconds using the given option. More...
 

Public Attributes

std::string name
 
std::string logging_folder
 
std::string filename
 
std::string destination
 
mysql_harness::logging::LogLevel level
 
mysql_harness::logging::LogTimestampPrecision timestamp_precision
 
bool to_nullhandler {false}
 
const std::string kSystemLogPluginName = kSyslogPluginName
 

Static Public Attributes

static constexpr const char * kLogLevel
 
static constexpr const char * kLogTimestampPrecision
 
static constexpr const char * kLogFilename
 
static constexpr const char * kDestination
 

Additional Inherited Members

- Protected Member Functions inherited from mysql_harness::BasePluginConfig
 BasePluginConfig (const mysql_harness::ConfigSection *section)
 Constructor for derived classes. More...
 
- Static Protected Member Functions inherited from mysql_harness::BasePluginConfig
static std::string get_section_name (const mysql_harness::ConfigSection *section)
 Generate the name for this configuration. More...
 

Constructor & Destructor Documentation

◆ LoggingPluginConfig()

anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::LoggingPluginConfig ( const std::string &  sink_name,
const mysql_harness::LoaderConfig config,
const std::string &  default_log_filename,
const mysql_harness::logging::LogLevel  default_log_level,
const mysql_harness::logging::LogTimestampPrecision  default_log_timestamp_precision 
)
inlineexplicit

Member Function Documentation

◆ get_default()

std::string anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::get_default ( std::string_view  option) const
inlineoverridevirtual

Gets the default for the given option.

Gets the default value of the given option. If no default option is available, an empty string is returned.

Parameters
optionname of the option
Returns
default value for given option as std::string

Implements mysql_harness::BasePluginConfig.

◆ is_required()

bool anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::is_required ( std::string_view  option) const
inlineoverridevirtual

Returns whether the given option is required.

Returns
bool

Implements mysql_harness::BasePluginConfig.

Member Data Documentation

◆ destination

std::string anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::destination

◆ filename

std::string anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::filename

◆ kDestination

constexpr const char* anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::kDestination
staticconstexpr
Initial value:

◆ kLogFilename

constexpr const char* anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::kLogFilename
staticconstexpr
Initial value:

◆ kLogLevel

constexpr const char* anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::kLogLevel
staticconstexpr
Initial value:

◆ kLogTimestampPrecision

constexpr const char* anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::kLogTimestampPrecision
staticconstexpr
Initial value:

◆ kSystemLogPluginName

const std::string anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::kSystemLogPluginName = kSyslogPluginName

◆ level

mysql_harness::logging::LogLevel anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::level

◆ logging_folder

std::string anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::logging_folder

◆ name

std::string anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::name

◆ timestamp_precision

mysql_harness::logging::LogTimestampPrecision anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::timestamp_precision

◆ to_nullhandler

bool anonymous_namespace{logger_plugin.cc}::LoggingPluginConfig::to_nullhandler {false}

The documentation for this class was generated from the following file: