Upgrade AppInsights 3.x to use OpenTelemetry JS 2.x Dependencies #1449

JacksonWeber · 2025-07-09T22:49:25Z

This pull request includes updates to dependencies, refactors for compatibility with the latest OpenTelemetry SDK, and improvements to resource handling and telemetry processing. It also includes test updates and minor bug fixes. Below is a summary of the most important changes:

Dependency Updates

Updated Node.js version in the GitHub Actions workflow from 16.x to 18.x. (.github/workflows/integration.yml)
Upgraded various OpenTelemetry and Azure Monitor dependencies in package.json to their latest versions, including @opentelemetry/core and @azure/monitor-opentelemetry.

OpenTelemetry Refactors

Replaced Resource with resourceFromAttributes for resource creation in src/agent/appServicesLoader.ts and src/agent/azureFunctionsLoader.ts for compatibility with the updated OpenTelemetry SDK. [1] [2] [3] [4]
Replaced Resource.default() and environment-based resource detection with defaultResource() in src/shared/configuration/config.ts. [1] [2]

Telemetry Processing Enhancements

Refactored useAzureMonitor in src/main.ts to dynamically add OTLP exporters and processors for spans and logs based on configuration. [1] [2]
Added support for a new flushAzureMonitor method in src/main.ts to improve telemetry flushing capabilities.

Bug Fixes

Fixed incorrect parent span context handling in CorrelationContextManager by replacing parentSpanId with parentSpanContext?.spanId. [1] [2]
Updated ignoreOutgoingRequestHook in src/shared/util/common.ts to cast headers as a typed object for better type safety.

Test Updates

Updated unit tests to use ES module imports for assert and sinon instead of CommonJS imports. [1] [2]
Adjusted assertions in aksLoader.tests.ts to reflect changes in telemetry exporter registration.

Copilot

Pull Request Overview

This pull request upgrades AppInsights from 3.x to use OpenTelemetry JS 2.x dependencies, focusing on dependency version upgrades, testing approach improvements, and compatibility updates. The most significant changes include updating OpenTelemetry-related packages to 2.x versions, modernizing import statements throughout test files, and adapting to new OpenTelemetry 2.x APIs.

Updated OpenTelemetry dependencies from 1.30.x/0.57.x versions to 2.x/0.202.x versions
Modernized import statements from CommonJS-style to ES6 imports across test files
Updated span context handling to use new OpenTelemetry 2.x API patterns
Modified testing strategies to work with the new processor architecture

Reviewed Changes

