fblog 4.16.0

json log viewer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use std::{collections::BTreeMap, fs, path::PathBuf};

use serde::{Deserialize, Serialize};

use crate::template::{DEFAULT_ADDITIONAL_VALUE_FORMAT, DEFAULT_MAIN_LINE_FORMAT};

fn default_message_keys() -> Vec<String> {
	vec!["short_message".to_string(), "msg".to_string(), "message".to_string()]
}

fn default_time_keys() -> Vec<String> {
	vec!["timestamp".to_string(), "time".to_string(), "@timestamp".to_string()]
}

fn default_dump_all_exclude() -> Vec<String> {
	vec![]
}

fn default_always_print_fields() -> Vec<String> {
	vec![]
}

fn default_level_keys() -> Vec<String> {
	vec!["level".to_string(), "severity".to_string(), "log.level".to_string(), "loglevel".to_string()]
}

fn default_level_map() -> BTreeMap<String, String> {
	BTreeMap::from([])
}

fn default_main_line_format() -> String {
	DEFAULT_MAIN_LINE_FORMAT.to_string()
}

fn default_additional_value_format() -> String {
	DEFAULT_ADDITIONAL_VALUE_FORMAT.to_string()
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Config {
	#[serde(default = "default_message_keys")]
	pub message_keys: Vec<String>,

	#[serde(default = "default_time_keys")]
	pub time_keys: Vec<String>,

	#[serde(default = "default_dump_all_exclude")]
	pub dump_all_exclude: Vec<String>,

	#[serde(default = "default_always_print_fields")]
	pub always_print_fields: Vec<String>,

	#[serde(default = "default_level_keys")]
	pub level_keys: Vec<String>,

	#[serde(default = "default_level_map")]
	pub level_map: BTreeMap<String, String>,

	#[serde(default = "default_main_line_format")]
	pub main_line_format: String,

	#[serde(default = "default_additional_value_format")]
	pub additional_value_format: String,
}

impl Config {
	pub fn load_from_file(config_file_path: &str) -> Option<Config> {
		let config_string = fs::read_to_string(PathBuf::from(config_file_path)).ok()?;
		match toml::from_str(&config_string) {
			Ok(config) => Some(config),
			Err(e) => {
				eprintln!("Could not parse config file: {e}");
				None
			}
		}
	}
	pub fn load() -> Option<Config> {
		let mut config_file = dirs::config_dir()?;
		config_file.push("fblog.toml");
		let config_string = fs::read_to_string(config_file).ok()?;
		match toml::from_str(&config_string) {
			Ok(config) => Some(config),
			Err(e) => {
				panic!("Could not parse config file: {e}");
			}
		}
	}
	pub fn new() -> Config {
		Config {
			message_keys: default_message_keys(),
			time_keys: default_time_keys(),
			level_keys: default_level_keys(),
			level_map: default_level_map(),
			main_line_format: default_main_line_format(),
			additional_value_format: default_additional_value_format(),
			dump_all_exclude: default_dump_all_exclude(),
			always_print_fields: default_always_print_fields(),
		}
	}

	pub fn get() -> Config {
		Config::load().unwrap_or_else(Config::new)
	}
}

#[cfg(test)]
mod tests {
	use std::fs;

	use super::*;

	#[test]
	fn read_defaults_from_empty_config() {
		let config: Config = toml::from_str(
			r#"
    "#,
		)
		.unwrap();

		assert_eq!(config.level_keys, default_level_keys());
		assert_eq!(config.level_map, default_level_map());
		assert_eq!(config.time_keys, default_time_keys());
		assert_eq!(config.message_keys, default_message_keys());
		assert_eq!(config.main_line_format, DEFAULT_MAIN_LINE_FORMAT);
		assert_eq!(config.additional_value_format, DEFAULT_ADDITIONAL_VALUE_FORMAT);

		let serialized_defaults = toml::to_string(&config).unwrap();
		let default_config_for_documentation = fs::read_to_string("default_config.toml").unwrap();
		assert_eq!(serialized_defaults, default_config_for_documentation)
	}

	#[test]
	fn read_empty_level_map() {
		let config: Config = toml::from_str(
			r#"
    [level_map]
    "#,
		)
		.unwrap();
		assert!(config.level_map.is_empty());
	}

	#[test]
	fn read_level_map() {
		let config: Config = toml::from_str(
			r#"
    [level_map]
    10 = "trace"
    "#,
		)
		.unwrap();
		assert_eq!(config.level_map, BTreeMap::from([("10".to_string(), "trace".to_string()),]));
	}
}