Logger
An asset by ApolloX
Install Asset
Install via Godot
To maintain one source of truth, Godot Asset Library is just a mirror of the old asset library so you can download directly on Godot via the integrated asset library browser
Quick Information
Logger
This tool provides a node called 'Logger' which allows a file based logging. (Quite similar to Python's logging module)All while providing mass flexibility yet retaining a bit of power.Allows customization while in the Godot editor.
Supported Engine Version
3.3
Version String
1.3
License Version
MIT
Support Level
community
Modified Date
3 years ago
Git URL
Issue URL
Logger
A filebased logging plugin, for Godot game engine.
Setup
Assuming you have this plugin installed into Godot.
Need help installing a plugin? Try HERE
From there simply active the plugin, then add a Logger node to your scene.
Configuration
If you've used the Godot editor to create the Logger node then you can simply use the inspector.
| Value | Type | Description |
|---|---|---|
| Persist Log | Bool | Does the log file get cleared on start of the scene/instance/use of logging? |
| File Dir | String | The path to store the log file. |
| File Name | String | The name of the log file. (See Format Template section for help on what {dt} means) |
| File Name Time Format | String | Defines {dt} in File Name. (See Format Template section for help on what {dt} means) |
| Formatting | String | The format of all logging lines (I.E. 09-01-2020 01:00:00 PM DEBUG A Debug Statement.) |
| Time Format | String | The format of {dt} for in Formatting. |
| Debug | Bool | Do we log debug statements/calls. |
| Info | Bool | Do we log info statements/calls. |
| Warn | Bool | Do we log warn/warning statements/calls. |
| error | Bool | Do we log error statements/calls. |
| Crit | Bool | Do we log crit/critical statements/calls. |
Format Template
This allows fully customised log files.
| Value | Description |
|---|---|
| dt | Typically used to indicate date time stamp. (Once defined) |
| level | The logging level (DEBUG, INFO, WARN, ERROR, CRITICAL) |
| msg | The message passed to one of the logging statements/calls. |
| month | The current month as 2 digits. (I.E. January is 01) |
| day | The current day as 2 digits. (I.E. First day of the month is 01) |
| year | The current year as 4 digits. (I.E. 2000 is 2000) |
| 24hour | The current hour as 24 hour (Millitary time), as 2 digits. (I.E. 1 PM is 13) |
| 12hour | The current hour as 12 hour (Use ampm to add the AM/PM), as 2 digits. (I.E. 1 PM is 01) |
| min | The current minute as 2 digits. (I.E. 5 minutes is 05) |
| sec | The current second as 2 digits. (I.E. 2 seconds is 02) |
| ampm | A string describing if it's AM or PM. (Only use with 12hour, it will be invisible if no 12hour in format) |
dt is used to abreviate date time in File Name, and Formatting.
Contact me
Please leave an issue/bug report if anything goes wrong or you come up with some other suggestions/feature requests.
Credits
Logging.pngwas based off of Node from the Godot game engine.
This tool provides a node called 'Logger' which allows a file based logging. (Quite similar to Python's logging module)
All while providing mass flexibility yet retaining a bit of power.
Allows customization while in the Godot editor.
Reviews
Quick Information
Logger
This tool provides a node called 'Logger' which allows a file based logging. (Quite similar to Python's logging module)All while providing mass flexibility yet retaining a bit of power.Allows customization while in the Godot editor.
Supported Engine Version
3.3
Version String
1.3
License Version
MIT
Support Level
community
Modified Date
3 years ago
Git URL
Issue URL