Copilot reviewed 30 out of 32 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
package.json	Updated OpenTelemetry dependencies to 2.x versions
test/unitTests/*/.tests.ts	Modernized import statements and updated test implementations
src/main.ts	Refactored OTLP exporter handling to work with new architecture
src/shim/correlationContextManager.ts	Updated span context API usage for 2.x compatibility
src/shared/configuration/config.ts	Simplified resource creation using new APIs
src/agent/*.ts	Updated resource creation methods

Comments suppressed due to low confidence (1)

Copilot · 2025-07-24T17:32:39Z

test/unitTests/shim/telemetryClient.tests.ts

+        // Add test processors through the Azure Monitor options
+        client.config.azureMonitorOpenTelemetryOptions = {
+            spanProcessors: [testProcessor],
+            logRecordProcessors: [logProcessor as any] // Type assertion needed for version compatibility


The type assertion 'as any' bypasses type safety. Consider creating a proper type adapter or interface to handle the version compatibility issue more safely.

Suggested change

logRecordProcessors: [logProcessor as any] // Type assertion needed for version compatibility

logRecordProcessors: [new LogProcessorAdapter(logProcessor)] // Use adapter for version compatibility

Copilot · 2025-07-24T17:32:39Z

test/unitTests/shim/correlationContextManger.tests.ts

+                        traceFlags: 1,
+                    }),
+                    name: "testSpan",
+                } as unknown as Span;


The double type assertion 'as unknown as Span' indicates a potential type mismatch. Consider creating a proper mock object that implements the Span interface correctly.

Suggested change

} as unknown as Span;

// Mock implementations for required methods

setAttribute: () => mockSpan,

setAttributes: () => mockSpan,

addEvent: () => mockSpan,

setStatus: () => mockSpan,

updateName: () => mockSpan,

end: () => {},

isRecording: () => false,

recordException: () => {},

};

Copilot · 2025-07-24T17:32:40Z

test/unitTests/shim/config.tests.ts

            assert.equal(options.enableTraceBasedSamplingForLogs, false, "wrong enableTraceBasedSamplingForLogs");
-            assert.equal(options.enableLiveMetrics, false, "wrong enableTraceBasedSamplingForLogs");
-            assert.equal(options.enableStandardMetrics, false, "wrong enableTraceBasedSamplingForLogs");
+            assert.equal(options.enableLiveMetrics, false, "wrong enableLiveMetrics");


[nitpick] The error message should be more descriptive than 'wrong enableLiveMetrics'. Consider using 'incorrect enableLiveMetrics value' or similar.

Suggested change

assert.equal(options.enableLiveMetrics, false, "wrong enableLiveMetrics");

assert.equal(options.enableLiveMetrics, false, "incorrect enableLiveMetrics value");

Copilot · 2025-07-24T17:32:40Z

test/unitTests/shim/config.tests.ts

-            assert.equal(options.enableLiveMetrics, false, "wrong enableTraceBasedSamplingForLogs");
-            assert.equal(options.enableStandardMetrics, false, "wrong enableTraceBasedSamplingForLogs");
+            assert.equal(options.enableLiveMetrics, false, "wrong enableLiveMetrics");
+            assert.equal(options.enableStandardMetrics, false, "wrong enableStandardMetrics");


[nitpick] The error message should be more descriptive than 'wrong enableStandardMetrics'. Consider using 'incorrect enableStandardMetrics value' or similar.

Suggested change

assert.equal(options.enableStandardMetrics, false, "wrong enableStandardMetrics");

assert.equal(options.enableStandardMetrics, false, "incorrect enableStandardMetrics value");

Copilot · 2025-07-24T17:32:40Z

test/functionalTests/runner/testValidation.js

-                    Utils.Logging.error("FAILED EXPECTATION - Unexpected child telemetry item(s)!");
-                    Utils.Logging.error(JSON.stringify(dataSet, null, 2));
-                    hadFailed = true;
+                    dataSet[0].data.baseData?.message


This line appears to be a dangling expression that serves no purpose. It should either be assigned to a variable, used in a condition, or removed.

Suggested change

dataSet[0].data.baseData?.message

src/main.ts

JacksonWeber and others added 12 commits July 3, 2025 13:49

Update to 2.x dependencies.

db5c8f1

Initial update commit.

26a74c6

Add todos.

4c9b3d2

Use extensible processor workaround.

263b193

We no longer allow attempts to add metric exporters on the fly.

508fae0

Use default exports over wildcard exports.

bea1f93

Use further default exports.

1b06d59

Fix interface issues with config tests.

32a1588

Update the histogram creation test.

fe04201

Merge branch 'main' into jacksonweber/upgrade-2.x-otel

9f100df

Clean unused code.

5dfcf20

Remove unused imports.

e23ce0d

JacksonWeber requested a review from Copilot July 10, 2025 01:18

This comment was marked as outdated.

Sign in to view

JacksonWeber added 4 commits July 9, 2025 19:10

Revert back compat tests.

10968f6

Update integration.yml

76aa81f

Remove the extensible processors.

5fe68e2

Fix telemetry client tests.

baf671b

JacksonWeber marked this pull request as ready for review July 11, 2025 16:23

JacksonWeber mentioned this pull request Jul 11, 2025

setAutoCollectDependencies not working after upgrading from v2 to v3 #1422

Closed

JacksonWeber added 7 commits July 21, 2025 13:33

Testing updates to integration tests & add new tests for OTLP exporters.

9289a40

Fix integration tests failing from otel telemetry.

e92e4a5

Update testValidation.js

5404e3c

Update testValidation.js

2eebbd1

Fix test check.

c3e9a39

Update testValidation.js

56b0a8b

Clean up changes.

4793be2

JacksonWeber requested review from Copilot and hectorhdzg July 22, 2025 21:29

Copilot AI reviewed Jul 24, 2025

View reviewed changes

Pin sdk-logs version and fix typing.

5f16de4

hectorhdzg approved these changes Jul 24, 2025

View reviewed changes

JacksonWeber merged commit 040f4be into main Jul 24, 2025
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Upgrade AppInsights 3.x to use OpenTelemetry JS 2.x Dependencies #1449

Upgrade AppInsights 3.x to use OpenTelemetry JS 2.x Dependencies #1449

Uh oh!

JacksonWeber commented Jul 9, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Copilot AI Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	logRecordProcessors: [logProcessor as any] // Type assertion needed for version compatibility
	logRecordProcessors: [new LogProcessorAdapter(logProcessor)] // Use adapter for version compatibility

-                } as unknown as Span;
+                    // Mock implementations for required methods
+                    setAttribute: () => mockSpan,
+                    setAttributes: () => mockSpan,
+                    addEvent: () => mockSpan,
+                    setStatus: () => mockSpan,
+                    updateName: () => mockSpan,
+                    end: () => {},
+                    isRecording: () => false,
+                    recordException: () => {},
+                };

	assert.equal(options.enableLiveMetrics, false, "wrong enableLiveMetrics");
	assert.equal(options.enableLiveMetrics, false, "incorrect enableLiveMetrics value");

	assert.equal(options.enableStandardMetrics, false, "wrong enableStandardMetrics");
	assert.equal(options.enableStandardMetrics, false, "incorrect enableStandardMetrics value");

Upgrade AppInsights 3.x to use OpenTelemetry JS 2.x Dependencies #1449

Upgrade AppInsights 3.x to use OpenTelemetry JS 2.x Dependencies #1449

Uh oh!

Conversation

JacksonWeber commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Updates

OpenTelemetry Refactors

Telemetry Processing Enhancements

Bug Fixes

Test Updates

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JacksonWeber commented Jul 9, 2025 •

edited

Loading