https://github.com/frozen-projects/runtimelogger
UE5 runtime logger plugin for shipping builds without third party dependency.
https://github.com/frozen-projects/runtimelogger
error-monitoring error-reporting log logger logging runtime shipping ue5 ue5-plugin ue5-project ue5-template
Last synced: 10 months ago
JSON representation
UE5 runtime logger plugin for shipping builds without third party dependency.
- Host: GitHub
- URL: https://github.com/frozen-projects/runtimelogger
- Owner: Frozen-Projects
- License: other
- Created: 2025-08-10T15:33:41.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-10T15:58:32.000Z (10 months ago)
- Last Synced: 2025-08-10T17:29:24.766Z (10 months ago)
- Topics: error-monitoring, error-reporting, log, logger, logging, runtime, shipping, ue5, ue5-plugin, ue5-project, ue5-template
- Language: C++
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RuntimeLogger
## Description
This plugin allows you to store, write, visualize your runtime generated logs from various threads and create notifications about them. It is blueprint exposed.
## Workflow
- Log Manager (Blueprint Exposed) is a UGameInstanceSubsystem (Runtime Logger Subsystem). So, it doesn't affected from level changes, access from everywhere and have singleton, centralized design.
- Log Message (Blueprint Exposed) function uses ``TQueue`` for gathering your messages from every thread without race condition. Each message is a ``json object``. You can define your own structure but it has automatic ``UUID (FGuid based)``, ``LogTime (FDateTime::Now())`` and ``LogLevel (ERuntimeLogLevels custom enum)`` parameters. We suggest you to add ``Plugin Name (or module name)``, ``ClassName`` and ``FunctionName`` parameters. If you use ``C++`` you can use ``__FUNCSIG__`` for function name. It automatically add class and function name.
- Record Message function is a public C++ function which running on FRunnableThread. So, it won't affect game thread performance even if there are lots of logs. It stores your log in a private ``TMap`` which you can access with getters. Key is ``UUID`` and Value is ``other parameters than UUID``. It also writes a text file at your project's save directory with ``ProjectName_RuntimeLogger_Date.log``. File structure is a ``json object array``. If you want to use that file before closing your game, you have to put ``]`` at the end. After closing it, function automatically adds it. We did like this because each entry appends that text file. We don't want to open and close it everytime because performance reasons. It has a delegate that can inform you about generated log. Its execution chain comes from ``AsyncTask(GameThread)`` So, you can safely create a widget from it or you can add furthere features like API callings, e-mails senders or databases drivers to write logs to other services.
We did this plugin especially for shipping builds.
## Tutorial
You can look at plugin's content folder. You will see sample blueprints.
## Platform Support
I didn't use any platform specific code. So, it should work with any platform. But I have only Windows and Android devices. So, I can't give support about other platforms especially for their editor side.
## Engine Support
I don't support ``UE4`` and older versions than ``latest version``. I will update version ``after one month`` of new major release.