keyring_log_builtins_definition.cc File Reference

#include <cstdio>
#include <cstring>
#include <ctime>
#include <iostream>
#include <locale>
#include <memory>
#include <sstream>
#include <string_with_len.h>
#include <components/keyrings/common/component_helpers/include/keyring_log_builtins_definition.h>

Classes
struct	st_error
	Error structure. More...
struct	_log_item_iter
	Iterator over the key/value pairs of a log_line. More...
struct	_log_line
	log_line ("log event") More...
struct	_log_item_wellknown_key
	Pre-defined "well-known" keys, as opposed to ad hoc ones, for key/value pairs in logging. More...

Namespaces
namespace	keyring_common
namespace	keyring_common::service_definition

Macros
#define	LOG_ITEM_MAX   64
	Maximum number of key/value pairs in a log event. More...

Typedefs
typedef struct _log_item_iter	log_item_iter
	Iterator over the key/value pairs of a log_line. More...
typedef struct _log_line	log_line
	log_line ("log event") More...
typedef struct _log_item_wellknown_key	log_item_wellknown_key
	Pre-defined "well-known" keys, as opposed to ad hoc ones, for key/value pairs in logging. More...

Functions
static int	log_item_wellknown_by_type (log_item_type t)
	Check if we know about the item type. More...
static const char *	log_label_from_prio (int prio)
	Convenience function: Derive a log label ("error", "warning", "information") from a severity. More...
static log_item_data *	kr_line_item_set_with_key (log_line *ll, log_item_type t, const char *k, uint32 alloc)
	Base for line_item_set[_with_key]. More...
static void	kr_log_item_free (log_item *li)
	Release any of key and value on a log-item that were dynamically allocated. More...
static void	kr_log_line_item_free_all (log_line *ll)
	Release all log line items (key/value pairs) in log line ll. More...

Variables
static st_error	global_error_names []
	Error info - generated from error message file. More...
static constexpr log_item_wellknown_key	log_item_wellknown_keys []
	Required items and their type - See LogComponentErr. More...
static uint	log_item_wellknown_keys_count

Macro Definition Documentation

LOG_ITEM_MAX

#define LOG_ITEM_MAX   64

Maximum number of key/value pairs in a log event.

May be changed or abolished later.

Typedef Documentation

log_item_iter

typedef struct _log_item_iter log_item_iter

Iterator over the key/value pairs of a log_line.

At present, only one iter may exist per log_line.

log_item_wellknown_key

typedef struct _log_item_wellknown_key log_item_wellknown_key

Pre-defined "well-known" keys, as opposed to ad hoc ones, for key/value pairs in logging.

log_line

typedef struct _log_line log_line

log_line ("log event")

Function Documentation

kr_line_item_set_with_key()

static log_item_data * kr_line_item_set_with_key ( log_line *  ll, log_item_type  t, const char *  k, uint32  alloc  )

static

Base for line_item_set[_with_key].

Stripped down version of that in log_builtins.cc.

kr_log_item_free()

static void kr_log_item_free ( log_item *  li )

static

Release any of key and value on a log-item that were dynamically allocated.

Parameters

li	log-item to release the payload of

kr_log_line_item_free_all()

static void kr_log_line_item_free_all ( log_line *  ll )

static

Release all log line items (key/value pairs) in log line ll.

This frees whichever keys and values were dynamically allocated.

Parameters

ll

log_line

log_item_wellknown_by_type()

static int log_item_wellknown_by_type ( log_item_type  t )

static

Check if we know about the item type.

log_label_from_prio()

static const char * log_label_from_prio ( int  prio )

static

Convenience function: Derive a log label ("error", "warning", "information") from a severity.

Parameters

prio	the severity/prio in question

Returns

a label corresponding to that priority.

Return values

System	for prio of SYSTEM_LEVEL
Error	for prio of ERROR_LEVEL
Warning	for prio of WARNING_LEVEL
Note	for prio of INFORMATION_LEVEL

Variable Documentation

global_error_names

st_error global_error_names[]

static

Initial value:

= {
 
 
 
    {nullptr, 0, nullptr, nullptr, nullptr, 0}}

Error info - generated from error message file.

log_item_wellknown_keys

constexpr log_item_wellknown_key log_item_wellknown_keys[]

staticconstexpr

Initial value:

= {
    {STRING_WITH_LEN("prio"), LOG_INTEGER, LOG_ITEM_LOG_PRIO},
    {STRING_WITH_LEN("err_code"), LOG_INTEGER, LOG_ITEM_SQL_ERRCODE},
    {STRING_WITH_LEN("subsystem"), LOG_CSTRING, LOG_ITEM_SRV_SUBSYS},
    {STRING_WITH_LEN("component"), LOG_CSTRING, LOG_ITEM_SRV_COMPONENT},
    {STRING_WITH_LEN("source_line"), LOG_INTEGER, LOG_ITEM_SRC_LINE},
    {STRING_WITH_LEN("source_file"), LOG_CSTRING, LOG_ITEM_SRC_FILE},
    {STRING_WITH_LEN("function"), LOG_CSTRING, LOG_ITEM_SRC_FUNC},
    {STRING_WITH_LEN("msg"), LOG_CSTRING, LOG_ITEM_LOG_MESSAGE}}

Required items and their type - See LogComponentErr.

log_item_wellknown_keys_count

uint log_item_wellknown_keys_count

static

Initial value:

=
    (sizeof(log_item_wellknown_keys) / sizeof(log_item_wellknown_key))