Skip to content

Commit c22edf1

Browse files
authored
Merge pull request redis#110 from redis/uglide-lib-name-suffix
Document lib-name suffix format used by official clients
2 parents 7aa710b + fba8f62 commit c22edf1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

content/commands/client-setinfo/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,4 +54,10 @@ Currently the supported attributes are:
5454

5555
There is no limit to the length of these attributes. However it is not possible to use spaces, newlines, or other non-printable characters that would violate the format of the [`CLIENT LIST`]({{< relref "/commands/client-list" >}}) reply.
5656

57+
[Official client libraries](https://redis.io/docs/latest/develop/connect/clients/) allow extending `lib-name` with a custom suffix to expose additional information about the client.
58+
For example, high-level libraries like [redis-om-spring](https://github.com/redis/redis-om-spring) can report their version.
59+
The resulting `lib-name` would be `jedis(redis-om-spring_v1.0.0)`.
60+
Brace characters are used to delimit the custom suffix and should be avoided in the suffix itself.
61+
We recommend using the following format for the custom suffixes for third-party libraries `(?<custom-name>[ -~]+)[ -~]v(?<custom-version>[\d\.]+)` and use `;` to delimit multiple suffixes.
62+
5763
Note that these attributes are **not** cleared by the RESET command.

0 commit comments

Comments
 (0)