@opentelemetry/instrumentation-xml-http-request 0.222.0 → 0.300.0-development.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/README.md +13 -11
  2. package/dist/_virtual/_rolldown/runtime.cjs +23 -0
  3. package/dist/index.cjs +3 -0
  4. package/dist/index.d.cts +2 -0
  5. package/dist/index.d.mts +2 -0
  6. package/dist/index.mjs +2 -0
  7. package/dist/semconv.cjs +13 -0
  8. package/dist/semconv.cjs.map +1 -0
  9. package/dist/semconv.mjs +13 -0
  10. package/dist/semconv.mjs.map +1 -0
  11. package/dist/types.d.cts +31 -0
  12. package/dist/types.d.cts.map +1 -0
  13. package/dist/types.d.mts +31 -0
  14. package/dist/types.d.mts.map +1 -0
  15. package/dist/utils.cjs +86 -0
  16. package/dist/utils.cjs.map +1 -0
  17. package/dist/utils.mjs +82 -0
  18. package/dist/utils.mjs.map +1 -0
  19. package/dist/version.cjs +6 -0
  20. package/dist/version.cjs.map +1 -0
  21. package/dist/version.mjs +6 -0
  22. package/dist/version.mjs.map +1 -0
  23. package/dist/xhr.cjs +346 -0
  24. package/dist/xhr.cjs.map +1 -0
  25. package/dist/xhr.d.cts +134 -0
  26. package/dist/xhr.d.cts.map +1 -0
  27. package/dist/xhr.d.mts +134 -0
  28. package/dist/xhr.d.mts.map +1 -0
  29. package/dist/xhr.mjs +344 -0
  30. package/dist/xhr.mjs.map +1 -0
  31. package/package.json +36 -34
  32. package/build/esm/enums/EventNames.d.ts +0 -9
  33. package/build/esm/enums/EventNames.js +0 -14
  34. package/build/esm/enums/EventNames.js.map +0 -1
  35. package/build/esm/index.d.ts +0 -3
  36. package/build/esm/index.js +0 -6
  37. package/build/esm/index.js.map +0 -1
  38. package/build/esm/semconv.d.ts +0 -9
  39. package/build/esm/semconv.js +0 -18
  40. package/build/esm/semconv.js.map +0 -1
  41. package/build/esm/types.d.ts +0 -29
  42. package/build/esm/types.js +0 -6
  43. package/build/esm/types.js.map +0 -1
  44. package/build/esm/utils.d.ts +0 -14
  45. package/build/esm/utils.js +0 -118
  46. package/build/esm/utils.js.map +0 -1
  47. package/build/esm/version.d.ts +0 -2
  48. package/build/esm/version.js +0 -7
  49. package/build/esm/version.js.map +0 -1
  50. package/build/esm/xhr.d.ts +0 -131
  51. package/build/esm/xhr.js +0 -415
  52. package/build/esm/xhr.js.map +0 -1
  53. package/build/esnext/enums/EventNames.d.ts +0 -9
  54. package/build/esnext/enums/EventNames.js +0 -14
  55. package/build/esnext/enums/EventNames.js.map +0 -1
  56. package/build/esnext/index.d.ts +0 -3
  57. package/build/esnext/index.js +0 -6
  58. package/build/esnext/index.js.map +0 -1
  59. package/build/esnext/semconv.d.ts +0 -9
  60. package/build/esnext/semconv.js +0 -18
  61. package/build/esnext/semconv.js.map +0 -1
  62. package/build/esnext/types.d.ts +0 -29
  63. package/build/esnext/types.js +0 -6
  64. package/build/esnext/types.js.map +0 -1
  65. package/build/esnext/utils.d.ts +0 -14
  66. package/build/esnext/utils.js +0 -118
  67. package/build/esnext/utils.js.map +0 -1
  68. package/build/esnext/version.d.ts +0 -2
  69. package/build/esnext/version.js +0 -7
  70. package/build/esnext/version.js.map +0 -1
  71. package/build/esnext/xhr.d.ts +0 -131
  72. package/build/esnext/xhr.js +0 -415
  73. package/build/esnext/xhr.js.map +0 -1
  74. package/build/src/enums/EventNames.d.ts +0 -9
  75. package/build/src/enums/EventNames.js +0 -17
  76. package/build/src/enums/EventNames.js.map +0 -1
  77. package/build/src/index.d.ts +0 -3
  78. package/build/src/index.js +0 -10
  79. package/build/src/index.js.map +0 -1
  80. package/build/src/semconv.d.ts +0 -9
  81. package/build/src/semconv.js +0 -21
  82. package/build/src/semconv.js.map +0 -1
  83. package/build/src/types.d.ts +0 -29
  84. package/build/src/types.js +0 -7
  85. package/build/src/types.js.map +0 -1
  86. package/build/src/utils.d.ts +0 -14
  87. package/build/src/utils.js +0 -124
  88. package/build/src/utils.js.map +0 -1
  89. package/build/src/version.d.ts +0 -2
  90. package/build/src/version.js +0 -10
  91. package/build/src/version.js.map +0 -1
  92. package/build/src/xhr.d.ts +0 -131
  93. package/build/src/xhr.js +0 -419
  94. package/build/src/xhr.js.map +0 -1
