Add ECS logging MVP to libbeat #17974
Merged
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
andresrc
added
[zube]: Inbox
[zube]: In Review
Team:apm
|
Pinging @elastic/integrations (Team:Integrations) |
urso
reviewed
Apr 28, 2020
libbeat/logp/config.go
Outdated
| JSON bool `config:"json"` // Write logs as JSON. | ||
| Level Level `config:"level"` // Logging level (error, warning, info, debug). | ||
| Selectors []string `config:"selectors"` // Selectors for debug level logging. | ||
| ECSEnabled bool `config:"ecs"` |
There was a problem hiding this comment.
we want to enable this setting by default?
There was a problem hiding this comment.
I would consider changing the default a breaking change, as it changes the log format.
There was a problem hiding this comment.
Do you mind adding a comment to describe what this option does?
There was a problem hiding this comment.
good point - added a comment
💔 Build Failed
Expand to view the summary
Build stats
Test stats 🧪
Test errorsExpand to view the tests failures
Steps errorsExpand to view the steps failures
Log outputExpand to view the last 100 lines of log output
|
Enable ECS conformant logging by setting `logging.ecs:true` Adds @timestamp, log.level, message and ecs.version to every log line. If EnableCaller is set add log.origin.file and log.origin.line. Logs error.message when error is given implements elastic#17942
|
Test failures are unrelated and also observed in beats |
|
@urso I just updated to the latest master, would appreciate a review. |
💔 Build Failed
Expand to view the summary
Build stats
Test stats 🧪
Log outputExpand to view the last 100 lines of log output
|
kvch
approved these changes
May 5, 2020
|
The run on jenkins was green, but failed when reporting the results. |
urso
approved these changes
May 5, 2020
|
Thank you both for the review. |
zube
bot
added
[zube]: Done
test-plan
simitt
added a commit
to simitt/beats
that referenced
this pull request
May 5, 2020
Enable minimal ECS conformant logging by setting `logging.ecs:true`: * adds @timestamp, log.level, message and ecs.version to every log line * if EnableCaller is set add log.origin.file and log.origin.line. * logs error.message when error is given implements elastic#17942
simitt
added a commit
that referenced
this pull request
May 5, 2020
Enable minimal ECS conformant logging by setting `logging.ecs:true`: * adds @timestamp, log.level, message and ecs.version to every log line * if EnableCaller is set add log.origin.file and log.origin.line. * logs error.message when error is given implements #17942
andresrc
added
test-plan-added
This was referenced May 28, 2020
|
@urso, @kvch this PR was backported to |
|
Hm, when do you plan to make it the default? At least when running via Agent we should have ECS enabled by default. |
|
Why experimental? If we mark the feature experimental, it implies (at least to me) that we might get rid of the feature or change it completely. But if I understand correctly this is the final format, we are just adding more fields in later releases. However, I agree we should flag it somehow. So I would rather go with beta. Unless of course, the this functionality is subject to change. |
|
My concern is that this adds a minimal set of ECS fields for now. It doesn't ensure that all log messages are ECS compatible, as this is still up to the implementer of the log messages. @kvch agreed, beta would be a better fit. I'd just like to avoid the assumption that as soon as you set |
++ Is it the default already when running under agent? If not, is there a follow-up issue tracking this? |
andrewvc
reviewed
Nov 30, 2020
Closed
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?
Enable ECS conformant logging by setting
logging.ecs:trueAdds @timestamp, log.level, message and ecs.version to every log line.
If EnableCaller is set add log.origin.file and log.origin.line.
Logs error.message when error is given
Why is it important?
Get started with ECS conformant logging
Checklist
- [ ] I have commented my code, particularly in hard-to-understand areasCHANGELOG.next.asciidocorCHANGELOG-developer.next.asciidoc.How to test this PR locally
Set different logging options (syslog, to_files, console) and enable
logging.jsonandlogging.ecsand check log lines contain@timestamp, message, log.level, ecs.version. Logged errors are logged in the format{ "error": { "message": .. } }. If caller is enabled it is logged aslog.origin.*.manually tested for
logging.to_files: truelogging.to_syslog: truelogging.to_stderr: true./beat -eRelated issues
implements #17942
Logs
Example: