log
36 items · generated by scribe fromstdlib/log.fd· synced 2026-11-15
Contents
- LOG_TRACE: (const)
- log_set_level (function)
- log_get_level (function)
- log_level_from_str (function)
- log_set_timestamps (function)
- log_set_json (function)
- log_to_stdout (function)
- log_to_stderr (function)
- log_to_file (function)
- log_json_escape (function)
- log_render_text (function)
- log_render_json (function)
- log_logf (function)
- log_log (function)
- log_set_module_level (function)
- log_module_level (function)
- log_clear_module_level (function)
- logmf (function)
- logm (function)
- log_trace (function)
- log_debug (function)
- log_info (function)
- log_warn (function)
- log_error (function)
- log_tracef (function)
- log_debugf (function)
- log_infof (function)
- log_warnf (function)
- log_errorf (function)
LOG_TRACE:
pub const LOG_TRACE: i64 = 10; pub const LOG_DEBUG: i64 = 20; pub const LOG_INFO: i64 = 30; pub const LOG_WARN: i64 = 40; pub const LOG_ERROR: i64 = 50; pub const LOG_OFF: i64 = 100;Defined at line 26
log_set_level
Only emit messages at or above this level.
Example: log_set_level(LOG_WARN); assert_eq(log_get_level(), LOG_WARN); log_info(“not printed”); log_warn(“printed”);
pub fn log_set_level(level: i64) -> void {Parameters:
level:i64
Returns: void
Defined at line 43
log_get_level
The current global level (LOG_INFO unless changed).
Example: assert_eq(log_get_level(), LOG_INFO);
pub fn log_get_level() -> i64 {Returns: i64
Defined at line 51
log_level_from_str
Parse a level name (“trace”..“error”, case-insensitive). Returns -1 for unknown names.
Example: assert_eq(log_level_from_str(“WARN”), LOG_WARN); assert_eq(log_level_from_str(“verbose”), -1);
pub fn log_level_from_str(name: str) -> i64 {Parameters:
name:str
Returns: i64
Defined at line 61
log_set_timestamps
Turn timestamps on/off. Off by default so tests are deterministic.
Example: log_set_timestamps(false); log_info(“no ts= field on this line”);
pub fn log_set_timestamps(on: bool) -> void {Parameters:
on:bool
Returns: void
Defined at line 89
log_set_json
Switch between logfmt text (false) and JSON lines (true).
Example: log_set_json(true); log_info(“as a JSON line”);
pub fn log_set_json(on: bool) -> void {Parameters:
on:bool
Returns: void
Defined at line 102
log_to_stdout
Send output to stdout (the default).
pub fn log_to_stdout() -> void {Returns: void
Defined at line 111
log_to_stderr
Send output to stderr.
Example: log_to_stderr(); log_error(“goes to stderr”); log_to_stdout();
pub fn log_to_stderr() -> void {Returns: void
Defined at line 122
log_to_file
Append output to a file. "" returns to stdout.
pub fn log_to_file(path: str) -> void {Parameters:
path:str
Returns: void
Defined at line 128
log_json_escape
Escape a string for JSON output (quotes, backslashes, controls).
Example: assert_eq(log_json_escape(“a”b\n”), “a\“b\n”);
pub fn log_json_escape(s: str) -> str {Parameters:
s:str
Returns: str
Defined at line 178
log_render_text
Build the logfmt text line. Public so a caller (or a test) can check the output against the format without emitting it.
Example: var f: Vec
pub fn log_render_text(level: i64, msg: str, fields: Vec<str>) -> str {Parameters:
level:i64msg:strfields:Vec<str>
Returns: str
Defined at line 278
log_render_json
Build the JSON line. Public so a caller (or a test) can parse the output against the JSON spec without emitting it (CO4).
Example: var f: Vec
pub fn log_render_json(level: i64, msg: str, fields: Vec<str>) -> str {Parameters:
level:i64msg:strfields:Vec<str>
Returns: str
Defined at line 303
log_logf
Core: log at an explicit level with a field list (flat k,v pairs).
Example: var f: Vec
pub fn log_logf(level: i64, msg: str, fields: Vec<str>) -> void {Parameters:
level:i64msg:strfields:Vec<str>
Returns: void
Defined at line 352
log_log
Log at an explicit level without fields.
Example: log_log(LOG_ERROR, “disk full”);
pub fn log_log(level: i64, msg: str) -> void {Parameters:
level:i64msg:str
Returns: void
Defined at line 369
log_set_module_level
Emit module’s messages only at or above level.
Example: log_set_module_level(“db”, LOG_ERROR); assert_eq(log_module_level(“db”), LOG_ERROR); assert_eq(log_module_level(“http”), LOG_INFO); logm(LOG_INFO, “db”, “not printed”);
pub fn log_set_module_level(module: str, level: i64) -> void {Parameters:
module:strlevel:i64
Returns: void
Defined at line 387
log_module_level
The level that applies to module: its override, else the global one.
pub fn log_module_level(module: str) -> i64 {Parameters:
module:str
Returns: i64
Defined at line 395
log_clear_module_level
Drop module’s override: it follows the global level again.
Example: log_set_module_level(“db”, LOG_OFF); log_clear_module_level(“db”); assert_eq(log_module_level(“db”), log_get_level());
pub fn log_clear_module_level(module: str) -> void {Parameters:
module:str
Returns: void
Defined at line 412
logmf
Log msg at level for module, honoring its override; the module name is emitted as the “module” field.
pub fn logmf(level: i64, module: str, msg: str, fields: Vec<str>) -> void {Parameters:
level:i64module:strmsg:strfields:Vec<str>
Returns: void
Defined at line 421
logm
As logmf, without fields.
Example: logm(LOG_ERROR, “db”, “connection lost”);
pub fn logm(level: i64, module: str, msg: str) -> void {Parameters:
level:i64module:strmsg:str
Returns: void
Defined at line 446
log_trace
pub fn log_trace(msg: str) -> void {Parameters:
msg:str
Returns: void
Defined at line 453
log_debug
pub fn log_debug(msg: str) -> void {Parameters:
msg:str
Returns: void
Defined at line 456
log_info
Log msg at INFO level (log_trace, log_debug, log_warn and log_error are the same at their level).
Example: log_info(“server started”);
pub fn log_info(msg: str) -> void {Parameters:
msg:str
Returns: void
Defined at line 464
log_warn
pub fn log_warn(msg: str) -> void {Parameters:
msg:str
Returns: void
Defined at line 467
log_error
pub fn log_error(msg: str) -> void {Parameters:
msg:str
Returns: void
Defined at line 470
log_tracef
pub fn log_tracef(msg: str, fields: Vec<str>) -> void {Parameters:
msg:strfields:Vec<str>
Returns: void
Defined at line 474
log_debugf
pub fn log_debugf(msg: str, fields: Vec<str>) -> void {Parameters:
msg:strfields:Vec<str>
Returns: void
Defined at line 477
log_infof
Log msg at INFO level with flat key, value fields (log_tracef, log_debugf, log_warnf and log_errorf are the same at their level).
Example: var f: Vec
pub fn log_infof(msg: str, fields: Vec<str>) -> void {Parameters:
msg:strfields:Vec<str>
Returns: void
Defined at line 487
log_warnf
pub fn log_warnf(msg: str, fields: Vec<str>) -> void {Parameters:
msg:strfields:Vec<str>
Returns: void
Defined at line 490
log_errorf
pub fn log_errorf(msg: str, fields: Vec<str>) -> void {Parameters:
msg:strfields:Vec<str>
Returns: void
Defined at line 493
Generated by scribe, the Fides documentation generator