package/dist/xhr.cjs ADDED
@@ -0,0 +1,346 @@
1
+ const require_runtime = require("./_virtual/_rolldown/runtime.cjs");
2
+ const require_semconv = require("./semconv.cjs");
3
+ const require_utils = require("./utils.cjs");
4
+ const require_version = require("./version.cjs");
5
+ let _opentelemetry_api = require("@opentelemetry/api");
6
+ _opentelemetry_api = require_runtime.__toESM(_opentelemetry_api);
7
+ let _opentelemetry_instrumentation = require("@opentelemetry/instrumentation");
8
+ let _opentelemetry_core = require("@opentelemetry/core");
9
+ let _opentelemetry_web_common = require("@opentelemetry/web-common");
10
+ let _opentelemetry_semantic_conventions = require("@opentelemetry/semantic-conventions");
11
+ //#region src/xhr.ts
12
+ const OBSERVER_WAIT_TIME_MS = 300;
13
+ /**
14
+ * This class represents a XMLHttpRequest plugin for auto instrumentation
15
+ * @deprecated See https://github.com/open-telemetry/opentelemetry-browser/tree/main/packages/instrumentation#xhr-xmlhttprequest
16
+ */
17
+ var XMLHttpRequestInstrumentation = class extends _opentelemetry_instrumentation.InstrumentationBase {
18
+ component = "xml-http-request";
19
+ version = require_version.VERSION;
20
+ moduleName = this.component;
21
+ _tasksCount = 0;
22
+ _xhrMem = /* @__PURE__ */ new WeakMap();
23
+ _usedResources = /* @__PURE__ */ new WeakSet();
24
+ constructor(config = {}) {
25
+ super("@opentelemetry/instrumentation-xml-http-request", require_version.VERSION, config);
26
+ }
27
+ init() {}
28
+ /**
29
+ * Adds custom headers to XMLHttpRequest
30
+ * @param xhr
31
+ * @param spanUrl
32
+ * @private
33
+ */
34
+ _addHeaders(xhr, spanUrl) {
35
+ const url = (0, _opentelemetry_web_common.parseUrl)(spanUrl).href;
36
+ if (!(0, _opentelemetry_web_common.shouldPropagateTraceHeaders)(url, this.getConfig().propagateTraceHeaderCorsUrls)) {
37
+ const headers = {};
38
+ _opentelemetry_api.propagation.inject(_opentelemetry_api.context.active(), headers);
39
+ if (Object.keys(headers).length > 0) this._diag.debug("headers inject skipped due to CORS policy");
40
+ return;
41
+ }
42
+ const headers = {};
43
+ _opentelemetry_api.propagation.inject(_opentelemetry_api.context.active(), headers);
44
+ Object.keys(headers).forEach((key) => {
45
+ xhr.setRequestHeader(key, String(headers[key]));
46
+ });
47
+ }
48
+ /**
49
+ * Add cors pre flight child span
50
+ * @param span
51
+ * @param corsPreFlightRequest
52
+ * @private
53
+ */
54
+ _addChildSpan(span, corsPreFlightRequest) {
55
+ _opentelemetry_api.context.with(_opentelemetry_api.trace.setSpan(_opentelemetry_api.context.active(), span), () => {
56
+ const childSpan = this.tracer.startSpan("CORS Preflight", { startTime: corsPreFlightRequest[_opentelemetry_web_common.PerformanceTimingNames.FETCH_START] });
57
+ (0, _opentelemetry_web_common.addSpanNetworkEvents)(childSpan, corsPreFlightRequest, this.getConfig().ignoreNetworkEvents, void 0);
58
+ childSpan.end(corsPreFlightRequest[_opentelemetry_web_common.PerformanceTimingNames.RESPONSE_END]);
59
+ });
60
+ }
61
+ /**
62
+ * Add attributes when span is going to end
63
+ * @param span
64
+ * @param xhr
65
+ * @private
66
+ */
67
+ _addFinalSpanAttributes(span, xhrMem) {
68
+ if (xhrMem.status) span.setAttribute(_opentelemetry_semantic_conventions.ATTR_HTTP_RESPONSE_STATUS_CODE, xhrMem.status);
69
+ }
70
+ _applyAttributesAfterXHR(span, xhr) {
71
+ const applyCustomAttributesOnSpan = this.getConfig().applyCustomAttributesOnSpan;
72
+ if (typeof applyCustomAttributesOnSpan === "function") (0, _opentelemetry_instrumentation.safeExecuteInTheMiddle)(() => applyCustomAttributesOnSpan(span, xhr), (error) => {
73
+ if (!error) return;
74
+ this._diag.error("applyCustomAttributesOnSpan", error);
75
+ }, true);
76
+ }
77
+ /**
78
+ * will collect information about all resources created
79
+ * between "send" and "end" with additional waiting for main resource
80
+ * @param xhr
81
+ * @param spanUrl
82
+ * @private
83
+ */
84
+ _addResourceObserver(xhr, spanUrl) {
85
+ const xhrMem = this._xhrMem.get(xhr);
86
+ if (!xhrMem || typeof PerformanceObserver !== "function" || typeof PerformanceResourceTiming !== "function") return;
87
+ xhrMem.createdResources = {
88
+ observer: new PerformanceObserver((list) => {
89
+ const entries = list.getEntries();
90
+ const parsedUrl = (0, _opentelemetry_web_common.parseUrl)(spanUrl);
91
+ entries.forEach((entry) => {
92
+ if (entry.initiatorType === "xmlhttprequest" && entry.name === parsedUrl.href) {
93
+ if (xhrMem.createdResources) xhrMem.createdResources.entries.push(entry);
94
+ }
95
+ });
96
+ }),
97
+ entries: []
98
+ };
99
+ xhrMem.createdResources.observer.observe({ entryTypes: ["resource"] });
100
+ }
101
+ /**
102
+ * Clears the resource timings and all resources assigned with spans
103
+ * when {@link XMLHttpRequestInstrumentationConfig.clearTimingResources} is
104
+ * set to true (default false)
105
+ * @private
106
+ */
107
+ _clearResources() {
108
+ if (this._tasksCount === 0 && this.getConfig().clearTimingResources) {
109
+ performance.clearResourceTimings();
110
+ this._xhrMem = /* @__PURE__ */ new WeakMap();
111
+ this._usedResources = /* @__PURE__ */ new WeakSet();
112
+ }
113
+ }
114
+ /**
115
+ * Finds appropriate resource and add network events to the span
116
+ * @param span
117
+ */
118
+ _findResourceAndAddNetworkEvents(xhrMem, span, spanUrl, startTime, endTime) {
119
+ if (!spanUrl || !startTime || !endTime || !xhrMem.createdResources) return;
120
+ let resources = xhrMem.createdResources.entries;
121
+ if (!resources || !resources.length) resources = performance.getEntriesByType("resource");
122
+ const resource = (0, _opentelemetry_web_common.getResource)((0, _opentelemetry_web_common.parseUrl)(spanUrl).href, startTime, endTime, resources, this._usedResources);
123
+ if (resource.mainRequest) {
124
+ const mainRequest = resource.mainRequest;
125
+ this._markResourceAsUsed(mainRequest);
126
+ const corsPreFlightRequest = resource.corsPreFlightRequest;
127
+ if (corsPreFlightRequest) {
128
+ this._addChildSpan(span, corsPreFlightRequest);
129
+ this._markResourceAsUsed(corsPreFlightRequest);
130
+ }
131
+ (0, _opentelemetry_web_common.addSpanNetworkEvents)(span, mainRequest, this.getConfig().ignoreNetworkEvents, void 0);
132
+ }
133
+ }
134
+ /**
135
+ * Removes the previous information about span.
136
+ * This might happened when the same xhr is used again.
137
+ * @param xhr
138
+ * @private
139
+ */
140
+ _cleanPreviousSpanInformation(xhr) {
141
+ const xhrMem = this._xhrMem.get(xhr);
142
+ if (xhrMem) {
143
+ const callbackToRemoveEvents = xhrMem.callbackToRemoveEvents;
144
+ if (callbackToRemoveEvents) callbackToRemoveEvents();
145
+ this._xhrMem.delete(xhr);
146
+ }
147
+ }
148
+ /**
149
+ * Creates a new span when method "open" is called
150
+ * @param xhr
151
+ * @param url
152
+ * @param method
153
+ * @private
154
+ */
155
+ _createSpan(xhr, url, method) {
156
+ const parsedUrl = (0, _opentelemetry_web_common.parseUrl)(url);
157
+ if ((0, _opentelemetry_core.isUrlIgnored)(parsedUrl.href, this.getConfig().ignoreUrls)) {
158
+ this._diag.debug("ignoring span as url matches ignored url");
159
+ return;
160
+ }
161
+ const attributes = {};
162
+ const origMethod = method;
163
+ const normMethod = require_utils.normalizeHttpRequestMethod(method);
164
+ const name = normMethod;
165
+ attributes[_opentelemetry_semantic_conventions.ATTR_HTTP_REQUEST_METHOD] = normMethod;
166
+ if (normMethod !== origMethod) attributes[_opentelemetry_semantic_conventions.ATTR_HTTP_REQUEST_METHOD_ORIGINAL] = origMethod;
167
+ attributes[_opentelemetry_semantic_conventions.ATTR_URL_FULL] = parsedUrl.toString();
168
+ attributes[_opentelemetry_semantic_conventions.ATTR_SERVER_ADDRESS] = parsedUrl.hostname;
169
+ const serverPort = require_utils.serverPortFromUrl(parsedUrl);
170
+ if (serverPort) attributes[_opentelemetry_semantic_conventions.ATTR_SERVER_PORT] = serverPort;
171
+ const currentSpan = this.tracer.startSpan(name, {
172
+ kind: _opentelemetry_api.SpanKind.CLIENT,
173
+ attributes
174
+ });
175
+ currentSpan.addEvent("open");
176
+ this._cleanPreviousSpanInformation(xhr);
177
+ this._xhrMem.set(xhr, {
178
+ span: currentSpan,
179
+ spanUrl: url
180
+ });
181
+ return currentSpan;
182
+ }
183
+ /**
184
+ * Marks certain [resource]{@link PerformanceResourceTiming} when information
185
+ * from this is used to add events to span.
186
+ * This is done to avoid reusing the same resource again for next span
187
+ * @param resource
188
+ * @private
189
+ */
190
+ _markResourceAsUsed(resource) {
191
+ this._usedResources.add(resource);
192
+ }
193
+ /**
194
+ * Patches the method open
195
+ * @private
196
+ */
197
+ _patchOpen() {
198
+ return (original) => {
199
+ const plugin = this;
200
+ return function patchOpen(...args) {
201
+ if (!plugin._isEnabled) return original.apply(this, args);
202
+ const method = args[0];
203
+ const url = args[1];
204
+ plugin._createSpan(this, url, method);
205
+ return original.apply(this, args);
206
+ };
207
+ };
208
+ }
209
+ /**
210
+ * Patches the method send
211
+ * @private
212
+ */
213
+ _patchSend() {
214
+ const plugin = this;
215
+ function endSpanTimeout(eventName, xhrMem, performanceEndTime, endTime) {
216
+ const callbackToRemoveEvents = xhrMem.callbackToRemoveEvents;
217
+ if (typeof callbackToRemoveEvents === "function") callbackToRemoveEvents();
218
+ const { span, spanUrl, sendStartTime } = xhrMem;
219
+ if (span) {
220
+ plugin._findResourceAndAddNetworkEvents(xhrMem, span, spanUrl, sendStartTime, performanceEndTime);
221
+ span.addEvent(eventName, endTime);
222
+ plugin._addFinalSpanAttributes(span, xhrMem);
223
+ span.end(endTime);
224
+ plugin._tasksCount--;
225
+ }
226
+ plugin._clearResources();
227
+ }
228
+ function endSpan(eventName, xhr, isError, errorType) {
229
+ const xhrMem = plugin._xhrMem.get(xhr);
230
+ if (!xhrMem) return;
231
+ xhrMem.status = xhr.status;
232
+ xhrMem.statusText = xhr.statusText;
233
+ plugin._xhrMem.delete(xhr);
234
+ if (xhrMem.span) {
235
+ const span = xhrMem.span;
236
+ plugin._applyAttributesAfterXHR(span, xhr);
237
+ if (isError) {
238
+ if (errorType) {
239
+ span.setStatus({
240
+ code: _opentelemetry_api.SpanStatusCode.ERROR,
241
+ message: errorType
242
+ });
243
+ span.setAttribute(_opentelemetry_semantic_conventions.ATTR_ERROR_TYPE, errorType);
244
+ }
245
+ } else if (xhrMem.status && xhrMem.status >= 400) {
246
+ span.setStatus({ code: _opentelemetry_api.SpanStatusCode.ERROR });
247
+ span.setAttribute(_opentelemetry_semantic_conventions.ATTR_ERROR_TYPE, String(xhrMem.status));
248
+ }
249
+ }
250
+ const performanceEndTime = (0, _opentelemetry_core.hrTime)();
251
+ const endTime = Date.now();
252
+ setTimeout(() => {
253
+ endSpanTimeout(eventName, xhrMem, performanceEndTime, endTime);
254
+ }, OBSERVER_WAIT_TIME_MS);
255
+ }
256
+ function onError() {
257
+ endSpan("error", this, true, "error");
258
+ }
259
+ function onAbort() {
260
+ endSpan("abort", this, false);
261
+ }
262
+ function onTimeout() {
263
+ endSpan("timeout", this, true, "timeout");
264
+ }
265
+ function onLoad() {
266
+ if (this.status < 299) endSpan("loaded", this, false);
267
+ else endSpan("error", this, false);
268
+ }
269
+ function unregister(xhr) {
270
+ xhr.removeEventListener("abort", onAbort);
271
+ xhr.removeEventListener("error", onError);
272
+ xhr.removeEventListener("load", onLoad);
273
+ xhr.removeEventListener("timeout", onTimeout);
274
+ const xhrMem = plugin._xhrMem.get(xhr);
275
+ if (xhrMem) xhrMem.callbackToRemoveEvents = void 0;
276
+ }
277
+ return (original) => {
278
+ return function patchSend(...args) {
279
+ if (!plugin._isEnabled) return original.apply(this, args);
280
+ const xhrMem = plugin._xhrMem.get(this);
281
+ if (!xhrMem) return original.apply(this, args);
282
+ const currentSpan = xhrMem.span;
283
+ const spanUrl = xhrMem.spanUrl;
284
+ if (currentSpan && spanUrl) {
285
+ if (plugin.getConfig().measureRequestSize && args?.[0]) {
286
+ const body = args[0];
287
+ const bodyLength = require_utils.getXHRBodyLength(body);
288
+ if (bodyLength !== void 0) currentSpan.setAttribute(require_semconv.ATTR_HTTP_REQUEST_BODY_SIZE, bodyLength);
289
+ }
290
+ _opentelemetry_api.context.with(_opentelemetry_api.trace.setSpan(_opentelemetry_api.context.active(), currentSpan), () => {
291
+ plugin._tasksCount++;
292
+ xhrMem.sendStartTime = (0, _opentelemetry_core.hrTime)();
293
+ currentSpan.addEvent("send");
294
+ this.addEventListener("abort", onAbort);
295
+ this.addEventListener("error", onError);
296
+ this.addEventListener("load", onLoad);
297
+ this.addEventListener("timeout", onTimeout);
298
+ xhrMem.callbackToRemoveEvents = () => {
299
+ unregister(this);
300
+ if (xhrMem.createdResources) xhrMem.createdResources.observer.disconnect();
301
+ };
302
+ plugin._addHeaders(this, spanUrl);
303
+ plugin._addResourceObserver(this, spanUrl);
304
+ });
305
+ }
306
+ return original.apply(this, args);
307
+ };
308
+ };
309
+ }
310
+ /**
311
+ * implements enable function
312
+ */
313
+ enable() {
314
+ if (this._isEnabled) return;
315
+ if (this._isXhrPatched) {
316
+ this._diag.debug("reactivating existing patch on", this.moduleName, this.version);
317
+ this._isEnabled = true;
318
+ return;
319
+ }
320
+ try {
321
+ this._diag.debug("applying patch to", this.moduleName, this.version);
322
+ this._wrap(XMLHttpRequest.prototype, "open", this._patchOpen());
323
+ this._wrap(XMLHttpRequest.prototype, "send", this._patchSend());
324
+ this._isXhrPatched = true;
325
+ this._isEnabled = true;
326
+ } catch (err) {
327
+ this._unwrap(XMLHttpRequest.prototype, "open");
328
+ this._unwrap(XMLHttpRequest.prototype, "send");
329
+ this._diag.warn("Failed to patch globalThis.XMLHttpRequest; instrumentation will not be enabled. Another script may have locked globalThis.XMLHttpRequest via Object.defineProperty.", err);
330
+ }
331
+ }
332
+ /**
333
+ * implements disable function
334
+ */
335
+ disable() {
336
+ if (!this._isEnabled) return;
337
+ this._isEnabled = false;
338
+ this._tasksCount = 0;
339
+ this._xhrMem = /* @__PURE__ */ new WeakMap();
340
+ this._usedResources = /* @__PURE__ */ new WeakSet();
341
+ }
342
+ };
343
+ //#endregion
344
+ exports.XMLHttpRequestInstrumentation = XMLHttpRequestInstrumentation;
345
+
346
+ //# sourceMappingURL=xhr.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"xhr.cjs","names":["InstrumentationBase","VERSION","parseUrl","shouldPropagateTraceHeaders","api","PTN","ATTR_HTTP_RESPONSE_STATUS_CODE","getResource","isUrlIgnored","normalizeHttpRequestMethod","ATTR_HTTP_REQUEST_METHOD","ATTR_HTTP_REQUEST_METHOD_ORIGINAL","ATTR_URL_FULL","ATTR_SERVER_ADDRESS","serverPortFromUrl","ATTR_SERVER_PORT","ATTR_ERROR_TYPE","hrTime","getXHRBodyLength","ATTR_HTTP_REQUEST_BODY_SIZE"],"sources":["../src/xhr.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport * as api from '@opentelemetry/api';\nimport type { InstrumentationConfig } from '@opentelemetry/instrumentation';\nimport {\n InstrumentationBase,\n safeExecuteInTheMiddle,\n} from '@opentelemetry/instrumentation';\nimport { hrTime, isUrlIgnored } from '@opentelemetry/core';\nimport {\n addSpanNetworkEvents,\n getResource,\n PerformanceTimingNames as PTN,\n shouldPropagateTraceHeaders,\n parseUrl,\n} from '@opentelemetry/web-common';\nimport {\n ATTR_ERROR_TYPE,\n ATTR_HTTP_REQUEST_METHOD,\n ATTR_HTTP_REQUEST_METHOD_ORIGINAL,\n ATTR_HTTP_RESPONSE_STATUS_CODE,\n ATTR_SERVER_ADDRESS,\n ATTR_SERVER_PORT,\n ATTR_URL_FULL,\n} from '@opentelemetry/semantic-conventions';\nimport { ATTR_HTTP_REQUEST_BODY_SIZE } from './semconv';\nimport { EventNames } from './enums/EventNames';\nimport type {\n OpenFunction,\n PropagateTraceHeaderCorsUrls,\n SendFunction,\n XhrMem,\n} from './types';\nimport {\n normalizeHttpRequestMethod,\n serverPortFromUrl,\n getXHRBodyLength,\n} from './utils';\nimport { VERSION } from './version';\n\n// how long to wait for observer to collect information about resources\n// this is needed as event \"load\" is called before observer\n// hard to say how long it should really wait, seems like 300ms is\n// safe enough\nconst OBSERVER_WAIT_TIME_MS = 300;\n\nexport type XHRCustomAttributeFunction = (\n span: api.Span,\n xhr: XMLHttpRequest\n) => void;\n\n/**\n * XMLHttpRequest config\n */\nexport interface XMLHttpRequestInstrumentationConfig\n extends InstrumentationConfig {\n /**\n * The number of timing resources is limited, after the limit\n * (chrome 250, safari 150) the information is not collected anymore.\n * The only way to prevent that is to regularly clean the resources\n * whenever it is possible. This is needed only when PerformanceObserver\n * is not available\n */\n clearTimingResources?: boolean;\n /** URLs which should include trace headers when origin doesn't match */\n propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;\n /**\n * URLs that partially match any regex in ignoreUrls will not be traced.\n * In addition, URLs that are _exact matches_ of strings in ignoreUrls will\n * also not be traced.\n */\n ignoreUrls?: Array<string | RegExp>;\n /** Function for adding custom attributes on the span */\n applyCustomAttributesOnSpan?: XHRCustomAttributeFunction;\n /** Ignore adding network events as span events */\n ignoreNetworkEvents?: boolean;\n /** Measure outgoing request size */\n measureRequestSize?: boolean;\n}\n\n/**\n * This class represents a XMLHttpRequest plugin for auto instrumentation\n * @deprecated See https://github.com/open-telemetry/opentelemetry-browser/tree/main/packages/instrumentation#xhr-xmlhttprequest\n */\nexport class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRequestInstrumentationConfig> {\n readonly component: string = 'xml-http-request';\n readonly version: string = VERSION;\n moduleName = this.component;\n\n private _tasksCount = 0;\n private _xhrMem = new WeakMap<XMLHttpRequest, XhrMem>();\n private _usedResources = new WeakSet<PerformanceResourceTiming>();\n\n // Note: Intentionally *not* using `_enabled` as the field name to avoid\n // any possible confusion with the `_enabled` field used on the *Node.js*\n // InstrumentationBase class.\n // Also not initializing the fields to `false` because the base class\n // constructor already calls `enable` modifying their values and it will\n // set the instrumentations in a bad state (enabled, patched but with flags set to false)\n declare private _isEnabled: boolean;\n declare private _isXhrPatched: boolean;\n\n constructor(config: XMLHttpRequestInstrumentationConfig = {}) {\n super('@opentelemetry/instrumentation-xml-http-request', VERSION, config);\n }\n\n init() {}\n\n /**\n * Adds custom headers to XMLHttpRequest\n * @param xhr\n * @param spanUrl\n * @private\n */\n private _addHeaders(xhr: XMLHttpRequest, spanUrl: string) {\n const url = parseUrl(spanUrl).href;\n if (\n !shouldPropagateTraceHeaders(\n url,\n this.getConfig().propagateTraceHeaderCorsUrls\n )\n ) {\n const headers: Partial<Record<string, unknown>> = {};\n api.propagation.inject(api.context.active(), headers);\n if (Object.keys(headers).length > 0) {\n this._diag.debug('headers inject skipped due to CORS policy');\n }\n return;\n }\n const headers: { [key: string]: unknown } = {};\n api.propagation.inject(api.context.active(), headers);\n Object.keys(headers).forEach(key => {\n xhr.setRequestHeader(key, String(headers[key]));\n });\n }\n\n /**\n * Add cors pre flight child span\n * @param span\n * @param corsPreFlightRequest\n * @private\n */\n private _addChildSpan(\n span: api.Span,\n corsPreFlightRequest: PerformanceResourceTiming\n ): void {\n api.context.with(api.trace.setSpan(api.context.active(), span), () => {\n const childSpan = this.tracer.startSpan('CORS Preflight', {\n startTime: corsPreFlightRequest[PTN.FETCH_START],\n });\n addSpanNetworkEvents(\n childSpan,\n corsPreFlightRequest,\n this.getConfig().ignoreNetworkEvents,\n undefined\n );\n childSpan.end(corsPreFlightRequest[PTN.RESPONSE_END]);\n });\n }\n\n /**\n * Add attributes when span is going to end\n * @param span\n * @param xhr\n * @private\n */\n _addFinalSpanAttributes(span: api.Span, xhrMem: XhrMem) {\n if (xhrMem.status) {\n // Intentionally exclude status=0, because XHR uses 0 for before a\n // response is received and semconv says to only add the attribute if\n // received a response.\n span.setAttribute(ATTR_HTTP_RESPONSE_STATUS_CODE, xhrMem.status);\n }\n }\n\n private _applyAttributesAfterXHR(span: api.Span, xhr: XMLHttpRequest) {\n const applyCustomAttributesOnSpan =\n this.getConfig().applyCustomAttributesOnSpan;\n if (typeof applyCustomAttributesOnSpan === 'function') {\n safeExecuteInTheMiddle(\n () => applyCustomAttributesOnSpan(span, xhr),\n error => {\n if (!error) {\n return;\n }\n\n this._diag.error('applyCustomAttributesOnSpan', error);\n },\n true\n );\n }\n }\n\n /**\n * will collect information about all resources created\n * between \"send\" and \"end\" with additional waiting for main resource\n * @param xhr\n * @param spanUrl\n * @private\n */\n private _addResourceObserver(xhr: XMLHttpRequest, spanUrl: string) {\n const xhrMem = this._xhrMem.get(xhr);\n if (\n !xhrMem ||\n typeof PerformanceObserver !== 'function' ||\n typeof PerformanceResourceTiming !== 'function'\n ) {\n return;\n }\n xhrMem.createdResources = {\n observer: new PerformanceObserver(list => {\n const entries = list.getEntries() as PerformanceResourceTiming[];\n const parsedUrl = parseUrl(spanUrl);\n\n entries.forEach(entry => {\n if (\n entry.initiatorType === 'xmlhttprequest' &&\n entry.name === parsedUrl.href\n ) {\n if (xhrMem.createdResources) {\n xhrMem.createdResources.entries.push(entry);\n }\n }\n });\n }),\n entries: [],\n };\n xhrMem.createdResources.observer.observe({\n entryTypes: ['resource'],\n });\n }\n\n /**\n * Clears the resource timings and all resources assigned with spans\n * when {@link XMLHttpRequestInstrumentationConfig.clearTimingResources} is\n * set to true (default false)\n * @private\n */\n private _clearResources() {\n if (this._tasksCount === 0 && this.getConfig().clearTimingResources) {\n performance.clearResourceTimings();\n this._xhrMem = new WeakMap<XMLHttpRequest, XhrMem>();\n this._usedResources = new WeakSet<PerformanceResourceTiming>();\n }\n }\n\n /**\n * Finds appropriate resource and add network events to the span\n * @param span\n */\n private _findResourceAndAddNetworkEvents(\n xhrMem: XhrMem,\n span: api.Span,\n spanUrl?: string,\n startTime?: api.HrTime,\n endTime?: api.HrTime\n ): void {\n if (!spanUrl || !startTime || !endTime || !xhrMem.createdResources) {\n return;\n }\n let resources: PerformanceResourceTiming[] =\n xhrMem.createdResources.entries;\n\n if (!resources || !resources.length) {\n // fallback - either Observer is not available or it took longer\n // then OBSERVER_WAIT_TIME_MS and observer didn't collect enough\n // information\n // ts thinks this is the perf_hooks module, but it is the browser performance api\n resources = performance.getEntriesByType(\n 'resource'\n ) as PerformanceResourceTiming[];\n }\n\n const resource = getResource(\n parseUrl(spanUrl).href,\n startTime,\n endTime,\n resources,\n this._usedResources\n );\n\n if (resource.mainRequest) {\n const mainRequest = resource.mainRequest;\n this._markResourceAsUsed(mainRequest);\n\n const corsPreFlightRequest = resource.corsPreFlightRequest;\n if (corsPreFlightRequest) {\n this._addChildSpan(span, corsPreFlightRequest);\n this._markResourceAsUsed(corsPreFlightRequest);\n }\n addSpanNetworkEvents(\n span,\n mainRequest,\n this.getConfig().ignoreNetworkEvents,\n undefined\n );\n }\n }\n\n /**\n * Removes the previous information about span.\n * This might happened when the same xhr is used again.\n * @param xhr\n * @private\n */\n private _cleanPreviousSpanInformation(xhr: XMLHttpRequest) {\n const xhrMem = this._xhrMem.get(xhr);\n if (xhrMem) {\n const callbackToRemoveEvents = xhrMem.callbackToRemoveEvents;\n if (callbackToRemoveEvents) {\n callbackToRemoveEvents();\n }\n this._xhrMem.delete(xhr);\n }\n }\n\n /**\n * Creates a new span when method \"open\" is called\n * @param xhr\n * @param url\n * @param method\n * @private\n */\n private _createSpan(\n xhr: XMLHttpRequest,\n url: string,\n method: string\n ): api.Span | undefined {\n const parsedUrl = parseUrl(url);\n if (isUrlIgnored(parsedUrl.href, this.getConfig().ignoreUrls)) {\n this._diag.debug('ignoring span as url matches ignored url');\n return;\n }\n const attributes = {} as api.Attributes;\n const origMethod = method;\n const normMethod = normalizeHttpRequestMethod(method);\n const name = normMethod;\n\n attributes[ATTR_HTTP_REQUEST_METHOD] = normMethod;\n if (normMethod !== origMethod) {\n attributes[ATTR_HTTP_REQUEST_METHOD_ORIGINAL] = origMethod;\n }\n attributes[ATTR_URL_FULL] = parsedUrl.toString();\n attributes[ATTR_SERVER_ADDRESS] = parsedUrl.hostname;\n const serverPort = serverPortFromUrl(parsedUrl);\n if (serverPort) {\n attributes[ATTR_SERVER_PORT] = serverPort;\n }\n\n const currentSpan = this.tracer.startSpan(name, {\n kind: api.SpanKind.CLIENT,\n attributes,\n });\n\n currentSpan.addEvent(EventNames.METHOD_OPEN);\n\n this._cleanPreviousSpanInformation(xhr);\n\n this._xhrMem.set(xhr, {\n span: currentSpan,\n spanUrl: url,\n });\n\n return currentSpan;\n }\n\n /**\n * Marks certain [resource]{@link PerformanceResourceTiming} when information\n * from this is used to add events to span.\n * This is done to avoid reusing the same resource again for next span\n * @param resource\n * @private\n */\n private _markResourceAsUsed(resource: PerformanceResourceTiming) {\n this._usedResources.add(resource);\n }\n\n /**\n * Patches the method open\n * @private\n */\n protected _patchOpen() {\n return (original: OpenFunction): OpenFunction => {\n const plugin = this;\n return function patchOpen(this: XMLHttpRequest, ...args): void {\n if (!plugin._isEnabled) {\n return original.apply(this, args);\n }\n const method: string = args[0];\n const url: string = args[1];\n plugin._createSpan(this, url, method);\n\n return original.apply(this, args);\n };\n };\n }\n\n /**\n * Patches the method send\n * @private\n */\n protected _patchSend() {\n const plugin = this;\n\n function endSpanTimeout(\n eventName: string,\n xhrMem: XhrMem,\n performanceEndTime: api.HrTime,\n endTime: number\n ) {\n const callbackToRemoveEvents = xhrMem.callbackToRemoveEvents;\n\n if (typeof callbackToRemoveEvents === 'function') {\n callbackToRemoveEvents();\n }\n\n const { span, spanUrl, sendStartTime } = xhrMem;\n\n if (span) {\n plugin._findResourceAndAddNetworkEvents(\n xhrMem,\n span,\n spanUrl,\n sendStartTime,\n performanceEndTime\n );\n span.addEvent(eventName, endTime);\n plugin._addFinalSpanAttributes(span, xhrMem);\n span.end(endTime);\n plugin._tasksCount--;\n }\n plugin._clearResources();\n }\n\n function endSpan(\n eventName: string,\n xhr: XMLHttpRequest,\n isError: boolean,\n errorType?: string\n ) {\n const xhrMem = plugin._xhrMem.get(xhr);\n if (!xhrMem) {\n return;\n }\n xhrMem.status = xhr.status;\n xhrMem.statusText = xhr.statusText;\n plugin._xhrMem.delete(xhr);\n\n if (xhrMem.span) {\n const span = xhrMem.span;\n plugin._applyAttributesAfterXHR(span, xhr);\n\n if (isError) {\n if (errorType) {\n span.setStatus({\n code: api.SpanStatusCode.ERROR,\n message: errorType,\n });\n span.setAttribute(ATTR_ERROR_TYPE, errorType);\n }\n } else if (xhrMem.status && xhrMem.status >= 400) {\n span.setStatus({ code: api.SpanStatusCode.ERROR });\n span.setAttribute(ATTR_ERROR_TYPE, String(xhrMem.status));\n }\n }\n\n const performanceEndTime = hrTime();\n const endTime = Date.now();\n\n // the timeout is needed as observer doesn't have yet information\n // when event \"load\" is called. Also the time may differ depends on\n // browser and speed of computer\n setTimeout(() => {\n endSpanTimeout(eventName, xhrMem, performanceEndTime, endTime);\n }, OBSERVER_WAIT_TIME_MS);\n }\n\n function onError(this: XMLHttpRequest) {\n endSpan(EventNames.EVENT_ERROR, this, true, 'error');\n }\n\n function onAbort(this: XMLHttpRequest) {\n endSpan(EventNames.EVENT_ABORT, this, false);\n }\n\n function onTimeout(this: XMLHttpRequest) {\n endSpan(EventNames.EVENT_TIMEOUT, this, true, 'timeout');\n }\n\n function onLoad(this: XMLHttpRequest) {\n if (this.status < 299) {\n endSpan(EventNames.EVENT_LOAD, this, false);\n } else {\n endSpan(EventNames.EVENT_ERROR, this, false);\n }\n }\n\n function unregister(xhr: XMLHttpRequest) {\n xhr.removeEventListener('abort', onAbort);\n xhr.removeEventListener('error', onError);\n xhr.removeEventListener('load', onLoad);\n xhr.removeEventListener('timeout', onTimeout);\n const xhrMem = plugin._xhrMem.get(xhr);\n if (xhrMem) {\n xhrMem.callbackToRemoveEvents = undefined;\n }\n }\n\n return (original: SendFunction): SendFunction => {\n return function patchSend(this: XMLHttpRequest, ...args): void {\n if (!plugin._isEnabled) {\n return original.apply(this, args);\n }\n const xhrMem = plugin._xhrMem.get(this);\n if (!xhrMem) {\n return original.apply(this, args);\n }\n const currentSpan = xhrMem.span;\n const spanUrl = xhrMem.spanUrl;\n\n if (currentSpan && spanUrl) {\n if (plugin.getConfig().measureRequestSize && args?.[0]) {\n const body = args[0];\n const bodyLength = getXHRBodyLength(body);\n if (bodyLength !== undefined) {\n currentSpan.setAttribute(ATTR_HTTP_REQUEST_BODY_SIZE, bodyLength);\n }\n }\n\n api.context.with(\n api.trace.setSpan(api.context.active(), currentSpan),\n () => {\n plugin._tasksCount++;\n xhrMem.sendStartTime = hrTime();\n currentSpan.addEvent(EventNames.METHOD_SEND);\n\n this.addEventListener('abort', onAbort);\n this.addEventListener('error', onError);\n this.addEventListener('load', onLoad);\n this.addEventListener('timeout', onTimeout);\n\n xhrMem.callbackToRemoveEvents = () => {\n unregister(this);\n if (xhrMem.createdResources) {\n xhrMem.createdResources.observer.disconnect();\n }\n };\n plugin._addHeaders(this, spanUrl);\n plugin._addResourceObserver(this, spanUrl);\n }\n );\n }\n return original.apply(this, args);\n };\n };\n }\n\n /**\n * implements enable function\n */\n override enable() {\n if (this._isEnabled) {\n return;\n }\n if (this._isXhrPatched) {\n this._diag.debug(\n 'reactivating existing patch on',\n this.moduleName,\n this.version\n );\n this._isEnabled = true;\n return;\n }\n\n try {\n this._diag.debug('applying patch to', this.moduleName, this.version);\n this._wrap(XMLHttpRequest.prototype, 'open', this._patchOpen());\n this._wrap(XMLHttpRequest.prototype, 'send', this._patchSend());\n this._isXhrPatched = true;\n this._isEnabled = true;\n } catch (err) {\n // make sure there is no wrapped functions\n this._unwrap(XMLHttpRequest.prototype, 'open');\n this._unwrap(XMLHttpRequest.prototype, 'send');\n this._diag.warn(\n 'Failed to patch globalThis.XMLHttpRequest; instrumentation will not be enabled. ' +\n 'Another script may have locked globalThis.XMLHttpRequest via Object.defineProperty.',\n err\n );\n }\n }\n\n /**\n * implements disable function\n */\n override disable() {\n if (!this._isEnabled) {\n return;\n }\n this._isEnabled = false;\n this._tasksCount = 0;\n this._xhrMem = new WeakMap<XMLHttpRequest, XhrMem>();\n this._usedResources = new WeakSet<PerformanceResourceTiming>();\n }\n}\n"],"mappings":";;;;;;;;;;;AA+CA,MAAM,wBAAwB;;;;;AAwC9B,IAAa,gCAAb,cAAmDA,+BAAAA,oBAAyD;CAC1G,YAA6B;CAC7B,UAA2BC,gBAAAA;CAC3B,aAAa,KAAK;CAElB,cAAsB;CACtB,0BAAkB,IAAI,QAAgC;CACtD,iCAAyB,IAAI,QAAmC;CAWhE,YAAY,SAA8C,CAAC,GAAG;EAC5D,MAAM,mDAAmDA,gBAAAA,SAAS,MAAM;CAC1E;CAEA,OAAO,CAAC;;;;;;;CAQR,YAAoB,KAAqB,SAAiB;EACxD,MAAM,OAAA,GAAMC,0BAAAA,SAAAA,CAAS,OAAO,CAAC,CAAC;EAC9B,IACE,EAAA,GAACC,0BAAAA,4BAAAA,CACC,KACA,KAAK,UAAU,CAAC,CAAC,4BACnB,GACA;GACA,MAAM,UAA4C,CAAC;GACnD,mBAAI,YAAY,OAAOC,mBAAI,QAAQ,OAAO,GAAG,OAAO;GACpD,IAAI,OAAO,KAAK,OAAO,CAAC,CAAC,SAAS,GAChC,KAAK,MAAM,MAAM,2CAA2C;GAE9D;EACF;EACA,MAAM,UAAsC,CAAC;EAC7C,mBAAI,YAAY,OAAOA,mBAAI,QAAQ,OAAO,GAAG,OAAO;EACpD,OAAO,KAAK,OAAO,CAAC,CAAC,SAAQ,QAAO;GAClC,IAAI,iBAAiB,KAAK,OAAO,QAAQ,IAAI,CAAC;EAChD,CAAC;CACH;;;;;;;CAQA,cACE,MACA,sBACM;EACN,mBAAI,QAAQ,KAAKA,mBAAI,MAAM,QAAQA,mBAAI,QAAQ,OAAO,GAAG,IAAI,SAAS;GACpE,MAAM,YAAY,KAAK,OAAO,UAAU,kBAAkB,EACxD,WAAW,qBAAqBC,0BAAAA,uBAAI,aACtC,CAAC;GACD,CAAA,GAAA,0BAAA,qBAAA,CACE,WACA,sBACA,KAAK,UAAU,CAAC,CAAC,qBACjB,KAAA,CACF;GACA,UAAU,IAAI,qBAAqBA,0BAAAA,uBAAI,aAAa;EACtD,CAAC;CACH;;;;;;;CAQA,wBAAwB,MAAgB,QAAgB;EACtD,IAAI,OAAO,QAIT,KAAK,aAAaC,oCAAAA,gCAAgC,OAAO,MAAM;CAEnE;CAEA,yBAAiC,MAAgB,KAAqB;EACpE,MAAM,8BACJ,KAAK,UAAU,CAAC,CAAC;EACnB,IAAI,OAAO,gCAAgC,YACzC,CAAA,GAAA,+BAAA,uBAAA,OACQ,4BAA4B,MAAM,GAAG,IAC3C,UAAS;GACP,IAAI,CAAC,OACH;GAGF,KAAK,MAAM,MAAM,+BAA+B,KAAK;EACvD,GACA,IACF;CAEJ;;;;;;;;CASA,qBAA6B,KAAqB,SAAiB;EACjE,MAAM,SAAS,KAAK,QAAQ,IAAI,GAAG;EACnC,IACE,CAAC,UACD,OAAO,wBAAwB,cAC/B,OAAO,8BAA8B,YAErC;EAEF,OAAO,mBAAmB;GACxB,UAAU,IAAI,qBAAoB,SAAQ;IACxC,MAAM,UAAU,KAAK,WAAW;IAChC,MAAM,aAAA,GAAYJ,0BAAAA,SAAAA,CAAS,OAAO;IAElC,QAAQ,SAAQ,UAAS;KACvB,IACE,MAAM,kBAAkB,oBACxB,MAAM,SAAS,UAAU,MAErB;UAAA,OAAO,kBACT,OAAO,iBAAiB,QAAQ,KAAK,KAAK;KAAA;IAGhD,CAAC;GACH,CAAC;GACD,SAAS,CAAC;EACZ;EACA,OAAO,iBAAiB,SAAS,QAAQ,EACvC,YAAY,CAAC,UAAU,EACzB,CAAC;CACH;;;;;;;CAQA,kBAA0B;EACxB,IAAI,KAAK,gBAAgB,KAAK,KAAK,UAAU,CAAC,CAAC,sBAAsB;GACnE,YAAY,qBAAqB;GACjC,KAAK,0BAAU,IAAI,QAAgC;GACnD,KAAK,iCAAiB,IAAI,QAAmC;EAC/D;CACF;;;;;CAMA,iCACE,QACA,MACA,SACA,WACA,SACM;EACN,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,WAAW,CAAC,OAAO,kBAChD;EAEF,IAAI,YACF,OAAO,iBAAiB;EAE1B,IAAI,CAAC,aAAa,CAAC,UAAU,QAK3B,YAAY,YAAY,iBACtB,UACF;EAGF,MAAM,YAAA,GAAWK,0BAAAA,YAAAA,EAAAA,GACfL,0BAAAA,SAAAA,CAAS,OAAO,CAAC,CAAC,MAClB,WACA,SACA,WACA,KAAK,cACP;EAEA,IAAI,SAAS,aAAa;GACxB,MAAM,cAAc,SAAS;GAC7B,KAAK,oBAAoB,WAAW;GAEpC,MAAM,uBAAuB,SAAS;GACtC,IAAI,sBAAsB;IACxB,KAAK,cAAc,MAAM,oBAAoB;IAC7C,KAAK,oBAAoB,oBAAoB;GAC/C;GACA,CAAA,GAAA,0BAAA,qBAAA,CACE,MACA,aACA,KAAK,UAAU,CAAC,CAAC,qBACjB,KAAA,CACF;EACF;CACF;;;;;;;CAQA,8BAAsC,KAAqB;EACzD,MAAM,SAAS,KAAK,QAAQ,IAAI,GAAG;EACnC,IAAI,QAAQ;GACV,MAAM,yBAAyB,OAAO;GACtC,IAAI,wBACF,uBAAuB;GAEzB,KAAK,QAAQ,OAAO,GAAG;EACzB;CACF;;;;;;;;CASA,YACE,KACA,KACA,QACsB;EACtB,MAAM,aAAA,GAAYA,0BAAAA,SAAAA,CAAS,GAAG;EAC9B,KAAA,GAAIM,oBAAAA,aAAAA,CAAa,UAAU,MAAM,KAAK,UAAU,CAAC,CAAC,UAAU,GAAG;GAC7D,KAAK,MAAM,MAAM,0CAA0C;GAC3D;EACF;EACA,MAAM,aAAa,CAAC;EACpB,MAAM,aAAa;EACnB,MAAM,aAAaC,cAAAA,2BAA2B,MAAM;EACpD,MAAM,OAAO;EAEb,WAAWC,oCAAAA,4BAA4B;EACvC,IAAI,eAAe,YACjB,WAAWC,oCAAAA,qCAAqC;EAElD,WAAWC,oCAAAA,iBAAiB,UAAU,SAAS;EAC/C,WAAWC,oCAAAA,uBAAuB,UAAU;EAC5C,MAAM,aAAaC,cAAAA,kBAAkB,SAAS;EAC9C,IAAI,YACF,WAAWC,oCAAAA,oBAAoB;EAGjC,MAAM,cAAc,KAAK,OAAO,UAAU,MAAM;GAC9C,MAAMX,mBAAI,SAAS;GACnB;EACF,CAAC;EAED,YAAY,SAAA,MAA+B;EAE3C,KAAK,8BAA8B,GAAG;EAEtC,KAAK,QAAQ,IAAI,KAAK;GACpB,MAAM;GACN,SAAS;EACX,CAAC;EAED,OAAO;CACT;;;;;;;;CASA,oBAA4B,UAAqC;EAC/D,KAAK,eAAe,IAAI,QAAQ;CAClC;;;;;CAMA,aAAuB;EACrB,QAAQ,aAAyC;GAC/C,MAAM,SAAS;GACf,OAAO,SAAS,UAAgC,GAAG,MAAY;IAC7D,IAAI,CAAC,OAAO,YACV,OAAO,SAAS,MAAM,MAAM,IAAI;IAElC,MAAM,SAAiB,KAAK;IAC5B,MAAM,MAAc,KAAK;IACzB,OAAO,YAAY,MAAM,KAAK,MAAM;IAEpC,OAAO,SAAS,MAAM,MAAM,IAAI;GAClC;EACF;CACF;;;;;CAMA,aAAuB;EACrB,MAAM,SAAS;EAEf,SAAS,eACP,WACA,QACA,oBACA,SACA;GACA,MAAM,yBAAyB,OAAO;GAEtC,IAAI,OAAO,2BAA2B,YACpC,uBAAuB;GAGzB,MAAM,EAAE,MAAM,SAAS,kBAAkB;GAEzC,IAAI,MAAM;IACR,OAAO,iCACL,QACA,MACA,SACA,eACA,kBACF;IACA,KAAK,SAAS,WAAW,OAAO;IAChC,OAAO,wBAAwB,MAAM,MAAM;IAC3C,KAAK,IAAI,OAAO;IAChB,OAAO;GACT;GACA,OAAO,gBAAgB;EACzB;EAEA,SAAS,QACP,WACA,KACA,SACA,WACA;GACA,MAAM,SAAS,OAAO,QAAQ,IAAI,GAAG;GACrC,IAAI,CAAC,QACH;GAEF,OAAO,SAAS,IAAI;GACpB,OAAO,aAAa,IAAI;GACxB,OAAO,QAAQ,OAAO,GAAG;GAEzB,IAAI,OAAO,MAAM;IACf,MAAM,OAAO,OAAO;IACpB,OAAO,yBAAyB,MAAM,GAAG;IAEzC,IAAI,SACE;SAAA,WAAW;MACb,KAAK,UAAU;OACb,MAAMA,mBAAI,eAAe;OACzB,SAAS;MACX,CAAC;MACD,KAAK,aAAaY,oCAAAA,iBAAiB,SAAS;KAC9C;WACK,IAAI,OAAO,UAAU,OAAO,UAAU,KAAK;KAChD,KAAK,UAAU,EAAE,MAAMZ,mBAAI,eAAe,MAAM,CAAC;KACjD,KAAK,aAAaY,oCAAAA,iBAAiB,OAAO,OAAO,MAAM,CAAC;IAC1D;GACF;GAEA,MAAM,sBAAA,GAAqBC,oBAAAA,OAAAA,CAAO;GAClC,MAAM,UAAU,KAAK,IAAI;GAKzB,iBAAiB;IACf,eAAe,WAAW,QAAQ,oBAAoB,OAAO;GAC/D,GAAG,qBAAqB;EAC1B;EAEA,SAAS,UAA8B;GACrC,QAAA,SAAgC,MAAM,MAAM,OAAO;EACrD;EAEA,SAAS,UAA8B;GACrC,QAAA,SAAgC,MAAM,KAAK;EAC7C;EAEA,SAAS,YAAgC;GACvC,QAAA,WAAkC,MAAM,MAAM,SAAS;EACzD;EAEA,SAAS,SAA6B;GACpC,IAAI,KAAK,SAAS,KAChB,QAAA,UAA+B,MAAM,KAAK;QAE1C,QAAA,SAAgC,MAAM,KAAK;EAE/C;EAEA,SAAS,WAAW,KAAqB;GACvC,IAAI,oBAAoB,SAAS,OAAO;GACxC,IAAI,oBAAoB,SAAS,OAAO;GACxC,IAAI,oBAAoB,QAAQ,MAAM;GACtC,IAAI,oBAAoB,WAAW,SAAS;GAC5C,MAAM,SAAS,OAAO,QAAQ,IAAI,GAAG;GACrC,IAAI,QACF,OAAO,yBAAyB,KAAA;EAEpC;EAEA,QAAQ,aAAyC;GAC/C,OAAO,SAAS,UAAgC,GAAG,MAAY;IAC7D,IAAI,CAAC,OAAO,YACV,OAAO,SAAS,MAAM,MAAM,IAAI;IAElC,MAAM,SAAS,OAAO,QAAQ,IAAI,IAAI;IACtC,IAAI,CAAC,QACH,OAAO,SAAS,MAAM,MAAM,IAAI;IAElC,MAAM,cAAc,OAAO;IAC3B,MAAM,UAAU,OAAO;IAEvB,IAAI,eAAe,SAAS;KAC1B,IAAI,OAAO,UAAU,CAAC,CAAC,sBAAsB,OAAO,IAAI;MACtD,MAAM,OAAO,KAAK;MAClB,MAAM,aAAaC,cAAAA,iBAAiB,IAAI;MACxC,IAAI,eAAe,KAAA,GACjB,YAAY,aAAaC,gBAAAA,6BAA6B,UAAU;KAEpE;KAEA,mBAAI,QAAQ,KACVf,mBAAI,MAAM,QAAQA,mBAAI,QAAQ,OAAO,GAAG,WAAW,SAC7C;MACJ,OAAO;MACP,OAAO,iBAAA,GAAgBa,oBAAAA,OAAAA,CAAO;MAC9B,YAAY,SAAA,MAA+B;MAE3C,KAAK,iBAAiB,SAAS,OAAO;MACtC,KAAK,iBAAiB,SAAS,OAAO;MACtC,KAAK,iBAAiB,QAAQ,MAAM;MACpC,KAAK,iBAAiB,WAAW,SAAS;MAE1C,OAAO,+BAA+B;OACpC,WAAW,IAAI;OACf,IAAI,OAAO,kBACT,OAAO,iBAAiB,SAAS,WAAW;MAEhD;MACA,OAAO,YAAY,MAAM,OAAO;MAChC,OAAO,qBAAqB,MAAM,OAAO;KAC3C,CACF;IACF;IACA,OAAO,SAAS,MAAM,MAAM,IAAI;GAClC;EACF;CACF;;;;CAKA,SAAkB;EAChB,IAAI,KAAK,YACP;EAEF,IAAI,KAAK,eAAe;GACtB,KAAK,MAAM,MACT,kCACA,KAAK,YACL,KAAK,OACP;GACA,KAAK,aAAa;GAClB;EACF;EAEA,IAAI;GACF,KAAK,MAAM,MAAM,qBAAqB,KAAK,YAAY,KAAK,OAAO;GACnE,KAAK,MAAM,eAAe,WAAW,QAAQ,KAAK,WAAW,CAAC;GAC9D,KAAK,MAAM,eAAe,WAAW,QAAQ,KAAK,WAAW,CAAC;GAC9D,KAAK,gBAAgB;GACrB,KAAK,aAAa;EACpB,SAAS,KAAK;GAEZ,KAAK,QAAQ,eAAe,WAAW,MAAM;GAC7C,KAAK,QAAQ,eAAe,WAAW,MAAM;GAC7C,KAAK,MAAM,KACT,uKAEA,GACF;EACF;CACF;;;;CAKA,UAAmB;EACjB,IAAI,CAAC,KAAK,YACR;EAEF,KAAK,aAAa;EAClB,KAAK,cAAc;EACnB,KAAK,0BAAU,IAAI,QAAgC;EACnD,KAAK,iCAAiB,IAAI,QAAmC;CAC/D;AACF"}
package/dist/xhr.d.cts ADDED
@@ -0,0 +1,134 @@
1
+ import { OpenFunction, PropagateTraceHeaderCorsUrls, SendFunction, XhrMem } from "./types.cjs";
2
+ import * as api from "@opentelemetry/api";
3
+ import { InstrumentationBase, InstrumentationConfig } from "@opentelemetry/instrumentation";
4
+ //#region src/xhr.d.ts
5
+ type XHRCustomAttributeFunction = (span: api.Span, xhr: XMLHttpRequest) => void;
6
+ /**
7
+ * XMLHttpRequest config
8
+ */
9
+ interface XMLHttpRequestInstrumentationConfig extends InstrumentationConfig {
10
+ /**
11
+ * The number of timing resources is limited, after the limit
12
+ * (chrome 250, safari 150) the information is not collected anymore.
13
+ * The only way to prevent that is to regularly clean the resources
14
+ * whenever it is possible. This is needed only when PerformanceObserver
15
+ * is not available
16
+ */
17
+ clearTimingResources?: boolean;
18
+ /** URLs which should include trace headers when origin doesn't match */
19
+ propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;
20
+ /**
21
+ * URLs that partially match any regex in ignoreUrls will not be traced.
22
+ * In addition, URLs that are _exact matches_ of strings in ignoreUrls will
23
+ * also not be traced.
24
+ */
25
+ ignoreUrls?: Array<string | RegExp>;
26
+ /** Function for adding custom attributes on the span */
27
+ applyCustomAttributesOnSpan?: XHRCustomAttributeFunction;
28
+ /** Ignore adding network events as span events */
29
+ ignoreNetworkEvents?: boolean;
30
+ /** Measure outgoing request size */
31
+ measureRequestSize?: boolean;
32
+ }
33
+ /**
34
+ * This class represents a XMLHttpRequest plugin for auto instrumentation
35
+ * @deprecated See https://github.com/open-telemetry/opentelemetry-browser/tree/main/packages/instrumentation#xhr-xmlhttprequest
36
+ */
37
+ declare class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRequestInstrumentationConfig> {
38
+ readonly component: string;
39
+ readonly version: string;
40
+ moduleName: string;
41
+ private _tasksCount;
42
+ private _xhrMem;
43
+ private _usedResources;
44
+ private _isEnabled;
45
+ private _isXhrPatched;
46
+ constructor(config?: XMLHttpRequestInstrumentationConfig);
47
+ init(): void;
48
+ /**
49
+ * Adds custom headers to XMLHttpRequest
50
+ * @param xhr
51
+ * @param spanUrl
52
+ * @private
53
+ */
54
+ private _addHeaders;
55
+ /**
56
+ * Add cors pre flight child span
57
+ * @param span
58
+ * @param corsPreFlightRequest
59
+ * @private
60
+ */
61
+ private _addChildSpan;
62
+ /**
63
+ * Add attributes when span is going to end
64
+ * @param span
65
+ * @param xhr
66
+ * @private
67
+ */
68
+ _addFinalSpanAttributes(span: api.Span, xhrMem: XhrMem): void;
69
+ private _applyAttributesAfterXHR;
70
+ /**
71
+ * will collect information about all resources created
72
+ * between "send" and "end" with additional waiting for main resource
73
+ * @param xhr
74
+ * @param spanUrl
75
+ * @private
76
+ */
77
+ private _addResourceObserver;
78
+ /**
79
+ * Clears the resource timings and all resources assigned with spans
80
+ * when {@link XMLHttpRequestInstrumentationConfig.clearTimingResources} is
81
+ * set to true (default false)
82
+ * @private
83
+ */
84
+ private _clearResources;
85
+ /**
86
+ * Finds appropriate resource and add network events to the span
87
+ * @param span
88
+ */
89
+ private _findResourceAndAddNetworkEvents;
90
+ /**
91
+ * Removes the previous information about span.
92
+ * This might happened when the same xhr is used again.
93
+ * @param xhr
94
+ * @private
95
+ */
96
+ private _cleanPreviousSpanInformation;
97
+ /**
98
+ * Creates a new span when method "open" is called
99
+ * @param xhr
100
+ * @param url
101
+ * @param method
102
+ * @private
103
+ */
104
+ private _createSpan;
105
+ /**
106
+ * Marks certain [resource]{@link PerformanceResourceTiming} when information
107
+ * from this is used to add events to span.
108
+ * This is done to avoid reusing the same resource again for next span
109
+ * @param resource
110
+ * @private
111
+ */
112
+ private _markResourceAsUsed;
113
+ /**
114
+ * Patches the method open
115
+ * @private
116
+ */
117
+ protected _patchOpen(): (original: OpenFunction) => OpenFunction;
118
+ /**
119
+ * Patches the method send
120
+ * @private
121
+ */
122
+ protected _patchSend(): (original: SendFunction) => SendFunction;
123
+ /**
124
+ * implements enable function
125
+ */
126
+ enable(): void;
127
+ /**
128
+ * implements disable function
129
+ */
130
+ disable(): void;
131
+ }
132
+ //#endregion
133
+ export { XHRCustomAttributeFunction, XMLHttpRequestInstrumentation, XMLHttpRequestInstrumentationConfig };
134
+ //# sourceMappingURL=xhr.d.cts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"xhr.d.cts","names":[],"sources":["../src/xhr.d.ts"],"mappings":";;;;KAIY,8BAA8B,MAAM,IAAI,MAAM,KAAK;;;;UAI9C,4CAA4C;;;;;;;;EAQzD;;EAEA,+BAA+B;;;;;;EAM/B,aAAa,eAAe;;EAE5B,8BAA8B;;EAE9B;;EAEA;;;;;;cAMiB,sCAAsC,oBAAoB;WAClE;WACA;EACT;UACQ;UACA;UACA;UACA;UACA;EACR,YAAY,SAAS;EACrB;;;;;;;UAOQ;;;;;;;UAOA;;;;;;;EAOR,wBAAwB,MAAM,IAAI,MAAM,QAAQ;UACxC;;;;;;;;UAQA;;;;;;;UAOA;;;;;UAKA;;;;;;;UAOA;;;;;;;;UAQA;;;;;;;;UAQA;;;;;YAKE,eAAe,UAAU,iBAAiB;;;;;YAK1C,eAAe,UAAU,iBAAiB;;;;EAIpD;;;;EAIA"}
package/dist/xhr.d.mts ADDED
@@ -0,0 +1,134 @@
1
+ import { OpenFunction, PropagateTraceHeaderCorsUrls, SendFunction, XhrMem } from "./types.mjs";
2
+ import * as api from "@opentelemetry/api";
3
+ import { InstrumentationBase, InstrumentationConfig } from "@opentelemetry/instrumentation";
4
+ //#region src/xhr.d.ts
5
+ type XHRCustomAttributeFunction = (span: api.Span, xhr: XMLHttpRequest) => void;
6
+ /**
7
+ * XMLHttpRequest config
8
+ */
9
+ interface XMLHttpRequestInstrumentationConfig extends InstrumentationConfig {
10
+ /**
11
+ * The number of timing resources is limited, after the limit
12
+ * (chrome 250, safari 150) the information is not collected anymore.
13
+ * The only way to prevent that is to regularly clean the resources
14
+ * whenever it is possible. This is needed only when PerformanceObserver
15
+ * is not available
16
+ */
17
+ clearTimingResources?: boolean;
18
+ /** URLs which should include trace headers when origin doesn't match */
19
+ propagateTraceHeaderCorsUrls?: PropagateTraceHeaderCorsUrls;
20
+ /**
21
+ * URLs that partially match any regex in ignoreUrls will not be traced.
22
+ * In addition, URLs that are _exact matches_ of strings in ignoreUrls will
23
+ * also not be traced.
24
+ */
25
+ ignoreUrls?: Array<string | RegExp>;
26
+ /** Function for adding custom attributes on the span */
27
+ applyCustomAttributesOnSpan?: XHRCustomAttributeFunction;
28
+ /** Ignore adding network events as span events */
29
+ ignoreNetworkEvents?: boolean;
30
+ /** Measure outgoing request size */
31
+ measureRequestSize?: boolean;
32
+ }
33
+ /**
34
+ * This class represents a XMLHttpRequest plugin for auto instrumentation
35
+ * @deprecated See https://github.com/open-telemetry/opentelemetry-browser/tree/main/packages/instrumentation#xhr-xmlhttprequest
36
+ */
37
+ declare class XMLHttpRequestInstrumentation extends InstrumentationBase<XMLHttpRequestInstrumentationConfig> {
38
+ readonly component: string;
39
+ readonly version: string;
40
+ moduleName: string;
41
+ private _tasksCount;
42
+ private _xhrMem;
43
+ private _usedResources;
44
+ private _isEnabled;
45
+ private _isXhrPatched;
46
+ constructor(config?: XMLHttpRequestInstrumentationConfig);
47
+ init(): void;
48
+ /**
49
+ * Adds custom headers to XMLHttpRequest
50
+ * @param xhr
51
+ * @param spanUrl
52
+ * @private
53
+ */
54
+ private _addHeaders;
55
+ /**
56
+ * Add cors pre flight child span
57
+ * @param span
58
+ * @param corsPreFlightRequest
59
+ * @private
60
+ */
61
+ private _addChildSpan;
62
+ /**
63
+ * Add attributes when span is going to end
64
+ * @param span
65
+ * @param xhr
66
+ * @private
67
+ */
68
+ _addFinalSpanAttributes(span: api.Span, xhrMem: XhrMem): void;
69
+ private _applyAttributesAfterXHR;
70
+ /**
71
+ * will collect information about all resources created
72
+ * between "send" and "end" with additional waiting for main resource
73
+ * @param xhr
74
+ * @param spanUrl
75
+ * @private
76
+ */
77
+ private _addResourceObserver;
78
+ /**
79
+ * Clears the resource timings and all resources assigned with spans
80
+ * when {@link XMLHttpRequestInstrumentationConfig.clearTimingResources} is
81
+ * set to true (default false)
82
+ * @private
83
+ */
84
+ private _clearResources;
85
+ /**
86
+ * Finds appropriate resource and add network events to the span
87
+ * @param span
88
+ */
89
+ private _findResourceAndAddNetworkEvents;
90
+ /**
91
+ * Removes the previous information about span.
92
+ * This might happened when the same xhr is used again.
93
+ * @param xhr
94
+ * @private
95
+ */
96
+ private _cleanPreviousSpanInformation;
97
+ /**
98
+ * Creates a new span when method "open" is called
99
+ * @param xhr
100
+ * @param url
101
+ * @param method
102
+ * @private
103
+ */
104
+ private _createSpan;
105
+ /**
106
+ * Marks certain [resource]{@link PerformanceResourceTiming} when information
107
+ * from this is used to add events to span.
108
+ * This is done to avoid reusing the same resource again for next span
109
+ * @param resource
110
+ * @private
111
+ */
112
+ private _markResourceAsUsed;
113
+ /**
114
+ * Patches the method open
115
+ * @private
116
+ */
117
+ protected _patchOpen(): (original: OpenFunction) => OpenFunction;
118
+ /**
119
+ * Patches the method send
120
+ * @private
121
+ */
122
+ protected _patchSend(): (original: SendFunction) => SendFunction;
123
+ /**
124
+ * implements enable function
125
+ */
126
+ enable(): void;
127
+ /**
128
+ * implements disable function
129
+ */
130
+ disable(): void;
131
+ }
132
+ //#endregion
133
+ export { XHRCustomAttributeFunction, XMLHttpRequestInstrumentation, XMLHttpRequestInstrumentationConfig };
134
+ //# sourceMappingURL=xhr.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"xhr.d.mts","names":[],"sources":["../src/xhr.d.ts"],"mappings":";;;;KAIY,8BAA8B,MAAM,IAAI,MAAM,KAAK;;;;UAI9C,4CAA4C;;;;;;;;EAQzD;;EAEA,+BAA+B;;;;;;EAM/B,aAAa,eAAe;;EAE5B,8BAA8B;;EAE9B;;EAEA;;;;;;cAMiB,sCAAsC,oBAAoB;WAClE;WACA;EACT;UACQ;UACA;UACA;UACA;UACA;EACR,YAAY,SAAS;EACrB;;;;;;;UAOQ;;;;;;;UAOA;;;;;;;EAOR,wBAAwB,MAAM,IAAI,MAAM,QAAQ;UACxC;;;;;;;;UAQA;;;;;;;UAOA;;;;;UAKA;;;;;;;UAOA;;;;;;;;UAQA;;;;;;;;UAQA;;;;;YAKE,eAAe,UAAU,iBAAiB;;;;;YAK1C,eAAe,UAAU,iBAAiB;;;;EAIpD;;;;EAIA"}