npmpackage.info

Gathering detailed insights and metrics for @opentelemetry/instrumentation-xml-http-request

Other packages similar to @opentelemetry/instrumentation-xml-http-request

@opentelemetry/plugin-xml-http-request

0.12.0

OpenTelemetry XMLHttpRequest automatic instrumentation package.

kelvin-instrumentation-xml-http-request

0.12.2

OpenTelemetry XMLHttpRequest automatic instrumentation package.

@yotamloe/instrumentation-xml-http-request

0.0.2

OpenTelemetry XMLHttpRequest automatic instrumentation package.

middleware.io-instrumentation-xml-http-request

0.0.1

XMLHttpRequest automatic instrumentation package.

Gathering detailed insights and metrics for @opentelemetry/instrumentation-xml-http-request

@opentelemetry/instrumentation-xml-http-request - 0.202.0 | npmpackage.info

@opentelemetry/instrumentation-xml-http-request

OpenTelemetry JavaScript Client

0.202.0

3,020

Apache-2.0

TypeScript

5.20 kB

22,580,716 6.4

Installations

npm install @opentelemetry/instrumentation-xml-http-request

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

^18.19.0 || >=20.6.0

Node Version

18.20.8

NPM Version

lerna/6.6.2/node@v18.20.8+x64 (linux)

Score

92.7

Supply Chain

98.8

Quality

92.5

Maintenance

100

Vulnerability

99.3

License

Pull Requests

Open

35

Total

3,275

Closed

619

Merged

2,621

Issues

Open

229

Total

2,105

Closed

1,876

Releases

149

experimental/v0.202.0

Updated on Jun 02, 2025

semconv/v1.34.0

Updated on May 21, 2025

semconv/v1.33.1

Updated on May 20, 2025

experimental/v0.201.1

Updated on May 19, 2025

experimental/v0.201.0

Updated on May 15, 2025

v2.0.1

Updated on May 15, 2025

View All 149 releases

Languages

TypeScript

JavaScript

Jinja

Shell

TypeScript (96.66%)

JavaScript (3.06%)

Jinja (0.19%)

Shell (0.08%)

Developer

open-telemetry

Download Statistics

Total Downloads

22,580,716

Last Day

12,251

Last Week

471,512

Last Month

2,064,321

Last Year

15,399,925

GitHub Statistics

Apache-2.0 License

3,020 Stars

2,703 Commits

899 Forks

53 Watchers

15 Branches

337 Contributors

Updated on Jul 02, 2025

Bundle Size

14.73 kB

Minified

5.20 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 337 Contributors

Package Meta Information

Latest Version

0.202.0

Package Id

@opentelemetry/instrumentation-xml-http-request@0.202.0

Unpacked Size

303.22 kB

Size

47.23 kB

File Count

NPM Version

lerna/6.6.2/node@v18.20.8+x64 (linux)

Node Version

18.20.8

Published on

Jun 02, 2025

Total Downloads

Cumulative downloads

Total Downloads

22,580,716

Last Day

-14.8%

12,251

Compared to previous day

Last Week

-13.6%

471,512

Compared to previous week

Last Month

8.5%

2,064,321

Compared to previous month

Last Year

202.4%

15,399,925

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

OpenTelemetry XMLHttpRequest Instrumentation for web

Note: This is an experimental package. New releases may include breaking changes.

This module provides auto instrumentation for web using XMLHttpRequest.

Installation

1npm install --save @opentelemetry/instrumentation-xml-http-request

Usage

