Enhance Log Entry and add unique code for ERROR & WARNING level by Trouffman · Pull Request #1256 · DistroAV/DistroAV

Trouffman · 2025-04-25T14:14:56Z

Additional reformatting of the Log entries for consistency & further add unique identifier for each unique ERROR/WARNING level.

Goal

Easier to search solution for a specific error
Less confusion between error log entries
Could help to automate basic support / log analysis
Numerical value is irrelevant to other similar 3digit error code (like HTTP)

What has been done

Further enhance previous Log Entry reformatting
All ERROR level message now have a unique identifier : "ERR-XXX"
All WARNING level messages now have a unique identifier : WARN-XXX

Format & consistency rules

WARN-XXX for LOG_WARNING level entries
ERR-XXX for any LOG_ERROR level entries
XXX is 3 digit
XXX does not relate to any other error code that exists (like HTTP Code)
Some XXX ID can be used of left for special (fun) purpose

like 404 when the NDI library is not found) but is discretionary

XXX value is unique across any LOG_LEVEL
If a downgrade from ERROR to WARNING : the 3 digits stay the same
If an upgrade from WARNING to ERROR : the 3 digits stay the same
If a downgrade to a non-WARNING/ERROR level, keep the log Entry ID. (INF-)

In some cases this can be move to the end of the log-entry
If not-upgraded within 12months AND more than 1 Major releases AND in need for cleanup : Code can be "retired" but must still be accessible for historical purposes (wiki?).

If the Message attached change : the ERROR code stay the same
Log Entry are Specific to the error / location in code / Trigger reason / Root cause. Therefore, If the code change, evaluate if this is the same error / log entry or a new one.
In case we go through more than 999 Error/warning ID... The project will be VERY successful, just add a digit.

To-Do

Add ERROR Code to the WIki for the relevant Issues / troubleshooting steps
Only use the code/ID, not the LOG-ENTRY message (easier to maintain)

List of all code in use as of this release

ERROR Code ID

ERR-400 - Failed to start NDI Main Output
ERR-411 - Failed to initialize NDI Main Output
ERR-412 - Failed to create NDI Main Output

ERR-410 - NDI Output cannot start : Unsupported pixel format

ERR-407 - Error creating the NDI Receiver
ERR-408 - Error creating the NDI Frame Sync
ERR-430 - NDI Source uses an unsupported video pixel format

ERR-404 - NDI library not found, DistroAV cannot continue
ERR-401 - NDI library failed to load
ERR-403 - OBS-NDI is detected and needs to be uninstalled before DistroAV can work
ERR-406 - NDI library could not initialize due to unsupported CPU
ERR-405 - Error loading the NDI Library from path
ERR-402 - Error loading QLibrary with error

ERR-409 - Check for update failed: Cannot get the main OBS window

Warning Code ID

WARN-413 - NDI Output could not start. No Audio/Video data available.
WARN-415 - NDI Sender data capture failed
WARN-416 - NDI Sender initialisation failed

WARN-414 - Invalid or unknown behavior detected in config file
WARN-423 - Failed to create NDI Preview Output

Update Error Code that might need rework.
WARN-417 - Update Check received a non-expected response
WARN-418 - Update Check took too long for a response
WARN-419 - Update Check request failed
WARN-421 - Update Check could not open the update file
WARN-422 - Update Check could not verify the update file

…add unique identifier for each unique ERROR/WARNING level.

…ry ID

Copilot

Pull Request Overview

This PR enhances logging consistency by embedding unique error and warning codes across various modules to aid in the search for and analysis of log entries. Key changes include:

Prefixing log messages with specific error/warning codes (e.g. ERR-XXX and WARN-XXX) for ERROR and WARNING levels.
Standardizing log message text to use consistent capitalization for “NDI Main Output”.
Updating log levels and messages across multiple files (preview output, update, ndi-source, ndi-output, etc.) for better clarity.

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
src/preview-output.cpp	Updated log messages with unique warning code (WARN-423) and added a debug log on failure.
src/obs-support/shared-update.cpp	Replaced generic warning messages with codes (WARN-421, WARN-422) for update file issues.
src/obs-support/remote-text.cpp	Revised log messages with warning (WARN-419) and added a debug log for HTTP request failures.
src/ndi-source.cpp	Changed unsupported pixel format log to error (ERR-430) and added a warning (WARN-414) for config issues.
src/ndi-output.cpp	Updated log messages with codes (WARN-413, ERR-410, WARN-415, WARN-416) for proper reporting.
src/main-output.cpp	Standardized log text for “NDI Main Output” and introduced error codes (ERR-400, ERR-411, ERR-412).
src/forms/update.cpp	Updated log messages for update check timeouts and responses with codes (WARN-417, WARN-418).

