Implement the generic matching API

Oct 13, 2025 by wbrum.org 12 views

Introduction

The Redis Proxy filter is a powerful tool in the Envoy Proxy ecosystem, allowing developers to integrate Redis into their service mesh. However, the current implementation of the Redis Proxy filter only supports prefix matches, which can be limiting in certain scenarios. To extend the capabilities of the Redis Proxy filter, we propose adding support for the generic matching API, which would enable the use of features such as the consistent hashing matcher.

Background

The Envoy Proxy is a high-performance service proxy that provides a flexible and scalable way to manage network traffic. The Redis Proxy filter is a key component of the Envoy Proxy, allowing developers to integrate Redis into their service mesh. However, the current implementation of the Redis Proxy filter only supports prefix matches, which can be limiting in certain scenarios.

Prefix matches are a simple and effective way to match Redis keys, but they can be inflexible and may not meet the needs of all use cases. For example, in a scenario where you need to match Redis keys based on a combination of factors, such as a prefix and a specific value, prefix matches may not be sufficient.

Generic Matching API

The generic matching API is a powerful tool that allows developers to create custom matchers that can be used to match Redis keys based on a wide range of criteria. The generic matching API provides a flexible and extensible way to match Redis keys, making it an ideal solution for scenarios where prefix matches are not sufficient.

The generic matching API is based on a typed extension that exposes the cache key. This allows developers to create custom matchers that can be used to match Redis keys based on a wide range of criteria, such as prefixes, values, and even complex logic.

Consistent Hashing Matcher

One of the key features of the generic matching API is the consistent hashing matcher. The consistent hashing matcher is a powerful tool that allows developers to match Redis keys based on a consistent hash of the key.

Consistent hashing is a technique that maps a key to a hash value, and then uses that hash value to determine the location of the key in a distributed system. The consistent hashing matcher uses this technique to match Redis keys based on a consistent hash of the key.

The consistent hashing matcher is particularly useful in scenarios where you need to match Redis keys based on a combination of factors, such as a prefix and a specific value. By using the consistent hashing matcher, you can create a custom matcher that can match Redis keys based on a wide range of criteria.

Implementation

To implement the xDS matcher support for the Redis Proxy filter, we propose the following steps:

Add a new typed extension: We propose adding a new typed extension to expose the cache key. This will allow developers to create custom matchers that can be used to match Redis keys based on a wide range of criteria.
Implement the generic matching API: We propose implementing the generic matching API, which will provide a flexible and extensible way to match Redis keys.
Implement the consistent hashing matcher: We propose implementing the consistent hashing matcher, which will allow developers to match Redis keys based on a consistent hash of the key.
Integrate the xDS matcher support: We propose integrating the xDS matcher support into the Redis Proxy filter, which will allow developers to use the generic matching API and the consistent hashing matcher to match Redis keys.

Benefits

The xDS matcher support for the Redis Proxy filter will provide several benefits, including:

Improved flexibility: The xDS matcher support will provide a flexible and extensible way to match Redis keys, making it easier to meet the needs of a wide range of use cases.
Increased scalability: The xDS matcher support will allow developers to match Redis keys based on a wide range of criteria, making it easier to scale Redis-based applications.
Improved performance: The xDS matcher support will provide a fast and efficient way to match Redis keys, making it easier to meet the performance requirements of high-traffic applications.

Conclusion

The xDS matcher support for the Redis Proxy filter is a powerful tool that will provide a flexible and extensible way to match Redis keys. By adding support for the generic matching API and the consistent hashing matcher, developers will be able to create custom matchers that can be used to match Redis keys based on a wide range of criteria. We believe that the xDS matcher support for the Redis Proxy filter will be a valuable addition to the Envoy Proxy ecosystem, and we look forward to seeing the benefits it will bring to developers and users alike.

Future Work

There are several areas where we can improve the xDS matcher support for the Redis Proxy filter, including:

