Upgrading @opentelemetry/core from 1.x to 2.x

Comparison of the public API of @opentelemetry/core 1.30.1 and 2.11.0, computed automatically from their TypeScript types. A changed signature is a candidate for a breaking change, not a certainty.

Summary

Removed import paths	0
Removed exports	26
Changed signatures	5
Removed class or interface members	3
Changed class or interface members	1
Newly deprecated	4
Requirement changes (engines, peer dependencies)	1
New exports	7

Removed exports

import	export	kind	Before
`@opentelemetry/core`	`getEnv`	function	`(): Required<ENVIRONMENT>`
`@opentelemetry/core`	`VERSION`	variable	`"1.30.1"`
`@opentelemetry/core`	`isWrapped`	function	`(func: unknown): func is ShimWrapped`
`@opentelemetry/core`	`ENVIRONMENT`	type	{ CONTAINER_NAME?: string \| undefined; ECS_CONTAINER_METADATA_URI_V4?: string \| undefined; ECS_CONTAINER_METADATA_URI?: string \| undefined; HOSTNAME?: string \| undefined; KUBERNETES_SERVICE_HOST?: string \| undefined; NAMESPACE?: string \| undefined; OTEL_EXPORTER_JAEGER_AGENT_HOST?: string \| undefined; OTEL_EXPORTER_JAEGER_ENDPOINT?: string \| undefined; OTEL_EXPORTER_JAEGER_PASSWORD?: string \| undefined; OTEL_EXPORTER_JAEGER_USER?: string \| undefined; OTEL_EXPORTER_OTLP_ENDPOINT?: string \| undefined; OTEL_EXPORTER_OTLP_TRACES_ENDPOINT?: string \| undefined; OTEL_EXPORTER_OTLP_METRICS_ENDPOINT?: …
`@opentelemetry/core`	`IdGenerator`	interface	`interface`
`@opentelemetry/core`	`ShimWrapped`	interface	`interface`
`@opentelemetry/core`	`hexToBase64`	function	`(hexStr: string): string`
`@opentelemetry/core`	`hexToBinary`	function	`(hexStr: string): Uint8Array<ArrayBufferLike>`
`@opentelemetry/core`	`baggageUtils`	variable	`{ getKeyPairs: (baggage: Baggage) => string[]; serializeKeyPairs: (keyPairs: string[]) => string; parseKeyPairsIntoRecord: (value?: string \| undefined) => Record<string, string>; parsePairKeyValue: (entry: string) => ParsedBaggageKeyValue \| undefined; }`
`@opentelemetry/core`	`isAttributeKey`	function	`(key: unknown): key is string`
`@opentelemetry/core`	`AlwaysOnSampler`	class	`class`
`@opentelemetry/core`	`RAW_ENVIRONMENT`	type	`{ [key: string]: string \| number \| string[] \| undefined; }`
`@opentelemetry/core`	`AlwaysOffSampler`	class	`class`
`@opentelemetry/core`	`TimeOriginLegacy`	interface	`interface`
`@opentelemetry/core`	`parseEnvironment`	function	`(values: RAW_ENVIRONMENT): ENVIRONMENT`
`@opentelemetry/core`	`RandomIdGenerator`	class	`class`
`@opentelemetry/core`	`ParentBasedSampler`	class	`class`
`@opentelemetry/core`	`DEFAULT_ENVIRONMENT`	variable	`Required<ENVIRONMENT>`
`@opentelemetry/core`	`TracesSamplerValues`	enum	`TracesSamplerValues`
`@opentelemetry/core`	`getEnvWithoutDefaults`	function	`(): ENVIRONMENT`
`@opentelemetry/core`	`InstrumentationLibrary`	interface	`interface`
`@opentelemetry/core`	`TraceIdRatioBasedSampler`	class	`class`
`@opentelemetry/core`	`DEFAULT_ATTRIBUTE_COUNT_LIMIT`	variable	`128`
`@opentelemetry/core`	`DEFAULT_ATTRIBUTE_VALUE_LENGTH_LIMIT`	variable	`number`
`@opentelemetry/core`	`DEFAULT_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT`	variable	`128`
`@opentelemetry/core`	`DEFAULT_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT`	variable	`128`

Changed signatures

export	Before	After
`@opentelemetry/core · SDK_INFO`	`{ "telemetry.sdk.name": string; "process.runtime.name": string; "telemetry.sdk.language": string; "telemetry.sdk.version": string; }`	`{ "telemetry.sdk.name": string; "process.runtime.name": string; "telemetry.sdk.language": "nodejs"; "telemetry.sdk.version": string; }`
`@opentelemetry/core · unrefTimer`	`(timer: NodeJS.Timer): void`	`(timer: number \| { unref(): unknown; }): void`
`@opentelemetry/core · otperformance`	`any`	`{ now(): number; readonly timeOrigin: number; }`
`@opentelemetry/core · isAttributeValue`	`(val: unknown): val is SpanAttributeValue`	`(val: unknown): val is AttributeValue`
`@opentelemetry/core · sanitizeAttributes`	`(attributes: unknown): SpanAttributes`	`(attributes: unknown): Attributes`

Removed class or interface members

member	import	Before
`TraceState._keys`	`@opentelemetry/core`	`any`
`TraceState._clone`	`@opentelemetry/core`	`any`
`TraceState._parse`	`@opentelemetry/core`	`any`

Changed class or interface members

member	Before	After
`BindOnceFuture.constructor`	`<R, This = unknown, T extends (this: This, ...args: unknown[]) => R = () => R>(_callback: T, _that: This): BindOnceFuture<R, This, T>`	`<R, This = unknown, T extends (this: This, ...args: unknown[]) => R = () => R>(callback: T, that: This): BindOnceFuture<R, This, T>`

Newly deprecated

export	@deprecated
`@opentelemetry/core · unrefTimer`	please copy this code to your implementation instead, this function will be removed in the next major version of this package.
`@opentelemetry/core · _globalThis`	Use globalThis directly instead.
`@opentelemetry/core · getTimeOrigin`	Use `performance.timeOrigin` directly.
`@opentelemetry/core · otperformance`	Use performance directly.

Requirement changes (engines, peer dependencies)

	Before	After
`engines.node`	`>=14`	`^18.19.0 \|\| >=20.6.0`

New exports (7)

import	export	kind
`@opentelemetry/core`	`hrTimeToSeconds`	function
`@opentelemetry/core`	`getNumberFromEnv`	function
`@opentelemetry/core`	`getStringFromEnv`	function
`@opentelemetry/core`	`getBooleanFromEnv`	function
`@opentelemetry/core`	`getStringListFromEnv`	function
`@opentelemetry/core`	`diagLogLevelFromString`	function
`@opentelemetry/core`	`parseKeyPairsIntoRecord`	function

Frequently asked questions

What are the breaking changes when upgrading @opentelemetry/core from 1 to 2?

Between @opentelemetry/core 1.30.1 and 2.11.0, Vigia found 26 removed exports, 5 changed signatures and 4 removed or changed class or interface members.

What became deprecated in @opentelemetry/core 2?

4 exports or members are newly marked as deprecated in @opentelemetry/core 2.11.0.

For agents

GET https://vigia.coredls.cloud/v1/packages/npm/@opentelemetry/core/upgrade?from=1.30.1&to=2.11.0