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

Fix Fetch and XHR instrumentation to use anchored clock #3320

Closed
wants to merge 1 commit into from
Closed

Fix Fetch and XHR instrumentation to use anchored clock #3320

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 5 additions & 1 deletion api/src/trace/NonRecordingSpan.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/

import { Exception } from '../common/Exception';
import { TimeInput } from '../common/Time';
import { HrTime, TimeInput } from '../common/Time';
import { SpanAttributes } from './attributes';
import { INVALID_SPAN_CONTEXT } from './invalid-span-constants';
import { Span } from './span';
Expand Down Expand Up @@ -72,4 +72,8 @@ export class NonRecordingSpan implements Span {

// By default does nothing
recordException(_exception: Exception, _time?: TimeInput): void {}

currentTime(): HrTime {
return [0, 0];
}
}
8 changes: 7 additions & 1 deletion api/src/trace/span.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/

import { Exception } from '../common/Exception';
import { TimeInput } from '../common/Time';
import { HrTime, TimeInput } from '../common/Time';
import { SpanAttributes, SpanAttributeValue } from './attributes';
import { SpanContext } from './span_context';
import { SpanStatus } from './status';
Expand Down Expand Up @@ -126,4 +126,10 @@ export interface Span {
* use the current time.
*/
recordException(exception: Exception, time?: TimeInput): void;

/**
* Returns current time based on the anchored clock.
* Used to snapshot time when the span has to be ended later.
*/
currentTime(): HrTime;
}
8 changes: 4 additions & 4 deletions experimental/packages/opentelemetry-instrumentation-fetch/src/fetch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ export class FetchInstrumentation extends InstrumentationBase<Promise<Response>>
spanData: SpanData,
response: FetchResponse
) {
const endTime = core.hrTime();
const endTime = span.currentTime();
this._addFinalSpanAttributes(span, response);

setTimeout(() => {
Expand Down Expand Up @@ -308,7 +308,8 @@ export class FetchInstrumentation extends InstrumentationBase<Promise<Response>>
if (!createdSpan) {
return original.apply(this, args);
}
const spanData = plugin._prepareSpanData(url);
const startTime = createdSpan.currentTime();
const spanData = plugin._prepareSpanData(url, startTime);

function endSpanOnError(span: api.Span, error: FetchError) {
plugin._applyAttributesAfterFetch(span, options, error);
Expand Down Expand Up @@ -427,8 +428,7 @@ export class FetchInstrumentation extends InstrumentationBase<Promise<Response>>
* resources
* @param spanUrl
*/
private _prepareSpanData(spanUrl: string): SpanData {
const startTime = core.hrTime();
private _prepareSpanData(spanUrl: string, startTime: api.HrTime): SpanData {
const entries: PerformanceResourceTiming[] = [];
if (typeof PerformanceObserver !== 'function') {
return { entries, startTime, spanUrl };
Expand Down
6 changes: 3 additions & 3 deletions experimental/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 @@ -21,7 +21,7 @@ import {
InstrumentationConfig,
safeExecuteInTheMiddle,
} from '@opentelemetry/instrumentation';
import { hrTime, isUrlIgnored, otperformance } from '@opentelemetry/core';
import { isUrlIgnored, otperformance } from '@opentelemetry/core';
import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
import {
addSpanNetworkEvents,
Expand Down Expand Up @@ -431,7 +431,7 @@ export class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRe
if (xhrMem.span) {
plugin._applyAttributesAfterXHR(xhrMem.span, xhr);
}
const endTime = hrTime();
const endTime = xhrMem.span?.currentTime();

// the timeout is needed as observer doesn't have yet information
// when event "load" is called. Also the time may differ depends on
Expand Down Expand Up @@ -486,7 +486,7 @@ export class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRe
api.trace.setSpan(api.context.active(), currentSpan),
() => {
plugin._tasksCount++;
xhrMem.sendStartTime = hrTime();
xhrMem.sendStartTime = currentSpan.currentTime();
currentSpan.addEvent(EventNames.METHOD_SEND);

this.addEventListener('abort', onAbort);
Expand Down
4 changes: 4 additions & 0 deletions packages/opentelemetry-sdk-trace-base/src/Span.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,10 @@ export class Span implements api.Span, ReadableSpan {
return this._ended;
}

currentTime(): api.HrTime {
return timeInputToHrTime(this._clock.now());
}

private _isSpanEnded(): boolean {
if (this._ended) {
api.diag.warn(`Can not execute the operation on ended Span {traceId: ${this._spanContext.traceId}, spanId: ${this._spanContext.spanId}}`);
Expand Down