Adding support for additional matchers: We propose adding support for additional matchers, such as the regex matcher and the range matcher.
Improving the performance of the xDS matcher support: We propose improving the performance of the xDS matcher support by optimizing the code and using more efficient algorithms.
Providing better documentation and support: We propose providing better documentation and support for the xDS matcher support, including tutorials, examples, and a community forum.

Relevant Links

Generic matching api
Consistent hashing matcher
xDS Matcher Support for the Redis Proxy Filter: Q&A =====================================================

Introduction

The xDS matcher support for the Redis Proxy filter is a powerful tool that provides a flexible and extensible way to match Redis keys. However, we understand that there may be some questions and concerns about how to use this feature. In this article, we will answer some of the most frequently asked questions about the xDS matcher support for the Redis Proxy filter.

Q: What is the xDS matcher support for the Redis Proxy filter?

A: The xDS matcher support for the Redis Proxy filter is a feature that allows developers to match Redis keys based on a wide range of criteria, including prefixes, values, and even complex logic. This feature is based on the generic matching API, which provides a flexible and extensible way to match Redis keys.

Q: What are the benefits of using the xDS matcher support for the Redis Proxy filter?

A: The xDS matcher support for the Redis Proxy filter provides several benefits, including improved flexibility, increased scalability, and improved performance. This feature allows developers to create custom matchers that can be used to match Redis keys based on a wide range of criteria, making it easier to meet the needs of a wide range of use cases.

Q: How do I use the xDS matcher support for the Redis Proxy filter?

A: To use the xDS matcher support for the Redis Proxy filter, you will need to add a new typed extension to expose the cache key. This will allow you to create custom matchers that can be used to match Redis keys based on a wide range of criteria. You can then use the generic matching API to create custom matchers that can be used to match Redis keys.

Q: What are some examples of how I can use the xDS matcher support for the Redis Proxy filter?

A: Here are a few examples of how you can use the xDS matcher support for the Redis Proxy filter:

Matching Redis keys based on a prefix: You can use the xDS matcher support to match Redis keys based on a prefix. For example, you can create a custom matcher that matches all Redis keys that start with the prefix "user:".
Matching Redis keys based on a value: You can use the xDS matcher support to match Redis keys based on a value. For example, you can create a custom matcher that matches all Redis keys that have a value of "active".
Matching Redis keys based on complex logic: You can use the xDS matcher support to match Redis keys based on complex logic. For example, you can create a custom matcher that matches all Redis keys that have a value of "active" and a prefix of "user:".

Q: How do I troubleshoot issues with the xDS matcher support for the Redis Proxy filter?

A: If you are experiencing issues with the xDS matcher support for the Redis Proxy filter, there are several steps you can take to troubleshoot the problem:

Check the logs: Check the logs to see if there are any error messages that may indicate the cause of the problem.
Check the configuration: Check the configuration to ensure that it is correct and that the xDS matcher support is properly configured.
Test the feature: Test the feature to ensure that it is working correctly.

Q: What are some common issues that I may encounter when using the xDS matcher support for the Redis Proxy filter?

A: Here are a few common issues that you may encounter when using the xDS matcher support for the Redis Proxy filter:

Incorrect configuration: If the configuration is incorrect, the xDS matcher support may not work correctly.
Incorrect usage: If the xDS matcher support is not used correctly, it may not work as expected.
Performance issues: If the xDS matcher support is not optimized, it may cause performance issues.

Q: How do I get support for the xDS matcher support for the Redis Proxy filter?

A: If you need support for the xDS matcher support for the Redis Proxy filter, there are several resources available to you:

Documentation: The documentation provides detailed information about how to use the xDS matcher support.
Community forum: The community forum is a great place to ask questions and get help from other developers who are using the xDS matcher support.
Support team: The support team is available to provide technical support and answer any questions you may have.

Conclusion

The xDS matcher support for the Redis Proxy filter is a powerful tool that provides a flexible and extensible way to match Redis keys. By understanding how to use this feature, you can create custom matchers that can be used to match Redis keys based on a wide range of criteria. We hope that this Q&A article has been helpful in answering some of the most frequently asked questions about the xDS matcher support for the Redis Proxy filter.