feat: add caller script & filters & timers

- add caller script in print
- add filters to blacklist or whitelist script logs to be shown
- add timer to check performance easily
This commit is contained in:
2026-01-31 17:18:15 +01:00
parent e065809279
commit a748d77e32
2 changed files with 148 additions and 60 deletions

View File

@@ -9,23 +9,28 @@ enum LogLevel {
ERROR
}
enum FilterMode {
BLACKLIST,
WHITELIST,
}
@export var current_log_level:LogLevel = LogLevel.DEBUG
@export var enable_timestamp:bool = true
@export var save_log:bool = false
@export var enable_caller: bool = true
@export var separator:String = " "
@export var folder:String = ""
@export var log_filename:String = "addons/Logs/data.log"
@export var filter_mode: FilterMode = FilterMode.BLACKLIST
@export var filtered_scripts: Array[String] = []
const TIMESTAMP_FORMAT:String = "%H:%M:%S"
const LOG_FORMAT_TIMESTAMP:String = "[%s]|[%-6s]: %s"
const LOG_FORMAT:String = "[%-6s]: %s"
var log_file_path = folder + log_filename
var _timers:Dictionary = {}
var _tmp_separator:String = ""
@@ -43,20 +48,24 @@ func _print(level: LogLevel, ...args: Array) -> void:
var level_str:String = LogLevel.keys()[level]
var timestamp := Time.get_time_string_from_system()
var caller := _get_caller_info() if enable_caller else ""
if enable_caller and not _should_log(caller + ".gd"):
return
var text: String = ""
for c:int in args.size():
text += str(args[c])
if c < args.size() - 1:
text += self.separator
var message:String = LOG_FORMAT_TIMESTAMP % [
timestamp,
level_str,
text,
] if self.enable_timestamp else LOG_FORMAT % [
level_str,
text,
]
var message:String = ""
message += "[%s]" % timestamp if self.enable_timestamp else ""
message += "[%-16s]" % caller if self.enable_caller else ""
message += "[%-6s]: " % level_str
message += "%s" % text
match level:
LogLevel.ERROR: push_error(message)
@@ -85,6 +94,53 @@ func _save_logs_to_file(message: String) -> bool:
#endregion
#region filters
func _get_caller_info() -> String:
var stack := get_stack()
if stack.size() >= 4:
var caller_frame: Dictionary = stack[3]
var source: String = caller_frame.get("source", "unknown")
var file: String = source.get_file()
return file.replace(".gd", "")
return "unknown"
func _should_log(caller: String) -> bool:
var is_in_list := caller in filtered_scripts
match filter_mode:
FilterMode.BLACKLIST:
return not is_in_list
FilterMode.WHITELIST:
return is_in_list
return true
func mute(script_name: String) -> void:
if script_name not in filtered_scripts:
filtered_scripts.append(script_name)
func unmute(script_name: String) -> void:
filtered_scripts.erase(script_name)
func set_whitelist(scripts: Array[String]) -> void:
filter_mode = FilterMode.WHITELIST
filtered_scripts = scripts
func set_blacklist(scripts: Array[String]) -> void:
filter_mode = FilterMode.BLACKLIST
filtered_scripts = scripts
func clear_filters() -> void:
filtered_scripts.clear()
#endregion
#region level functions
func trace(...args: Array) -> void:
@@ -123,3 +179,17 @@ func e(...args: Array) -> void:
callv("_print", [LogLevel.ERROR] + args)
#endregion
#region timers
func time_start(label: String) -> void:
_timers[label] = Time.get_ticks_usec()
func time_end(label: String) -> void:
if label in _timers:
var elapsed :float = (Time.get_ticks_usec() - _timers[label]) / 1000.0
d("## Performance: ", label, " %.2fms" % elapsed)
_timers.erase(label)
#endregion