Skip to content

Commit 1e21b7b

Browse files
committed
Misc. fixes
1 parent 3f359ad commit 1e21b7b

File tree

1 file changed

+26
-27
lines changed

1 file changed

+26
-27
lines changed

articles/azure-monitor/app/opentelemetry-nodejs-migrate.md

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ ms.reviewer: mmcc
1212

1313
This article details two options to upgrade from the Azure Monitor Application Insights Node.js 2.X SDK to OpenTelemetry.
1414

15-
* [Clean install](#clean-install) the [Node.js Azure Monitor OpenTelemetry Distro](https://github.com/microsoft/opentelemetry-azure-monitor-js). (preferred)
16-
* [Upgrade](#upgrade) to Node.js SDK 3.X.
15+
* [Clean install](opentelemetry-nodejs-migrate.md?tabs=clean-install) the [Node.js Azure Monitor OpenTelemetry Distro](https://github.com/microsoft/opentelemetry-azure-monitor-js).
16+
* [Upgrade](opentelemetry-nodejs-migrate.md?tabs=upgrade) to Node.js SDK 3.X.
1717

1818
Upgrading to OpenTelemetry:
1919

@@ -26,63 +26,63 @@ Upgrading to OpenTelemetry:
2626

2727
1. Gain prerequisite knowledge of the OpenTelemetry JavaScript Application Programming Interface (API) and Software Development Kit (SDK).
2828

29-
* Read [OpenTelemetry JavaScript documentation](https://opentelemetry.io/docs/languages/js/).
30-
* Review [Configure Azure Monitor OpenTelemetry](opentelemetry-configuration.md?tabs=nodejs).
31-
* Evaluate [Add, modify, and filter OpenTelemetry](opentelemetry-add-modify.md?tabs=nodejs).
29+
* Read [OpenTelemetry JavaScript documentation](https://opentelemetry.io/docs/languages/js/).
30+
* Review [Configure Azure Monitor OpenTelemetry](opentelemetry-configuration.md?tabs=nodejs).
31+
* Evaluate [Add, modify, and filter OpenTelemetry](opentelemetry-add-modify.md?tabs=nodejs).
3232

33-
1. Uninstall the `applicationinsights` dependency from your project.
33+
2. Uninstall the `applicationinsights` dependency from your project.
3434

35-
```shell
36-
npm uninstall applicationinsights
37-
```
35+
```shell
36+
npm uninstall applicationinsights
37+
```
3838

39-
1. Remove 2.X SDK implementation from your code.
39+
3. Remove 2.X SDK implementation from your code.
4040

41-
Remove all Application Insights instrumentation from your code. You must delete any sections where the Application Insights client initializes, modifies, or calls.
41+
Remove all Application Insights instrumentation from your code. You must delete any sections where the Application Insights client initializes, modifies, or calls.
4242

43-
1. Enable Application Insights with the Azure Monitor OpenTelemetry Distro.
43+
4. Enable Application Insights with the Azure Monitor OpenTelemetry Distro.
4444

45-
Follow [getting started](opentelemetry-enable.md?tabs=nodejs) to onboard to the Azure Monitor OpenTelemetry Distro.
45+
Follow [getting started](opentelemetry-enable.md?tabs=nodejs) to onboard to the Azure Monitor OpenTelemetry Distro.
4646

47-
### Changes and limitations of the Azure Monitor OpenTelemetry Distro
47+
#### Changes and limitations of the Azure Monitor OpenTelemetry Distro
4848

4949
The APIs from the Application Insights 2.X SDK aren't available in the Azure Monitor OpenTelemetry Distro. You can access these APIs through a nonbreaking upgrade path in the Application Insights 3.X SDK.
5050
5151
## [Upgrade](#tab/upgrade)
5252
5353
1. Upgrade the `applicationinsights` package dependency.
5454
55-
```shell
56-
npm update applicationinsights
57-
```
55+
```shell
56+
npm update applicationinsights
57+
```
5858
59-
1. Rebuild your application.
59+
2. Rebuild your application.
6060
61-
1. Test your application.
61+
3. Test your application.
6262
63-
To avoid using unsupported configuration options in the Application Insights 3.X SDK, see [Unsupported Properties](https://github.com/microsoft/ApplicationInsights-node.js/tree/beta?tab=readme-ov-file#applicationinsights-shim-unsupported-properties).
63+
To avoid using unsupported configuration options in the Application Insights 3.X SDK, see [Unsupported Properties](https://github.com/microsoft/ApplicationInsights-node.js/tree/beta?tab=readme-ov-file#applicationinsights-shim-unsupported-properties).
6464
65-
If the SDK logs warnings about unsupported API usage after a major version bump, and you need the related functionality, continue using the Application Insights 2.X SDK.
65+
If the SDK logs warnings about unsupported API usage after a major version bump, and you need the related functionality, continue using the Application Insights 2.X SDK.
6666
6767
---
6868
69-
## Changes and limitations
69+
#### Changes and limitations
7070
7171
The following changes and limitations apply to both upgrade paths.
7272
73-
* Node < 14 support
73+
##### Node < 14 support
7474
7575
OpenTelemetry JavaScript's monitoring solutions officially support only Node version 14+. Check the [OpenTelemetry supported runtimes](https://github.com/open-telemetry/opentelemetry-js#supported-runtimes) for the latest updates. Users on older versions like Node 8, previously supported by the ApplicationInsights SDK, can still use OpenTelemetry solutions but can experience unexpected or breaking behavior.
7676

77-
* Configuration options
77+
##### Configuration options
7878

7979
The ApplicationInsights SDK version 2.X offers configuration options that aren't available in the Azure Monitor OpenTelemetry Distro or in the major version upgrade to Application Insights 3.X SDK. To find these changes, along with the options we still support, see [SDK configuration documentation](https://github.com/microsoft/ApplicationInsights-node.js/tree/beta?tab=readme-ov-file#applicationinsights-shim-unsupported-properties).
8080
81-
* Extended metrics
81+
##### Extended metrics
8282
8383
Extended metrics are supported in the Application Insights 2.X SDK; however, support for these metrics ends in both version 3.X of the ApplicationInsights SDK and the Azure Monitor OpenTelemetry Distro.
8484
85-
* Telemetry Processors
85+
##### Telemetry Processors
8686
8787
While the Azure Monitor OpenTelemetry Distro and Application Insights 3.X SDK don't support TelemetryProcessors, they do allow you to pass span and log record processors. For more information on how, see [Azure Monitor OpenTelemetry Distro project](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/monitor/monitor-opentelemetry#modify-telemetry).
8888

@@ -105,7 +105,6 @@ function addCustomProperty(envelope: EnvelopeTelemetry) {
105105
106106
This example shows how to modify an Azure Monitor OpenTelemetry Distro implementation to pass a SpanProcessor to the configuration of the distro.
107107
108-
109108
```typescript
110109
import { Context, Span} from "@opentelemetry/api";
111110
import { ReadableSpan, SpanProcessor } from "@opentelemetry/sdk-trace-base";

0 commit comments

Comments
 (0)