[PavelPashov]

Description

This pull request adds custom attributes to node-redis OpenTelemetry metrics, so users can label metrics with their own values, such as the service, team or environment. Users who run several clients in one process can also tell those clients apart in dashboards. Before this, the only per-client attribute was a random pool name, and command metrics didn't carry it.

Attributes can be set at two levels:

• Process: customAttributes in OpenTelemetry.init({ metrics }). Applies to every metric from every client in the process.
• Client: metrics: { customAttributes } in the client options. Applies to every metric that client emits. Pools pass it through their client options, clusters through defaults, and sentinels through nodeClientOptions and sentinelClientOptions, the same way other per-client options work.

OpenTelemetry.init({ metrics: { enabled: true, customAttributes: { env: 'production' } } });

const orders = createClient({ metrics: { customAttributes: { app: 'orders' } } });
const billing = createCluster({
  rootNodes,
  defaults: { metrics: { customAttributes: { app: 'billing' } } },
});

When a key is set more than once, the most specific value wins: client attributes, then process attributes, then the attributes node-redis sets. Two clients in one process never share or mix attributes.

---

Checklist

• Does npm test pass with this change (including linting)?
• Is the new or changed code fully tested?
• Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?

---

Note

Medium Risk
Changes affect all metric data point labels; misconfigured high-cardinality custom attributes or overriding built-in keys like server.address can inflate time series cost and alter grouping, though behavior is additive and well-tested.

Overview
Adds custom attributes on OpenTelemetry metrics so dashboards can label series by environment, service, team, or individual Redis clients in the same process.

Configuration is two-tier: customAttributes in OpenTelemetry.init({ metrics }) applies process-wide, and metrics.customAttributes on client options (including cluster defaults / sentinel node options) applies per client and wins on key conflicts over process-level values. Built-in node-redis attributes are merged first and can be replaced if the same key is used in customAttributes.

Implementation threads client options through the metrics registry handle and merges labels via withCustomAttributes on every instrument path (commands, connections, errors, pub/sub, streams, CSC, gauges). Docs, the otel-metrics example, and unit/E2E tests cover precedence, built-in overrides, and isolation between multiple clients/clusters.

^{Reviewed by Cursor Bugbot for commit c16e7b0. Bugbot is set up for automated code reviews on this repo. Configure here.}

[chatgpt-codex-connector]

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-11-03T16:26:55.178865Z	c16e7b0	New commits

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

[chatgpt-codex-connector]

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f4c4bdc61c

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

[cursor]

Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.

^{Reviewed by Cursor Bugbot for commit f4c4bdc. Configure here.}