1import {
2  ConsoleSpanExporter,
3  SimpleSpanProcessor,
4  WebTracerProvider,
5} from '@opentelemetry/sdk-trace-web';
6import { XMLHttpRequestInstrumentation } from '@opentelemetry/instrumentation-xml-http-request';
7import { ZoneContextManager } from '@opentelemetry/context-zone';
8import { registerInstrumentations } from '@opentelemetry/instrumentation';
9
10const providerWithZone = new WebTracerProvider({
11  spanProcessors: [new SimpleSpanProcessor(new ConsoleSpanExporter())]
12});
13
14providerWithZone.register({
15  contextManager: new ZoneContextManager(),
16});
17
18registerInstrumentations({
19  instrumentations: [
20    new XMLHttpRequestInstrumentation({
21      propagateTraceHeaderCorsUrls: ['http://localhost:8090']
22    }),
23  ],
24});
25
26
27const webTracerWithZone = providerWithZone.getTracer('default');
28
29/////////////////////////////////////////
30
31// or plugin can be also initialised separately and then set the tracer provider or meter provider
32const xmlHttpRequestInstrumentation = new XMLHttpRequestInstrumentation({
33  propagateTraceHeaderCorsUrls: ['http://localhost:8090']
34});
35const providerWithZone = new WebTracerProvider();
36providerWithZone.register({
37  contextManager: new ZoneContextManager(),
38});
39xmlHttpRequestInstrumentation.setTracerProvider(providerWithZone);
40/////////////////////////////////////////
41
42
43// and some test
44const req = new XMLHttpRequest();
45req.open('GET', 'http://localhost:8090/xml-http-request.js', true);
46req.send();

XHR Instrumentation options

XHR instrumentation plugin has few options available to choose from. You can set the following:

Options	Type	Description
`applyCustomAttributesOnSpan`	`XHRCustomAttributeFunction`	Function for adding custom attributes
`ignoreNetworkEvents`	boolean	Disable network events being added as span events (network events are added by default)
`measureRequestSize`	boolean	Measure outgoing request length (outgoing request length is not measured by default)
`semconvStabilityOptIn`	string	A comma-separated string of tokens as described for `OTEL_SEMCONV_STABILITY_OPT_IN` in the HTTP semantic convention stability migration guide. See the "Semantic Conventions" section below.

Semantic Conventions

Up to and including v0.200.0, instrumentation-xml-http-request generates telemetry using Semantic Conventions v1.7.0.

HTTP semantic conventions (semconv) were stabilized in semconv v1.23.0, and a migration process was defined. instrumentation-xml-http-request versions 0.201.0 and later include support for migrating to stable HTTP semantic conventions, as described below. The intent is to provide an approximate 6 month time window for users of this instrumentation to migrate to the new HTTP semconv, after which a new minor version will change to use the new semconv by default and drop support for the old semconv. See the HTTP semconv migration plan for OpenTelemetry JS instrumentations.

To select which semconv version(s) is emitted from this instrumentation, use the semconvStabilityOptIn configuration option. This option works as described for OTEL_SEMCONV_STABILITY_OPT_IN:

http: emit the new (stable) v1.23.0 semantics
http/dup: emit both the old v1.7.0 and the new (stable) v1.23.0 semantics
By default, if semconvStabilityOptIn includes neither of the above tokens, the old v1.7.0 semconv is used.

Span status: When the stable semconv is selected, the span status is set to ERROR when the response status code is >=400 or when the response fails with an 'error' or 'timeout' XHR event. When just the old semconv is select, the span status is not set.

Span attributes:

v1.7.0 semconv	v1.23.0 semconv	Notes
`http.method`	`http.request.method`	HTTP request method. With v1.23.0 semconv `http.request.method_original` may also be included.
`http.url`	`url.full`	Full HTTP request URL
`http.host`	`server.address` and `server.port`	The hostname and port of the request URL
`http.status_code`	`http.response.status_code`	HTTP response status code
`http.request_content_length_uncompressed`	`http.request.body.size`	This is only added if `measureRequestSize` is `true`.
`http.response_content_length_uncompressed`	(not included)	Stable HTTP semconv would use `http.response.body.size`, but this is an `Opt-In` attribute, so would require adding a configuration option to this instrumentation to enable.
`http.response_content_length`	(not included)	Stable HTTP semconv would use `http.response.header.<key>`, but this is an `Opt-In` attribute, so would require adding a configuration option to this instrumentation to enable.
(no equivalent)	`error.type`	The response status (as a string), if the response status was `>=400`, or one of these possible request errors: 'timeout' and 'error'.
`http.user_agent`	(not included)	Stable HTTP semconv would use `user_agent.original`, but this is an `Opt-In` attribute, so would require adding a configuration option to this instrumentation to enable.
`http.scheme`	(not included)	Stable HTTP semconv would use `url.scheme`, but this is an `Opt-In` attribute, so would require adding a configuration option to this instrumentation to enable.
`http.status_text`	(not included)	This is no longer a documented semantic conventions attribute.

