Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/release-notes/breaking-changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,38 +15,45 @@ products:

Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elastic Distribution of OpenTelemetry breaking changes and take the necessary steps to mitigate any issues.

% ## Next version [edot-X.X.X-breaking-changes]
% ## Next version [edot-node-X.X.X-breaking-changes]

% Use the following template to add entries to this document.

% TEMPLATE START
% $$$kibana-PR_NUMBER$$$
% ::::{dropdown} Title of breaking change
% ::::{dropdown} Title of breaking change
% Description of the breaking change.
% **Impact**<br> Impact of the breaking change.
% **Action**<br> Steps for mitigating impact.
% Refer to [PR #](PR link).
% ::::
% TEMPLATE END

% 1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section.
% 2. Edit the anchor ID ($$$kibana-PR_NUMBER$$$) of the template with the correct PR number to give the entry a unique URL.
% 1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section.
% 2. Edit the anchor ID ($$$kibana-PR_NUMBER$$$) of the template with the correct PR number to give the entry a unique URL.
% 3. Don't hardcode the link to the new entry. Instead, make it available through the doc link service files:
% - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
% - {kib-repo}blob/{branch}/src/platform/packages/shared/kbn-doc-links/src/types.ts
%
%
% The entry in the main links file should look like this:
%
%
% id: `${KIBANA_DOCS}breaking-changes.html#kibana-PR_NUMBER`
%
%
% 4. You can then call the link from any Kibana code. For example: `href: docLinks.links.upgradeAssistant.id`
% Check https://docs.elastic.dev/docs/kibana-doc-links (internal) for more details about the Doc links service.

## Next [edot-node-next-breaking-changes]

::::{dropdown} Change usage of "redis-4" to "redis" in `OTEL_NODE_ENABLED_INSTRUMENTATIONS` and `OTEL_NODE_DISABLED_INSTRUMENTATIONS`

Support for instrumenting `redis` version 4 has moved from `@opentelemetry/instrumentation-redis-4` to `@opentelemetry/instrumentation-redis`. If you are using the `OTEL_NODE_ENABLED_INSTRUMENTATIONS` or `OTEL_NODE_DISABLED_INSTRUMENTATIONS` environment variables to control instrumentation of `redis@4` you will need to change from using "redis-4" to "redis".
::::

## 1.1.0

::::{dropdown} AWS SDK v2 instrumentation has been dropped

Refer to the [opentelemetry-instrumentation-aws-sdk release notes](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-aws-sdk/CHANGELOG.md#0510-2025-04-08). The `aws.region` span attribute has been changed to `cloud.region`.
Refer to the [opentelemetry-instrumentation-aws-sdk release notes](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-aws-sdk/CHANGELOG.md#0510-2025-04-08). The `aws.region` span attribute has been changed to `cloud.region`.

Refer to [Issue #814](https://github.com/elastic/elastic-otel-node/pull/814) and [Issue #788](https://github.com/elastic/elastic-otel-node/pull/788).
::::
Expand Down
4 changes: 4 additions & 0 deletions docs/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ To check for security updates, go to [Security announcements for the Elastic sta

### Fixes [edot-node-next-fixes]

### Chores [edot-node-next-chores]

- Support for instrumenting `redis` version 4 has moved from `@opentelemetry/instrumentation-redis-4` to `@opentelemetry/instrumentation-redis`. If you are using the `OTEL_NODE_ENABLED_INSTRUMENTATIONS` or `OTEL_NODE_DISABLED_INSTRUMENTATIONS` environment variables to control instrumentation of `redis@4` you will need to change from using "redis-4" to "redis".

## 1.1.1 [edot-node-1.1.1-release-notes]

### Fixes [edot-node-1.1.1-fixes]
Expand Down
3 changes: 0 additions & 3 deletions packages/opentelemetry-node/lib/instrumentations.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ const {log} = require('./logging');
* "@opentelemetry/instrumentation-pg": import('@opentelemetry/instrumentation-pg').PgInstrumentationConfig
* "@opentelemetry/instrumentation-pino": import('@opentelemetry/instrumentation-pino').PinoInstrumentationConfig
* "@opentelemetry/instrumentation-redis": import('@opentelemetry/instrumentation-redis').RedisInstrumentationConfig,
* "@opentelemetry/instrumentation-redis-4": import('@opentelemetry/instrumentation-redis-4').RedisInstrumentationConfig,
* "@opentelemetry/instrumentation-restify": import('@opentelemetry/instrumentation-restify').RestifyInstrumentationConfig,
* "@opentelemetry/instrumentation-router": import('@opentelemetry/instrumentation').InstrumentationConfig,
* "@opentelemetry/instrumentation-runtime-node": import('@opentelemetry/instrumentation-runtime-node').RuntimeNodeInstrumentationConfig,
Expand Down Expand Up @@ -89,7 +88,6 @@ const {NetInstrumentation} = require('@opentelemetry/instrumentation-net');
const {PgInstrumentation} = require('@opentelemetry/instrumentation-pg');
const {PinoInstrumentation} = require('@opentelemetry/instrumentation-pino');
const {RedisInstrumentation} = require('@opentelemetry/instrumentation-redis');
const {RedisInstrumentation: RedisFourInstrumentation} = require('@opentelemetry/instrumentation-redis-4');
const {RestifyInstrumentation} = require('@opentelemetry/instrumentation-restify');
const {RouterInstrumentation} = require('@opentelemetry/instrumentation-router');
const {RuntimeNodeInstrumentation} = require('@opentelemetry/instrumentation-runtime-node');
Expand Down Expand Up @@ -139,7 +137,6 @@ const instrumentationsMap = {
'@opentelemetry/instrumentation-pg': (cfg) => new PgInstrumentation(cfg),
'@opentelemetry/instrumentation-pino': (cfg) => new PinoInstrumentation(cfg),
'@opentelemetry/instrumentation-redis': (cfg) => new RedisInstrumentation(cfg),
'@opentelemetry/instrumentation-redis-4': (cfg) => new RedisFourInstrumentation(cfg),
'@opentelemetry/instrumentation-restify': (cfg) => new RestifyInstrumentation(cfg),
'@opentelemetry/instrumentation-router': (cfg) => new RouterInstrumentation(cfg),
'@opentelemetry/instrumentation-runtime-node': (cfg) => new RuntimeNodeInstrumentation(cfg),
Expand Down
90 changes: 0 additions & 90 deletions packages/opentelemetry-node/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion packages/opentelemetry-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,6 @@
"@opentelemetry/instrumentation-pg": "^0.55.0",
"@opentelemetry/instrumentation-pino": "^0.50.0",
"@opentelemetry/instrumentation-redis": "^0.51.0",
"@opentelemetry/instrumentation-redis-4": "^0.49.0",
"@opentelemetry/instrumentation-restify": "^0.49.0",
"@opentelemetry/instrumentation-router": "^0.48.0",
"@opentelemetry/instrumentation-runtime-node": "^0.17.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ const {filterOutDnsNetSpans, runTestFixtures} = require('./testutils');
const skip = process.env.REDIS_HOST === undefined;
if (skip) {
console.log(
'# SKIP redis-4 tests: REDIS_HOST is not set (try with `REDIS_HOST=localhost`)'
'# SKIP redis tests: REDIS_HOST is not set (try with `REDIS_HOST=localhost`)'
);
}

Expand Down Expand Up @@ -38,7 +38,7 @@ const testFixtures = [
t.equal(s.traceId, spans[0].traceId, 'traceId');
t.equal(s.parentSpanId, spans[0].spanId, 'parentSpanId');
t.equal(s.kind, 'SPAN_KIND_CLIENT', 'kind');
t.equal(s.scope.name, '@opentelemetry/instrumentation-redis-4');
t.equal(s.scope.name, '@opentelemetry/instrumentation-redis');
t.equal(s.attributes['db.system'], 'redis');
});
t.equal(spans[1].name, 'redis-connect');
Expand Down Expand Up @@ -72,7 +72,7 @@ const testFixtures = [
},
];

test('redis-4 instrumentation', {skip}, (suite) => {
test('redis instrumentation', {skip}, (suite) => {
runTestFixtures(suite, testFixtures);
suite.end();
});
1 change: 0 additions & 1 deletion packages/opentelemetry-node/types/instrumentations.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ export type InstrumentaionsMap = {
"@opentelemetry/instrumentation-pg": import('@opentelemetry/instrumentation-pg').PgInstrumentationConfig;
"@opentelemetry/instrumentation-pino": import('@opentelemetry/instrumentation-pino').PinoInstrumentationConfig;
"@opentelemetry/instrumentation-redis": import('@opentelemetry/instrumentation-redis').RedisInstrumentationConfig;
"@opentelemetry/instrumentation-redis-4": import('@opentelemetry/instrumentation-redis-4').RedisInstrumentationConfig;
"@opentelemetry/instrumentation-restify": import('@opentelemetry/instrumentation-restify').RestifyInstrumentationConfig;
"@opentelemetry/instrumentation-router": import('@opentelemetry/instrumentation').InstrumentationConfig;
"@opentelemetry/instrumentation-runtime-node": import('@opentelemetry/instrumentation-runtime-node').RuntimeNodeInstrumentationConfig;
Expand Down
Loading