Kea 2.2.0
isc::yang::TranslatorLogger Class Reference

Logger translation between YANG and JSON. More...

#include <translator_logger.h>

+ Inheritance diagram for isc::yang::TranslatorLogger:

Public Member Functions

 TranslatorLogger (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorLogger ()
 Destructor. More...
 
isc::data::ElementPtr getLogger (const std::string &xpath)
 Get and translate a logger from YANG to JSON. More...
 
void setLogger (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set logger from JSON to YANG. More...
 
- Public Member Functions inherited from isc::yang::TranslatorBasic
 TranslatorBasic (sysrepo::S_Session session, const std::string &model)
 Constructor. More...
 
virtual ~TranslatorBasic ()
 Destructor. More...
 
void checkAndGetLeaf (isc::data::ElementPtr &storage, const std::string &xpath, const std::string &name)
 Retrieves an item and stores it in the specified storage. More...
 
void checkAndSetLeaf (isc::data::ConstElementPtr const &from, std::string const &xpath, std::string const &name, sr_type_t const type)
 Get an element from given ElementPtr node and set it in sysrepo at given xpath. More...
 
void delItem (const std::string &xpath)
 Delete basic value from YANG. More...
 
template<typename functor_t >
void forAll (std::string const &xpath, functor_t f)
 Run a function for a node and all its children. More...
 
isc::data::ElementPtr getItem (const std::string &xpath)
 Get and translate basic value from YANG to JSON. More...
 
isc::data::ElementPtr getItems (const std::string &xpath)
 Get and translate a list of basic values from YANG to JSON. More...
 
template<typename T >
isc::data::ElementPtr getList (std::string const &xpath, T &t, isc::data::ElementPtr(T::*f)(std::string const &xpath))
 Retrieve a list as ElementPtr from sysrepo from a certain xpath. More...
 
sysrepo::S_Vals getValuesFromItems (std::string const &xpath)
 Get the values of all siblings at a certain xpath. More...
 
void setItem (const std::string &xpath, isc::data::ConstElementPtr elem, sr_type_t type)
 Translate and set basic value from JSON to YANG. More...
 

Protected Member Functions

isc::data::ElementPtr getLoggerKea (const std::string &xpath)
 getLogger JSON for loggers. More...
 
isc::data::ElementPtr getOutputOption (const std::string &xpath)
 Get and translate an output option from YANG to JSON. More...
 
isc::data::ElementPtr getOutputOptions (const std::string &xpath)
 Get and translate output options from YANG to JSON. More...
 
void setLoggerKea (const std::string &xpath, isc::data::ConstElementPtr elem)
 setLogger for loggers. More...
 
void setOutputOption (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set an output option from JSON to YANG. More...
 
void setOutputOptions (const std::string &xpath, isc::data::ConstElementPtr elem)
 Translate and set output options from JSON to YANG. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from isc::yang::TranslatorBasic
static sysrepo::S_Val value (isc::data::ConstElementPtr elem, sr_type_t type)
 Translate basic value from JSON to YANG. More...
 
static isc::data::ElementPtr value (sysrepo::S_Val s_val)
 Translate basic value from YANG to JSON. More...
 
- Protected Attributes inherited from isc::yang::TranslatorBasic
std::string model_
 The model. More...
 
sysrepo::S_Session session_
 The sysrepo session. More...
 

Detailed Description

Logger translation between YANG and JSON.

JSON syntax for all Kea servers with loggers is:

{
"name": <name>,
"output_options": [ <output options> ],
"severity": <severity>,
"debuglevel": <debug level>,
"user-context": { <json map> },
"comment": <comment>
}
@ debug
Definition: db_log.h:118

JSON syntax for all Kea server for output options is:

{
"output": <output, e.g. log file name>,
"maxver": <maximum file version>,
"maxsize": <maximum file size>,
"flush": <flush flag>,
"pattern": <custom layout>
}
int version()
returns Kea hooks version.

YANG syntax for loggers is:

+--rw logger* [name]
+--rw name string
+--rw output-option* [output]
| +--rw output string
| +--rw flush? boolean
| +--rw maxsize? uint32
| +--rw maxver? uint32
| +--rw pattern? string
+--rw debuglevel? uint8
+--rw severity? enumeration
+--rw user-context? user-context
isc::log::Logger logger("asiodns")
Use the ASIO logger.

An example in JSON and YANG formats:

[
{
"name": "foo",
"severity": "WARN",
"output_options":
[
{
"output": "/bar",
"maxver": 10
}
]
}
]
/kea-dhcp4-server:config (container)
/kea-dhcp4-server:config/...
/kea-dhcp4-server:config/logger[name='foo'] (list instance)
/kea-dhcp4-server:config/logger[name='foo']/name = foo
/kea-dhcp4-server:config/logger[name='foo']/
option[output='/bar'] (list instance)
/kea-dhcp4-server:config/logger[name='foo']/
option[output='/bar']/option = /bar
/kea-dhcp4-server:config/logger[name='foo']/
option[output='/bar']/maxver = 10
/kea-dhcp4-server:config/logger[name='foo']/severity = WARN

A translator class for converting a logger between YANG and JSON.

Currently supports all kea models:

  • kea-dhcp4-server
  • kea-dhcp6-server
  • kea-dhcp-ddns
  • kea-ctrl-agent

Definition at line 94 of file translator_logger.h.

Constructor & Destructor Documentation

◆ TranslatorLogger()

isc::yang::TranslatorLogger::TranslatorLogger ( sysrepo::S_Session  session,
const std::string &  model 
)

Constructor.

Parameters
sessionSysrepo session.
modelModel name.

Definition at line 21 of file translator_logger.cc.

◆ ~TranslatorLogger()

isc::yang::TranslatorLogger::~TranslatorLogger ( )
virtual

Destructor.

Definition at line 25 of file translator_logger.cc.

Member Function Documentation

◆ getLogger()

ElementPtr isc::yang::TranslatorLogger::getLogger ( const std::string &  xpath)

Get and translate a logger from YANG to JSON.

Parameters
xpathThe xpath of the logger.
Returns
JSON representation of the logger.
Exceptions
SysrepoErrorwhen sysrepo raises an error.

Definition at line 29 of file translator_logger.cc.

References getLoggerKea(), isc_throw, isc::yang::TranslatorBasic::model_, and isc::Exception::what().

Referenced by isc::yang::TranslatorLoggers::getLoggersKea().

+ Here is the call graph for this function:

◆ getLoggerKea()

ElementPtr isc::yang::TranslatorLogger::getLoggerKea ( const std::string &  xpath)
protected

getLogger JSON for loggers.

Parameters
xpathThe xpath of the logger.
Returns
JSON representation of the logger.
Exceptions
SysrepoErrorwhen sysrepo raises an error.

Definition at line 47 of file translator_logger.cc.

References isc::yang::TranslatorBasic::getItem(), getOutputOptions(), and isc_throw.

Referenced by getLogger().

+ Here is the call graph for this function:

◆ getOutputOption()

ElementPtr isc::yang::TranslatorLogger::getOutputOption ( const std::string &  xpath)
protected

Get and translate an output option from YANG to JSON.

Parameters
xpathThe xpath of the output option.
Returns
JSON representation of the output option.
Exceptions
SysrepoErrorwhen sysrepo raises an error.

Definition at line 75 of file translator_logger.cc.

References isc::yang::TranslatorBasic::getItem(), and isc_throw.

Referenced by getOutputOptions().

+ Here is the call graph for this function:

◆ getOutputOptions()

ElementPtr isc::yang::TranslatorLogger::getOutputOptions ( const std::string &  xpath)
protected

Get and translate output options from YANG to JSON.

Parameters
xpathThe xpath of output options.
Returns
JSON representation of output options.
Exceptions
SysrepoErrorwhen sysrepo raises an error.

Definition at line 103 of file translator_logger.cc.

References isc::yang::TranslatorBasic::getList(), and getOutputOption().

Referenced by getLoggerKea().

+ Here is the call graph for this function:

◆ setLogger()

void isc::yang::TranslatorLogger::setLogger ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)

Translate and set logger from JSON to YANG.

Parameters
xpathThe xpath of the logger.
elemThe JSON element.

Definition at line 109 of file translator_logger.cc.

References isc_throw, isc::yang::TranslatorBasic::model_, setLoggerKea(), and isc::Exception::what().

Referenced by isc::yang::TranslatorLoggers::setLoggersKea().

+ Here is the call graph for this function:

◆ setLoggerKea()

void isc::yang::TranslatorLogger::setLoggerKea ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)
protected

setLogger for loggers.

Parameters
xpathThe xpath of the logger.
elemThe JSON element.

Definition at line 128 of file translator_logger.cc.

References isc::yang::Adaptor::getContext(), isc::yang::TranslatorBasic::setItem(), and setOutputOptions().

Referenced by setLogger().

+ Here is the call graph for this function:

◆ setOutputOption()

void isc::yang::TranslatorLogger::setOutputOption ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)
protected

Translate and set an output option from JSON to YANG.

Parameters
xpathThe xpath of the output option.
elemThe JSON element.

Definition at line 150 of file translator_logger.cc.

References isc::yang::TranslatorBasic::setItem().

Referenced by setOutputOptions().

+ Here is the call graph for this function:

◆ setOutputOptions()

void isc::yang::TranslatorLogger::setOutputOptions ( const std::string &  xpath,
isc::data::ConstElementPtr  elem 
)
protected

Translate and set output options from JSON to YANG.

Parameters
xpathThe xpath of the output options.
elemThe JSON element.
Exceptions
BadValueon an output option without output.

Definition at line 181 of file translator_logger.cc.

References isc_throw, and setOutputOption().

Referenced by setLoggerKea().

+ Here is the call graph for this function:

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