Example Screenshots

Screenshot of the running example

See examples/tracer-web for a short example.

Useful links

For more information on OpenTelemetry, visit: https://opentelemetry.io/
For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

No vulnerabilities found.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Maintained

Determines if the project is "actively maintained".

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

SAST

Determines if the project uses static code analysis.

10

CI-Tests

Determines if the project runs tests before pull requests are merged.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/benchmark.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/benchmark.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/benchmark.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/benchmark.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/changelog.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/changelog.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/close-stale.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/close-stale.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-or-update-release-pr.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/create-or-update-release-pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-or-update-release-pr.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/create-or-update-release-pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yaml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/docs.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/docs.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yaml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/docs.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/e2e.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/e2e.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/lint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/lint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/peer-api.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/peer-api.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-npm.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/publish-to-npm.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-npm.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/publish-to-npm.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/survey-on-merged-pr.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/survey-on-merged-pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-test.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:107: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:109: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-test.yml:125: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:136: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:137: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-test.yml:153: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/w3c-integration-test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/w3c-integration-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/w3c-integration-test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/w3c-integration-test.yml/main?enable=pin
Warn: pipCommand not pinned by hash: integration-tests/tracecontext-integration-test.sh:13
Warn: pipCommand not pinned by hash: integration-tests/tracecontext-integration-test.sh:14
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:30
Warn: npmCommand not pinned by hash: .github/workflows/create-or-update-release-pr.yml:49
Warn: npmCommand not pinned by hash: .github/workflows/e2e.yml:35
Warn: npmCommand not pinned by hash: .github/workflows/e2e.yml:41
Warn: npmCommand not pinned by hash: .github/workflows/peer-api.yml:21
Warn: npmCommand not pinned by hash: .github/workflows/peer-api.yml:24
Warn: npmCommand not pinned by hash: .github/workflows/sbom.yml:22
Warn: npmCommand not pinned by hash: .github/workflows/unit-test.yml:40
Warn: npmCommand not pinned by hash: .github/workflows/unit-test.yml:46
Info: 4 out of 39 GitHub-owned GitHubAction dependencies pinned
Info: 2 out of 7 third-party GitHubAction dependencies pinned
Info: 0 out of 2 pipCommand dependencies pinned
Info: 11 out of 20 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

6.4

/10

Last Scanned on 2025-07-02T07:36:17Z

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @opentelemetry/instrumentation-xml-http-request

Other packages similar to @opentelemetry/instrumentation-xml-http-request

@opentelemetry/instrumentation-xml-http-request

Installations

Developer Guide

Yes

CommonJS

^18.19.0 || >=20.6.0

18.20.8

lerna/6.6.2/node@v18.20.8+x64 (linux)

Score

Pull Requests

35

3,275

619

2,621

Issues

229

2,105

1,876

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

14.73 kB

5.20 kB

Maintainers

Package Meta Information

Total Downloads

22,580,716

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

OpenTelemetry XMLHttpRequest Instrumentation for web

Installation

Usage

XHR Instrumentation options

Semantic Conventions

Example Screenshots

Useful links

License

10

10

10

10

10

10

10

10

10

10

3

0

0

0

0

0

6.4

/10