feat(opentelemetry-instrumentation-xhr): optionally ignore network events

[MustafaHaddara]

Which problem is this PR solving?

PR #3028 added a ignoreNetworkEvents boolean to the experimental/opentelemetry-instrumentation-fetch package. This PR adds the same behaviour + flag to the experimental/opentelemetry-instrumentation-xml-http-request package.

Quoting from that PR

Summary: This PR allows to optionally disable adding network events as span events to control the total volume of telemetry data produced.

Some of the modern vendors treat spans and span events (annotations) equally – both are counted towards the overall retained events volume. Similarly, vendors that charge for the overall size of data retained will count span annotations as part of the data. Typically, span produced by the @opentelemetry-instrumentation-fetch includes 9 network events – 10 event items along with the span itself. It would be great to have ability to optionally disable network events being added as span annotations to reduce the overall volume of data/events generated and eventually retained.

Short description of the changes

This PR adds an optional boolean flag ignoreNetworkEvents to the XMLHttpRequest instrumentation. When set to true network events are not added to the span.

Type of change

Please delete options that are not relevant.

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How Has This Been Tested?

Running npm run test:browser will run the newly added test as part of the suite:

...
when network events are ignored
  ✓ should NOT add network events

Checklist:

• Followed the style guidelines of this project
• Unit tests have been added
• Documentation has been updated

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1206873139078450

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: MustafaHaddara / name: Mustafa Haddara (9fce974)

[codecov]

Codecov Report

Merging #4571 (9fce974) into main (f6a075b) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #4571   +/-   ##
=======================================
  Coverage   92.84%   92.84%           
=======================================
  Files         328      328           
  Lines        9494     9496    +2     
  Branches     2040     2042    +2     
=======================================
+ Hits         8815     8817    +2     
  Misses        679      679           

Files	Coverage Δ
...emetry-instrumentation-xml-http-request/src/xhr.ts	97.63% <100.00%> (+0.02%)	⬆️

[JamieDanielson]

LGTM, thanks for adding this!