[APM] Add custom spans around async operations #90403
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
dgieselaar
added
release_note:skip
|
@elasticmachine merge upstream |
|
Pinging @elastic/apm-ui (Team:apm) |
💛 Build succeeded, but was flaky
Test FailuresKibana Pipeline / general / Chrome X-Pack UI Functional Tests.x-pack/test/functional/apps/ingest_pipelines/feature_controls/ingest_pipelines_security·ts.Ingest pipelines app feature controls security global dashboard all with ingest_pipelines_user should render the "Ingest" section with ingest pipelinesStandard OutStack TraceMetrics [docs]
History
To update your PR or re-run it, just comment with: |
packages/kbn-apm-utils/src/index.ts
Outdated
| return promise | ||
| .then( | ||
| (res) => { | ||
| span.outcome = 'success'; |
There was a problem hiding this comment.
hmmm not sure about this one. As outcome changes based on status code and the code here is based on the promise being resolved or rejected. Would double check with the current behaviour.
There was a problem hiding this comment.
To me this looks ok.
As outcome changes based on status code and the code here is based on the promise being resolved or rejected.
Isn't it rather: "transaction outcome changes based on status code."
So a transaction outcome doesn't depend on span outcome and vice versa. If a span fails it will only also fail the transaction if the error is not caught. Conversely, if a span succeeds, any other span could fail, causing the transaction to fail too.
There was a problem hiding this comment.
spans can also result in http requests, for instance when calling an external service (ie, spans can have outcomes based on status code as well). But this function wraps async operations, and it is the responsibility of that operation to reject or resolve based on its interpretation of the results. Interpreting requests is out of scope for this function.
packages/kbn-apm-utils/src/index.ts
Outdated
|
|
||
| const resource = new asyncHooks.AsyncResource('fake_async'); | ||
|
|
||
| return resource.runInAsyncScope(() => { |
There was a problem hiding this comment.
Pretty sure this would work for promise based cb, Did you happen to investigate if this wrapper works for callback based functions as well?
|
@elasticmachine merge upstream |
sorenlouv
approved these changes
Feb 11, 2021
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
spalger
added a commit
to spalger/kibana
that referenced
this pull request
Feb 13, 2021
This reverts commit a28318e.
dgieselaar
added a commit
to dgieselaar/kibana
that referenced
this pull request
Feb 13, 2021
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
dgieselaar
added a commit
that referenced
this pull request
Feb 13, 2021
18 tasks
Merged
5 tasks
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.
Closes #86460.
Provides a
withSpanutility that wraps an async operation in a custom span.As almost every API call consists of multiple consecutive or parallel ES requests to various ES endpoints, it's hard to see from a trace waterfall what's triggering an ES request and what the intent is. There are also some issues in the Node.js agent where the semantics around span relationships (parent-child or sibling) are not always clear and might not work as expected.
To workaround these issues the
withSpanhelper starts a span, and creates a new async context for the async operation we want to track, essentially isolating it from other async operations, in order to have sane parent-child relationships.See also:
elastic/apm-agent-nodejs#1964
elastic/apm-agent-nodejs#1963
elastic/apm-agent-nodejs#1889
Here's how a /api/apm/services transaction looks without the custom instrumentation:
And here's with custom instrumentation (collapsing the app spans):
