model: allow mixing Span/Transaction/Error/Metricset in APMEvent #6066
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
💚 Build Succeeded
Expand to view the summary
Build stats
Test stats 🧪
Trends 🧪 |
axw
force-pushed
the
model-transactionspanid
branch
4 times, most recently
from
7a005fc
to
f905dca
Compare
|
/test |
Refactor model types to bring them close to the produced Elasticsearch document structure: - introduce Parent; remove the ParentID fields from Transaction, Span, and Error - introduce Child; remove the ChildIDs field from from Span - allow more than one of Transaction, Span, Error, Metricset to be set in APMEvent; remove Span and Transaction fields from Metricset; remove TransactionID, TransactionSampled, and TransactionType fields from Error; remove TransactionID field from Span Various transaction and span fields are now only recorded if they have the non-zero value. We take care to still record zero durations, as the APM UI makes heavy use of this field and it is not unreasonable to expect a short span to be recorded as having a zero duration, on machines which have low resolution timers.
axw
force-pushed
the
model-transactionspanid
branch
from
f905dca
to
33f2dfd
Compare
simitt
approved these changes
Sep 1, 2021
| // Child holds information about the children of a trace event. | ||
| type Child struct { | ||
| // ID holds IDs of child events. | ||
| ID []string |
There was a problem hiding this comment.
nit: shouldn't this be named IDs?
There was a problem hiding this comment.
I named it after the Elasticsearch field, which is child.id -- a keyword field which naturally allows multiple values.
mergify bot
pushed a commit
that referenced
this pull request
Sep 1, 2021
Refactor model types to bring them close to the produced Elasticsearch document structure: - introduce Parent; remove the ParentID fields from Transaction, Span, and Error - introduce Child; remove the ChildIDs field from from Span - allow more than one of Transaction, Span, Error, Metricset to be set in APMEvent; remove Span and Transaction fields from Metricset; remove TransactionID, TransactionSampled, and TransactionType fields from Error; remove TransactionID field from Span Various transaction and span fields are now only recorded if they have the non-zero value. We take care to still record zero durations, as the APM UI makes heavy use of this field and it is not unreasonable to expect a short span to be recorded as having a zero duration, on machines which have low resolution timers. (cherry picked from commit 12bf386) # Conflicts: # changelogs/head.asciidoc
axw
added a commit
that referenced
this pull request
Sep 2, 2021
…t (backport #6066) (#6107) * model: further align types with document structure (#6066) Refactor model types to bring them close to the produced Elasticsearch document structure: - introduce Parent; remove the ParentID fields from Transaction, Span, and Error - introduce Child; remove the ChildIDs field from from Span - allow more than one of Transaction, Span, Error, Metricset to be set in APMEvent; remove Span and Transaction fields from Metricset; remove TransactionID, TransactionSampled, and TransactionType fields from Error; remove TransactionID field from Span Various transaction and span fields are now only recorded if they have the non-zero value. We take care to still record zero durations, as the APM UI makes heavy use of this field and it is not unreasonable to expect a short span to be recorded as having a zero duration, on machines which have low resolution timers. (cherry picked from commit 12bf386) # Conflicts: # changelogs/head.asciidoc * Delete head.asciidoc Co-authored-by: Andrew Wilkins <axw@elastic.co>
marclop
added
backport-skip
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
Allow multiple of
Span,Transaction,Error, andMetricsetfields to be set, e.g. to settransaction.idon a span event, ortransaction.namefor breakdown metrics. This moves the model types another step closer to how the Elasticsearch documents are structured, and another step towards auto-generating the JSON/beat event encoding.Remove
{Span,Transaction,Error}.ParentID, introduceAPMEvent.Parent; removeSpan.ChildIDs, introduceAPMEvent.Child.Remove
{Span,Error}.TransactionIDandMetricset.{Span,Transaction}. These are replaced by settingAPMEvent.TransactionandAPMEvent.Span.Only set
transaction.sampledfor sampled transactions; UI only ever uses it in the querytransaction.sampled: true. This change is to avoid addingtransaction.sampled: falseto non-transaction events.Checklist
- [ ] Documentation has been updatedHow to test these changes
Should be non-functional change. Make sure the APM UI still functions.
Related issues
#4120