How to give connection a name? #2884

Use the top-level name option when creating the client:

import { createClient } from 'redis'

const client = createClient({
  url: process.env.REDIS_URL,
  name: `api:${process.env.HOSTNAME ?? 'local'}`,
})

client.on('error', console.error)
await client.connect()

Node Redis sends that value through HELLO ... SETNAME (RESP3) or CLIENT SETNAME during connection setup, so it appears in the name column of CLIENT LIST.

If the client is already connected, the equivalent command is:

await client.clientSetName('api:worker-1')

A couple of operational details:

• the name belongs to one physical Redis connection, so subscriber, pool, or separately created clients need their own names;
• use a stable, low-cardinality value such as service:role:instance, not a request or user ID;
• naming helps identify excess connections but does not reduce them. Make sure the client is created once per process rather than once per request, and close it during graceful shutdown.

The current client configuration reference lists name specifically for this purpose: https://github.com/redis/node-redis/blob/master/docs/client-configuration.md