Document event.dataset and clarify service.id/service.name for ECH/ECE logging - #8159
Draft
rseldner wants to merge 2 commits into
Draft
Document event.dataset and clarify service.id/service.name for ECH/ECE logging#8159rseldner wants to merge 2 commits into
rseldner wants to merge 2 commits into
Conversation
Clarified logging field descriptions and added `event.dataset` details across the doc. - Field table: added `event.dataset` row, expanded `service.name` for APM/Fleet Server, added filtering explainer - Elasticsearch: added dataset values to existing bullets (audit, slowlog, verbose), added new GC and deprecation bullets - Kibana: added dataset values for standard and audit logs - Other components: noted APM/Fleet Server/Agent share `agent.log`, with `service.name` as the differentiator
Updated descriptions for `service.id` and `service.name` fields to clarify their usage and reliability in log identification. Clarified `service.type` can hold multiple values.
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
Elastic Docs Style Checker (Vale)Summary: 1 warning, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/stack-monitoring/ece-ech-stack-monitoring.md | 131 | Elastic.DontUse | Don't use 'just'. Choose a more precise or reader-focused term. |
💡 Suggestions (1): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/stack-monitoring/ece-ech-stack-monitoring.md | 112 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
This file contains hidden or 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
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.
Clarified logging field descriptions and added
event.datasetdetails across the doc.event.datasetrow, expandedservice.namefor APM/Fleet Server, added filtering explainerservice.idas the reliable field for identifying a deployment; service.name is inconsistently populated across {{es}} log categories and reflects the component (not the deployment) for APM/Fleet Serveservice.typecan hold multiple values on a single log entry (for example,[agent, fleet-server])agent.log, withservice.nameas the differentiator and thatservice.type/service.namecan be multivalued on these logs.Supporting info from a
9.5.2deployment:☝️ did not yet add
deployment.nameto doc as it does not appear outside ofservice.type: elasticsearch. But then again ,it is better thanservice.namefor elasticsearch logs.Summary
Generative AI disclosure