Skip to content

Add CLIENT SETNAME to Valkey document store for connection identification #3356

@atao2004

Description

@atao2004

Summary

The Valkey document store integration currently creates a SyncGlideClientConfiguration without setting a client_name. This means connections appear anonymous in monitoring tools like CLIENT LIST and Valkey Admin.

Suggested Fix

In integrations/valkey/src/haystack_integrations/document_stores/valkey/document_store.py (line ~232), add client_name to the configuration:

cfg = SyncGlideClientConfiguration(
    [NodeAddress(host, port)],
    client_name="haystack_vector_store_client",
)

Why This Matters

When monitoring a Valkey server with multiple connected applications, CLIENT LIST shows each connection's name. Without a client name, operators cannot distinguish Haystack connections from other anonymous clients. This is especially important in production environments with ElastiCache where multiple services share the same Valkey cluster.

Setting client_name sends a CLIENT SETNAME command on connection, making the connection identifiable in:

  • CLIENT LIST output
  • Monitoring dashboards (e.g., Valkey Admin)
  • CloudWatch metrics (ElastiCache)

Naming Convention

Suggested client name: haystack_vector_store_client

Pattern: {project}_{purpose}_client

  • haystack = project name
  • vector_store = purpose (document store with vector search)
  • _client = convention (matches Valkey Admin naming pattern)

Metadata

Metadata

Assignees

Labels

No fields configured for Feature.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions