Skip to content

docs: Python client identification options - #287

Open
Aryex wants to merge 1 commit into
mainfrom
alexl/agent/python-client-info-config
Open

docs: Python client identification options#287
Aryex wants to merge 1 commit into
mainfrom
alexl/agent/python-client-info-config

Conversation

@Aryex

@Aryex Aryex commented Jul 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

Document the new lib_name and client_info_tag configuration options added to the Python client for framework/library identification in CLIENT INFO output.

⚠️ Attention: This PR was generated automatically. Verify that all relevant pages have been updated.

Source Commits

  • 28e99a6 — feat(python): Add configurable lib_name and client_info_tag to client config (async + sync)

Changes

  • New how-to page: how-to/monitoring/client-identification.mdx — explains the use case, shows the behavior matrix, provides examples for async/sync Python clients, and notes "coming soon" for other languages
  • Updated reference page: reference/connection-options.mdx — added a "Client Identification Options" section with an availability table and example
  • Updated astro.config.mjs — added the new page to the Monitoring sidebar section

Context

Libraries and frameworks embedding GLIDE need to identify themselves to the Valkey server for adoption tracking, observability, and debugging. The new client_info_tag option preserves the GLIDE identity (GlidePy/GlidePySync) while appending a framework-specific tag, and lib_name allows a full override. This is currently Python-only; Node.js and other languages are planned as follow-ups.

Source PR: valkey-glide #6389

cc @omerrubi-amzn


This PR was generated by the automated documentation pipeline.

@Aryex Aryex added AI Generated documentation Improvements or additions to documentation python labels Jul 26, 2026
@Aryex
Aryex force-pushed the alexl/agent/python-client-info-config branch from e5855f5 to a27e842 Compare July 26, 2026 21:27
@Aryex
Aryex requested review from affonsov and jeremyprime July 27, 2026 14:44
…or Python

Signed-off-by: kiro-agent <kiro-agent@users.noreply.github.com>
@Aryex
Aryex force-pushed the alexl/agent/python-client-info-config branch from a27e842 to ce664f5 Compare July 27, 2026 14:45
@Aryex
Aryex marked this pull request as ready for review July 27, 2026 14:45
@Aryex Aryex assigned jeremyprime and Aryex and unassigned jeremyprime Jul 27, 2026
addresses=[NodeAddress("localhost", 6379)],
client_info_tag="my-framework:1.2.3",
)
client = GlideClient(config)

@jeremyprime jeremyprime Jul 27, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Should be client = GlideClient.create(config).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

So far client_info_tag has only been added to Python which is why this page focuses on Python (see valkey-io/valkey-glide#6429 for task to add to all clients). But this page could also go over current lib_name and client_name usage across all clients.

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

Labels

AI Generated documentation Improvements or additions to documentation python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants