Skip to content

Latest commit

 

History

History
143 lines (111 loc) · 4.93 KB

README.md

File metadata and controls

143 lines (111 loc) · 4.93 KB
Raw

gdlogging Godot addon

This is a composable logging addon for version 4 of the Godot game engine. To see all available functions and classes see logger.gd.

Usage

var console_sink := Log.ConsoleRichSink.new()
Log.add_sink(console_sink)

var dir_sink := Log.DirSink.new("mylog", "res://logs", 4042)
var buffered_pipe := Log.BufferedPipe.new(dir_sink, 500)
# Don't log TRACE messages to the log file
var file_filtered_pipe := Log.FilteringPipe.new(buffered_pipe, Log.DEBUG)
Log.add_sink(file_filtered_pipe)

Log.debug("Hello World")
# [24/Jan/14 13:28:03] [         Global] [DBG] Hello World
var logger := Log.Logger.new("MyClass")
logger.debug("Hello World")
# [24/Jan/14 13:28:03] [        MyClass] [DBG] Hello World
Log.info(Log.format_error(ERR_FILE_NOT_FOUND))
# [24/Jan/14 13:28:03] [         Global] [INF] File: Not found error.
var timer := Log.LogTimer.new("MyTimer", 0, logger)
OS.delay_msec(1111)
timer.stop()
# [24/Jan/14 13:28:04] [        MyClass] [INF] MyTimer took 1.111963 seconds.
const threshold_msec: int = 1000
timer.set_threshold_msec(threshold_msec)
timer.start()
OS.delay_msec(800)
timer.stop()
# Prints nothing, because the timer was stopped before the threshold was reached.
timer.start()
OS.delay_msec(1111)
timer.stop()
# [24/Jan/14 13:28:06] [        MyClass] [INF] MyTimer exceeded threshold of 1000 msec: took 1.111750 seconds.

Log Levels

  • Log.TRACE: Prints the call site in debug builds. The stack depth can be configured per call.
  • Log.DEBUG: Debug messages
  • Log.INFO: Informational messages
  • Log.WARN: Warnings
  • Log.ERROR: Errors

Pipes

  • Logger: Can receive messages from other loggers and pipes. Users will call the log functions.
  • FilteringPipe: Filters messages by level and forwards them to another pipe.
  • BroadcastPipe: Broadcasts messages to multiple pipes.
  • BufferedPipe: Buffers messages and forwards them to another pipe.

Sinks

All sinks are also pipes.

  • ConsoleSink: Outputs messages to stderr and stdout. Does not support colors.
  • ConsoleRichSink: Outputs messages to the godot Output console. Supports colors.
  • DirSink: Outputs messages to log files and rotates them. Uses a thread for file io.
  • MemoryWindowSink: Keeps n log messages in memory. Can be used to display the last n messages in a GUI. BBCode color support can be configured.

Custom Sinks/Pipes

Classes ending in Pipe are sinks that forward messages to another sink. Classes ending in Sink write messages to a destination.

To create a custom pipe or sink extend the Log.LogPipe or Log.LogSink respectively and implement the methods.

class MyCustomSink extends Log.LogSink:
  # LogPipe and LogSink functions below

  ## Write many log records to the sink
  func write_bulks(p_log_records: Array[Dictionary], p_formatted_messages: PackedStringArray) -> void:
    pass
  ## Flushes the buffer of the sink if it has one.
  func flush_buffer() -> void:
    pass
  ## Cleans up resources used by the sink.
  func close() -> void:
    pass

  # LogSink specific functions below

  ## Sets the log record formatter.
  func set_log_record_formatter(p_log_record_formatter: LogRecordFormatter) -> void:
    pass
  ## Gets the log record formatter.
  func get_log_record_formatter() -> LogRecordFormatter:
    pass

Custom Formatters

class MyLogRecordFormatter extends Log.LogRecordFormatter:
  func format(log_record: Dictionary, p_sink_capabilties: Dictionary) -> String:
    # currently only the bbcode capability is used but user sinks can add their own capabilities

    var time_unix: float = log_record["time_unix"]
    var level: Log.LogLevel = log_record["level"]
    var unformatted_message: String = log_record["unformatted_message"]

    var time_str: String = Time.get_date_string_from_unix_time(time_unix)
    var level_str := Log.get_level_name(level)
    var formatted_message := "[%s] [%s] %s" % [
      time_str,
      level_str,
      unformatted_message
    ]
    return formatted_message
# Loggers use the global formatter by default but this can be overridden in the constructor.
Log.set_log_record_formatter(MyLogRecordFormatter.new())

Installation

cd <godot_project_dir>
cd addons
git submodule add [email protected]:raldone01/godot_addon_gdlogging.git gdlogging
cd gdlogging
git checkout v2.0.0

Project -> Project Settings -> Plugins -> gdlogging -> Activate

Autoloads are a bit janky so you may need to restart the editor for errors to go away.

Troubleshooting

Caution

Deleting the .godot directory has the potential to cause data loss. Make sure to back up your project before doing so and carefully research the implications.

If there are errors when loading the plugin that persist after restarting the editor, try deleting the .godot directory in the project directory.

Licensing

Marked parts are licensed under the LICENSE-godot-logger.md (MIT) license. The rest is licensed under LICENSE.md (MIT).