Comments suppressed due to low confidence (3)

src/preview-output.cpp:241

[nitpick] There is a potential duplication in logging: immediately after logging the warning message, a debug message with similar content is issued. Consider consolidating these logs or clearly distinguishing their purposes to reduce redundancy.

obs_log(LOG_WARNING, "WARN-423 - Failed to create NDI Preview Output '%s'", QT_TO_UTF8(output_name));

src/ndi-source.cpp:926

[nitpick] A debug log is emitted immediately before a warning log (with WARN-414) for invalid config behavior. Consider either consolidating these logs or using a consistent log level to avoid potential confusion.

obs_log(LOG_DEBUG, "'... ndi_source_update: Invalid or unknown behavior detected :'%s' forced to '%d'", obs_source_name, behavior, PROP_BEHAVIOR_KEEP_ACTIVE);

src/forms/update.cpp:307

The log macro used is 'DEBUG', which is inconsistent with the other parts of the code that use 'LOG_DEBUG'. Using a consistent log level macro improves clarity.

obs_log(DEBUG, "onCheckForUpdateNetworkFinish: Error! httpStatusCode=%d, errorData='%s'; ignoring response", httpStatusCode, QT_TO_UTF8(pluginUpdateInfo.errorData));

…ERROR/WARNING level, rephrased log-entry for user-facing errors.

into tweak-logmessages

…ERROR/WARNING level, rephrased log-entry for user-facing errors.

into tweak-logmessages

Trouffman · 2025-05-04T17:20:00Z

src/forms/update.cpp

 	QObject::connect(timer, &QTimer::timeout, []() {
-		obs_log(LOG_WARNING, "updateCheckStart: timer: Request timed out");
+		obs_log(LOG_WARNING, "WARN-418 - Update Check took too long for a response");
+		PostToMainThread("timer->timeout", []() { updateCheckStop(); });


I need to check where this is coming from.

This is coming from an old commit : f3d6229

but flagged as new due to the changes in the lines counts / order

Trouffman added 3 commits April 25, 2025 09:10

Additionnal reformating of the Log entries for consistency & further …

0a8066d

…add unique identifier for each unique ERROR/WARNING level.

changed ERR-411 to ERR-400 to avoid duplicate use of the same log-ent…

b0e3914

…ry ID

Additional formating consistency and enforce uniqueness of log entry ID.

7463728

Trouffman added the enhancement label Apr 25, 2025

Trouffman added this to the 6.1.0 milestone Apr 25, 2025

Trouffman requested review from BitRate27 and Copilot April 25, 2025 14:14

Trouffman self-assigned this Apr 25, 2025

Copilot AI reviewed Apr 25, 2025

View reviewed changes

Trouffman added 8 commits April 25, 2025 10:15

clang formating

a850501

Uniformise Log entries format, add unique identifier for each unique …

cfb0ea0

…ERROR/WARNING level, rephrased log-entry for user-facing errors.

Merge branch 'tweak-logmessages' of https://github.com/DistroAV/DistroAV

b78ebda

into tweak-logmessages

Fix typo

7aa0650

more typo corrections

d36fe70

Uniformise Log entries format, add unique identifier for each unique …

a17042d

…ERROR/WARNING level, rephrased log-entry for user-facing errors.

Merge branch 'tweak-logmessages' of https://github.com/DistroAV/DistroAV

1255db1

into tweak-logmessages

Merge branch 'master' into tweak-logmessages

78e179b

Trouffman requested review from RayneYoruka and paulpv May 4, 2025 17:18

Trouffman commented May 4, 2025

View reviewed changes

Trouffman changed the title ~~Further enhance Log Entry and add unique code for ERROR & WARNING~~ Enhance Log Entry and add unique code for ERROR & WARNING level May 4, 2025

Trouffman merged commit 31f2caf into master May 4, 2025
6 checks passed

Trouffman deleted the tweak-logmessages branch May 4, 2025 17:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Enhance Log Entry and add unique code for ERROR & WARNING level#1256

Enhance Log Entry and add unique code for ERROR & WARNING level#1256
Trouffman merged 11 commits intomasterfrom
tweak-logmessages

Trouffman commented Apr 25, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Trouffman May 4, 2025

Uh oh!

Trouffman May 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Trouffman commented Apr 25, 2025

Goal

What has been done

Format & consistency rules

To-Do

List of all code in use as of this release

ERROR Code ID

Warning Code ID

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Trouffman May 4, 2025

Choose a reason for hiding this comment

Uh oh!

Trouffman May 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants