Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(instrumentation-xhr): add applyCustomAttributesOnSpan hook #2134

Merged
merged 10 commits into from
Apr 25, 2021
Merged

feat(instrumentation-xhr): add applyCustomAttributesOnSpan hook #2134

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c18084f
feat(instrumentation-xhr): add applyCustomAttributesOnSpan
mhennoch Apr 20, 2021
5f002b5
Use a type not an interface
mhennoch Apr 21, 2021
9b85f2c
Check that hook is a function
mhennoch Apr 21, 2021
b5bbf47
fix: lint
mhennoch Apr 21, 2021
cdce70d
Update packages/opentelemetry-instrumentation-xml-http-request/test/x…
mhennoch Apr 22, 2021
3864643
Update packages/opentelemetry-instrumentation-xml-http-request/test/x…
mhennoch Apr 22, 2021
e68e5bc
Update packages/opentelemetry-instrumentation-xml-http-request/test/x…
mhennoch Apr 22, 2021
abbe3d8
Update packages/opentelemetry-instrumentation-xml-http-request/test/x…
mhennoch Apr 22, 2021
37dffef
Merge branch 'main' into xhr-hook
mhennoch Apr 23, 2021
e4c8e33
Merge branch 'main' into xhr-hook
vmarchaud Apr 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions packages/opentelemetry-instrumentation-xml-http-request/src/xhr.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {
isWrapped,
InstrumentationBase,
InstrumentationConfig,
safeExecuteInTheMiddle,
} from '@opentelemetry/instrumentation';
import { hrTime, isUrlIgnored, otperformance } from '@opentelemetry/core';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
Expand All @@ -45,6 +46,11 @@ import { AttributeNames } from './enums/AttributeNames';
// safe enough
const OBSERVER_WAIT_TIME_MS = 300;

export type XHRCustomAttributeFunction = (
span: api.Span,
xhr: XMLHttpRequest
) => void;

/**
* XMLHttpRequest config
*/
Expand All @@ -64,6 +70,8 @@ export interface XMLHttpRequestInstrumentationConfig
* also not be traced.
*/
ignoreUrls?: Array<string | RegExp>;
/** Function for adding custom attributes on the span */
applyCustomAttributesOnSpan?: XHRCustomAttributeFunction;
}

/**
Expand Down Expand Up @@ -171,6 +179,24 @@ export class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRe
}
}

private _applyAttributesAfterXHR(span: api.Span, xhr: XMLHttpRequest) {
const applyCustomAttributesOnSpan = this._getConfig()
.applyCustomAttributesOnSpan;
if (typeof applyCustomAttributesOnSpan === 'function') {
safeExecuteInTheMiddle(
() => applyCustomAttributesOnSpan(span, xhr),
error => {
if (!error) {
return;
}

api.diag.error('applyCustomAttributesOnSpan', error);
},
true
);
}
}

/**
* will collect information about all resources created
* between "send" and "end" with additional waiting for main resource
Expand Down Expand Up @@ -398,6 +424,10 @@ export class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRe
xhrMem.status = xhr.status;
xhrMem.statusText = xhr.statusText;
plugin._xhrMem.delete(xhr);

if (xhrMem.span) {
plugin._applyAttributesAfterXHR(xhrMem.span, xhr);
}
const endTime = hrTime();

// the timeout is needed as observer doesn't have yet information
Expand Down
Loading