Add ECS information to logger instance #18820
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Derive information whether ECS logging is enabled from any logger instance as requirement to make decisions about logging keys to use. closes elastic#18815
botelastic
bot
added
the
needs_team
simitt
added
enhancement
Team:Platforms
|
Pinging @elastic/integrations-platforms (Team:Platforms) |
botelastic
bot
removed
the
needs_team
exekias
added
Team:Integrations
5 tasks
❕ Build Aborted
Expand to view the summary
Build stats
Test stats 🧪
Test errorsExpand to view the tests failures
--------------------- >> end captured stdout << ---------------------- Steps errorsExpand to view the steps failures
Log outputExpand to view the last 100 lines of log output
|
|
test failures seem unrelated |
|
@urso I'd appreciate a review on this. |
|
Why do we want developers to check if ecs enabled? We should encourage structured logging always, but with this check it looks like we will encourage developers to use different 'schemas'. With the current state of structured logging in Beats would we consider a log field being renamed to ECS a breaking change? |
|
IMO renaming a field would be fine, but some changes could lead to type changes, e.g. an when an error was logged as |
|
The error type is internal to logp, right? You think we will have other breaking changes right in Beats/apm-server? |
|
Eg. if the logger is used like this When shipping such logs to ES one would need a new mapping for |
|
After some further discussions, closing this PR. At the moment there is no commitment for not changing the logging format or structure, therefore we will not add the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
The PR adds a
ECSEnabled()method to*logp.Loggerinstances.Why is it important?
Since introducing the
logging.ecssetting some minimal required information is logged in ECS format when enabled. To continue work for ECS conformant logging without introducing conflicts with existing log formats, developers need to be able to check for ECS being enabled or not whenever they log information.Checklist
- [ ] I have commented my code, particularly in hard-to-understand areas- [ ] I have made corresponding changes to the documentation- [ ] I have made corresponding change to the default configuration files- [ ] I have added an entry inCHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.How to test this PR locally
run
go test ./libbeat/logp/...Related issues