Make ecs.version a constant_keyword field #9208
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
axw
added
backport-skip
axw
force-pushed
the
integration-ecs-version
branch
from
3cabd0c to
573c83b
Compare
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
🤖 GitHub commentsExpand to view the GitHub comments
To re-run your PR in the CI, just comment with:
|
axw
force-pushed
the
integration-ecs-version
branch
2 times, most recently
from
3dce14d to
79e33a2
Compare
📚 Go benchmark reportDiff with the report generated with https://pkg.go.dev/golang.org/x/perf/cmd/benchstat |
Instead of adding `ecs.version` as a field in every document written by APM Server, make it a constant_keyword field and set its version in the data stream mappings. The data stream's ingest pipeline is responsible for upgrading documents to the expected format, so it follows that the integration package (ingest pipeline, mappings) should define the ECS version. We're currently pinning to a recent commit of ECS due to our reliance on the unreleased `device.*` fields. When they are released, we should update to the released version.
axw
force-pushed
the
integration-ecs-version
branch
from
79e33a2 to
cad1dfa
Compare
|
This pull request is now in conflicts. Could you fix it @axw? 🙏 |
simitt
reviewed
Sep 27, 2022
There was a problem hiding this comment.
Generally LGTM!
@axw checking to see if I fully grasp the intended upgrade flow here: The apm package sets the ecs version, whenever the package gets upgraded, the templates get created and data streams are rolled over; therefore the ecs version is set on package upgrade. If there are still older apm-server instances sending to ES, there are no conflicts expected, as ecs related changes are expected to be backwards compatible and follow the stack versioning. Correct?
Right. Hypothetically if there were a breaking change in ECS, then we would update our ingest pipelines to "upgrade" the docs coming from older APM Servers so they conform to the |
|
This pull request is now in conflicts. Could you fix it @axw? 🙏 |
simitt
approved these changes
Sep 28, 2022
v1v
added a commit
to v1v/apm-server
that referenced
this pull request
Sep 29, 2022
…ored * upstream/main: smoke: Remove usage of artifacts API (elastic#9233) Update to elastic/beats@77e4e30df6e2 (elastic#9227) Enable synthetic source for metrics data streams (elastic#9215) testing/rally: add force-merge operation (elastic#9226) Make ecs.version a constant_keyword field (elastic#9208)
|
Tested with BC5 that the index templates have the |
|
Package apm - 8.6.0-preview-1670294014 containing this change is available at https://epr.elastic.co/search?package=apm |
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.
Motivation/summary
Instead of adding
ecs.versionas a field in every document written by APM Server, make it a constant_keyword field and set its version in the data stream mappings. This means thatecs.versionwill not be available in_source, and will only be available through the Elasticsearch fields API. Nothing usesecs.versionyet, so it doesn't matter in practice.The data stream's ingest pipeline is responsible for upgrading documents to the expected format, so it follows that the integration package (ingest pipeline, mappings) should define the ECS version. Given that nothing currently relies on
ecs.version, the pipelines now simply drop anyecs.versionfield defined in the incoming document, in favour of theconstant_keywordvalue.We're currently pinning to a recent commit of ECS due to our reliance on the unreleased
device.*fields. When they are released, we should update to the released version.Checklist
apmpackagehave been made)- [ ] Documentation has been updatedHow to test these changes
ecs.versionsetRelated issues
Closes #9043