Skip to content

Python: Add CLIENT SETNAME to Valkey/Redis connector for connection identification#14039

Open
kuriangeorgebinu wants to merge 3 commits into
microsoft:mainfrom
kuriangeorgebinu:issue-14038-redis-client-setname
Open

Python: Add CLIENT SETNAME to Valkey/Redis connector for connection identification#14039
kuriangeorgebinu wants to merge 3 commits into
microsoft:mainfrom
kuriangeorgebinu:issue-14038-redis-client-setname

Conversation

@kuriangeorgebinu
Copy link
Copy Markdown

…dentification

Fixes #14038
Summary:

  • Added client_name parameter to Redis.from_url() calls in RedisCollection class
  • Added client_name parameter to Redis.from_url() calls in RedisStore class
  • Client name set to 'semantic_kernel_vector_store_client' following the suggested naming pattern 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 Semantic Kernel 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)

Motivation and Context

Description

Contribution Checklist

…dentification

Fixes microsoft#14038
Summary:
- Added client_name parameter to Redis.from_url() calls in RedisCollection class
- Added client_name parameter to Redis.from_url() calls in RedisStore class
- Client name set to 'semantic_kernel_vector_store_client' following the suggested naming pattern
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 Semantic Kernel 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)
Copilot AI review requested due to automatic review settings May 27, 2026 02:44
@kuriangeorgebinu kuriangeorgebinu requested a review from a team as a code owner May 27, 2026 02:44
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@moonbox3 moonbox3 added the python Pull requests for the Python Semantic Kernel label May 27, 2026
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated Code Review

Reviewers: 4 | Confidence: 92%

✓ Correctness

This is a straightforward, correct change that adds client_name to the two Redis.from_url() calls where the library creates its own connection. The redis.asyncio.client.Redis.from_url() accepts **kwargs passed to the connection pool/constructor, and client_name is a standard redis-py parameter that issues CLIENT SETNAME on connect. When users provide their own redis_database instance, it is passed through unchanged (correct behavior). No correctness issues found.

✓ Security Reliability

This PR adds a static client_name parameter ('semantic_kernel_vector_store_client') to two Redis.from_url() calls for connection identification purposes. The change is minimal, uses a hardcoded constant string (no injection risk), and doesn't alter any connection logic or error handling. No security or reliability issues identified.

✓ Test Coverage

The PR adds client_name="semantic_kernel_vector_store_client" to two Redis.from_url() calls (in RedisCollection.__init__ and RedisStore.__init__), but includes no tests verifying the parameter is passed correctly. Existing unit tests in test_redis_store.py test initialization of both classes (e.g., test_vector_store_defaults, test_collection_init) and verify connection properties like host, but never assert client_name. Since the change is simple and unlikely to regress, this is a suggestion rather than a blocking issue.

✗ Design Approach

The change adds connection identification, but the current design hardcodes a single client name with no caller override. That is weaker than the existing configuration pattern used elsewhere in this repo for client/application identification, and it leaves all Semantic Kernel deployments reporting the same name instead of letting each service identify itself distinctly.

Flagged Issues

  • The new client_name is hardcoded with no way for callers to override it (RedisCollection.__init__ and RedisStore.__init__ expose no parameter). The Cosmos connector in the same repo already follows a better pattern: accepting application_name from the caller and threading it into the client constructor. Consider making client_name configurable with the current literal as the default.

Automated review by kuriangeorgebinu's agents

Addresses PR feedback on issue microsoft#14038
Changes:
- Added 'client_name' parameter to RedisCollection.__init__() with default
- Added 'client_name' parameter to RedisStore.__init__() with default
- Updated docstrings to document the new parameter
- Follows the same pattern as Cosmos connector's 'application_name' parameter
- Maintains backward compatibility with default value
This allows callers to override the client name for their specific use case
while providing a sensible default 'semantic_kernel_vector_store_client' for
cases where custom naming is not required.
@kuriangeorgebinu kuriangeorgebinu force-pushed the issue-14038-redis-client-setname branch from 3d32bbb to a0377ec Compare May 28, 2026 15:28
@microsoft-github-policy-service
Copy link
Copy Markdown

@kuriangeorgebinu please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Pull requests for the Python Semantic Kernel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python: Add CLIENT SETNAME to Valkey/Redis connector for connection identification

3 participants