Register seelog log formatter before using it #4718
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
The ECS init service was encountering a "format error: unrecognized formatter at 1: InitLogfmt" error during startup. This occurred because the custom formatter InitLogfmt was being used in the seelog configuration before it was registered with the seelog library. This fixes #4680.
Root Cause Analysis
The issue was in the initialization sequence in the
Setup()
function inlogger/log.go
:SetLogLevel()
SetLogLevel()
internally calledreloadConfig()
, which tried to use theInitLogfmt
formatterseelog.RegisterCustomFormatter()
Implementation details
Reordered the initialization sequence in the
Setup()
function to:This ensures that the formatter is registered before any attempt to use it in the logging configuration.
Testing
The fix was tested by:
New tests cover the changes: no
Description for the changelog
Fixed "unrecognized formatter" error by registering custom log formatter before loading seelog configuration.
Additional Information
Does this PR include breaking model changes? If so, Have you added transformation functions?
No
Does this PR include the addition of new environment variables in the README?
No
Licensing
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.