[APM] Add custom spans around async operations #90403
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| { | ||
| "name": "@kbn/apm-utils", | ||
| "main": "./target/index.js", | ||
| "types": "./target/index.d.ts", | ||
| "version": "1.0.0", | ||
| "license": "SSPL-1.0 OR Elastic License 2.0", | ||
| "private": true, | ||
| "scripts": { | ||
| "build": "../../node_modules/.bin/tsc", | ||
| "kbn:bootstrap": "yarn build", | ||
| "kbn:watch": "yarn build --watch" | ||
| } | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0 and the Server Side Public License, v 1; you may not use this file except | ||
| * in compliance with, at your election, the Elastic License 2.0 or the Server | ||
| * Side Public License, v 1. | ||
| */ | ||
|
|
||
| import agent from 'elastic-apm-node'; | ||
| import asyncHooks from 'async_hooks'; | ||
|
|
||
| export interface SpanOptions { | ||
| name: string; | ||
| type?: string; | ||
| subtype?: string; | ||
| labels?: Record<string, string>; | ||
| } | ||
|
|
||
| export function parseSpanOptions(optionsOrName: SpanOptions | string) { | ||
| const options = typeof optionsOrName === 'string' ? { name: optionsOrName } : optionsOrName; | ||
|
|
||
| return options; | ||
| } | ||
|
|
||
| export function withSpan<T>(optionsOrName: SpanOptions | string, cb: () => Promise<T>): Promise<T> { | ||
| const options = parseSpanOptions(optionsOrName); | ||
|
|
||
| const { name, type, subtype, labels } = options; | ||
|
|
||
| if (!agent.isStarted()) { | ||
| return cb() as any; | ||
| } | ||
|
|
||
| const span = agent.startSpan(name); | ||
|
|
||
| if (!span) { | ||
| return cb() as any; | ||
| } | ||
|
|
||
| const resource = new asyncHooks.AsyncResource('fake_async'); | ||
|
|
||
| return resource.runInAsyncScope(() => { | ||
| // set the active span for the newly created async context | ||
| // @ts-ignore | ||
| agent._instrumentation.activeSpan = span; | ||
| if (type) { | ||
| span.type = type; | ||
| } | ||
| if (subtype) { | ||
| span.subtype = subtype; | ||
| } | ||
|
|
||
| if (labels) { | ||
| span.addLabels(labels); | ||
| } | ||
|
|
||
| const promise = cb(); | ||
|
|
||
| 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.
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. |
||
| return res; | ||
| }, | ||
| (err) => { | ||
| span.outcome = 'failure'; | ||
| throw err; | ||
| } | ||
| ) | ||
| .finally(() => { | ||
| span.end(); | ||
| resource.emitDestroy(); | ||
| }); | ||
| }); | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "extends": "../../tsconfig.base.json", | ||
| "compilerOptions": { | ||
| "declaration": true, | ||
| "outDir": "./target", | ||
| "stripInternal": false, | ||
| "declarationMap": true, | ||
| "types": [ | ||
| "node" | ||
| ] | ||
| }, | ||
| "include": [ | ||
| "./src/**/*.ts" | ||
| ], | ||
| "exclude": [ | ||
| "target" | ||
| ] | ||
| } |
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pretty sure this would work for promise based cb, Did you happen to investigate if this wrapper works for callback based functions as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you mean?