Skip to content

Commit 7b23144

Browse files
authored
Update EDOT Node.js docs for swap of OpenAI instrumentation to the upstreamed package (#450)
Elastic built instrumentation for openai and included it in EDOT Node.js. Fairly recently that instrumentation was upstreamed to the OpenTelemetry project and released under their namespace. EDOT Node.js 1.4.0 will swap over to the upstreamed package name. Refs: elastic/elastic-otel-node#1015
1 parent 1287f73 commit 7b23144

File tree

3 files changed

+3
-4
lines changed

3 files changed

+3
-4
lines changed

docs/reference/edot-sdks/nodejs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Refer to the [migration guide](/reference/edot-sdks/nodejs/migration.md#contextp
250250
### `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` details [otel_instrumentation_genai_capture_message_content-details]
251251

252252
Set `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` to `true` to
253-
enable capture of content data, such as prompt and completion content, in GenAI telemetry. Currently this applies to the [`@elastic/opentelemetry-instrumentation-openai` instrumentation for the OpenAI Node.js client](https://github.com/elastic/elastic-otel-node/tree/main/packages/instrumentation-openai/#configuration) that is included in EDOT Node.js
253+
enable capture of content data, such as prompt and completion content, in GenAI telemetry. Currently this applies to the `@opentelemetry/instrumentation-openai` instrumentation.
254254

255255
The `OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT` boolean environment variable is a convention established by the OpenTelemetry GenAI SIG. It is referenced in <https://opentelemetry.io/blog/2024/otel-generative-ai/>.
256256

docs/reference/edot-sdks/nodejs/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ A goal of this distribution is to avoid introducing proprietary concepts in addi
2727
In addition to all the features of OpenTelemetry Node.js, with EDOT Node.js you have access to the following:
2828

2929
* A single package that includes several OpenTelemetry packages as dependencies, so you only need to install and update a single package (for most use cases). This is similar to OpenTelemetry's `@opentelemetry/auto-instrumentations-node` package.
30-
* The [`@elastic/opentelemetry-instrumentation-openai`](https://github.com/elastic/elastic-otel-node/tree/main/packages/instrumentation-openai#readme) instrumentation for monitoring usage of the OpenAI Node.js client library.
3130
* Improvements and bug fixes contributed by the Elastic team before the changes are available in OpenTelemetry repositories.
3231
* Optional features that can enhance OpenTelemetry data that is being sent to Elastic.
3332
* Elastic-specific processors that ensure optimal compatibility when exporting OpenTelemetry signal data to an Elastic backend like an Elastic Observability deployment.

docs/reference/edot-sdks/nodejs/supported-technologies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ The 🔹 symbol marks instrumentations that differ between EDOT Node.js and OTel
4646

4747
| Name | Packages instrumented | Notes |
4848
|---|---|---|
49-
| `@elastic/opentelemetry-instrumentation-openai` 🔹 | `openai` version range `>=4.19.0 <5` | [README](https://github.com/elastic/elastic-otel-node/tree/main/packages/instrumentation-openai#readme) |
5049
| `@opentelemetry/instrumentation-amqplib` | `amqplib` version range `>=0.5.5 <1` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-amqplib#readme) |
5150
| `@opentelemetry/instrumentation-aws-sdk` | `aws-sdk` v2 and `@aws-sdk/client-*` v3 | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-aws-sdk#readme) |
5251
| `@opentelemetry/instrumentation-bunyan` | `bunyan` version range `^1.0.0` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-bunyan#readme) |
@@ -75,6 +74,7 @@ The 🔹 symbol marks instrumentations that differ between EDOT Node.js and OTel
7574
| `@opentelemetry/instrumentation-mysql2` | `mysql2` version range `>=1.4.2 <4` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/packages/instrumentation-mysql2#readme) |
7675
| `@opentelemetry/instrumentation-nestjs-core` | `@nestjs/core` version range `>=4.0.0` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-nestjs-core#readme) |
7776
| `@opentelemetry/instrumentation-net` | `net` module for supported Node.js versions | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-net#readme) |
77+
| `@opentelemetry/instrumentation-openai` {applies_to}`edot_node: ga 1.4.0` | `openai` version range `>=4.19.0 <6` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-openai#readme) |
7878
| `@opentelemetry/instrumentation-oracledb` {applies_to}`edot_node: ga 1.3.0` | `oracledb` version range `>=6.7.0 <7` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-oracledb#readme) |
7979
| `@opentelemetry/instrumentation-pg` | `pg` version range `>=8 <9` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-pg#readme) |
8080
| `@opentelemetry/instrumentation-pino` | `pino` version range `>=5.14.0 <10` | [README](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-pino#readme) |
@@ -93,7 +93,7 @@ EDOT Node.js can instrument the following Large Language Model (LLM) libraries w
9393

9494
| SDK | Instrumentation | Traces | Metrics | Logs | Notes |
9595
|--------|-----------------|--------|---------|------|-------|
96-
| OpenAI | [@elastic/opentelemetry-instrumentation-openai](https://github.com/elastic/elastic-otel-node/tree/main/packages/instrumentation-openai#readme) |||| (1) |
96+
| OpenAI | [@opentelemetry/instrumentation-openai](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-openai#readme) |||| (1) |
9797

9898
1. Support for [chat](https://platform.openai.com/docs/api-reference/chat) and [embeddings](https://platform.openai.com/docs/api-reference/embeddings) API endpoints.
9999

0 commit comments

Comments
 (0)