Seastar
High performance C++ framework for concurrent servers
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Types | Public Member Functions | Public Attributes | List of all members
seastar::log_cli::options Struct Reference

Detailed Description

Logging configuration.

#include <seastar/util/log-cli.hh>

Inheritance diagram for seastar::log_cli::options:
seastar::program_options::option_group

Public Types

using value_list_type = boost::intrusive::list< basic_value, boost::intrusive::base_hook< list_base_hook >, boost::intrusive::constant_time_size< false > >
 
using option_group_list_type = boost::intrusive::list< option_group, boost::intrusive::base_hook< list_base_hook >, boost::intrusive::constant_time_size< false > >
 

Public Member Functions

 operator bool () const
 Does the option group has any values contained in it?
 
bool used () const
 
const std::string & name () const
 
const value_list_type & values () const
 
value_list_type & values ()
 
void describe (options_descriptor &descriptor) const
 
void mutate (options_mutator &mutator)
 

Public Attributes

program_options::value< log_leveldefault_log_level
 Default log level for log messages. More...
 
program_options::value< log_level_map > logger_log_level
 Map of logger name to log level. More...
 
program_options::value< logger_timestamp_style > logger_stdout_timestamps
 
program_options::value< bool > log_to_stdout
 Send log output to output stream. More...
 
program_options::value< seastar::logger_ostream_type > logger_ostream_type
 
program_options::value< bool > log_to_syslog
 
program_options::value< bool > log_with_color
 

Member Function Documentation

◆ describe()

void seastar::program_options::option_group::describe ( options_descriptor descriptor) const
inherited

Describe the content of this option group to the visitor.

The content is visited in a depth-first manner:

  • First the option groups itself is visited with options_descriptor::visit_group_start(). If this returns false the entire content of the group, including all its subgroups and values are skipped and options_descriptor::visit_group_end() is called immediately. Otherwise visiting the content of the group proceeds.
  • All the values contained therein are visited. For each value the following happens:
    • First options_descriptor::visit_value_metadata() is called with generic metadata that all values have. If this return false the value is skipped, otherwise visiting the value proceeds.
    • Then the appropriate overload of options_descriptor::visit_value() is called, with a pointer to the default value of the respective value. The pointer is null if there is no default value.
    • For selection_value, options_descriptor::visit_selection_value() will be called instead of options_descriptor::visit_value(). After the value is visited, the option_group instance belonging to each candidate (if set) will be visited.
  • All the nested option_group instances in the current group are visited.
  • Finally options_descriptor::visit_group_end() is called.

◆ mutate()

void seastar::program_options::option_group::mutate ( options_mutator mutator)
inherited

Mutate the content of this option group by the visitor.

The visiting algorithm is identical to that of describe(), with the following differences:

  • options_mutator::visit_value() is allowed to mutate the value through the passed-in reference. It should return true if it did so and false otherwise.
  • When visiting a selection value, only the nested group belonging to the selected value is visited afterwards.

Member Data Documentation

◆ default_log_level

program_options::value<log_level> seastar::log_cli::options::default_log_level

Default log level for log messages.

Valid values are trace, debug, info, warn, error. Default: info

See also
log_level.

◆ log_to_stdout

program_options::value<bool> seastar::log_cli::options::log_to_stdout

Send log output to output stream.

As selected by logger_ostream_type. Default: true.

◆ log_to_syslog

program_options::value<bool> seastar::log_cli::options::log_to_syslog

Send log output to syslog.

Default: false.

◆ log_with_color

program_options::value<bool> seastar::log_cli::options::log_with_color

Print colored tag prefix in log messages sent to output stream.

Default: true.

◆ logger_log_level

program_options::value<log_level_map> seastar::log_cli::options::logger_log_level

Map of logger name to log level.

The format is NAME0=LEVEL0[:NAME1=LEVEL1:...]. Valid logger names can be queried with --help-loggers. This option can be specified multiple times.

◆ logger_ostream_type

program_options::value<seastar::logger_ostream_type> seastar::log_cli::options::logger_ostream_type

Send log output to.

Default: stderr.

See also
seastar::logger_ostream_type.

◆ logger_stdout_timestamps

program_options::value<logger_timestamp_style> seastar::log_cli::options::logger_stdout_timestamps

Select timestamp style for stdout logs.

Default: real.

See also
logger_timestamp_style.

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