-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into version-gauge
Signed-off-by: Jose Nino <[email protected]>
- Loading branch information
Showing
69 changed files
with
1,278 additions
and
314 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,4 +14,5 @@ filters. | |
echo_filter | ||
mongo_proxy_filter | ||
rate_limit_filter | ||
redis_proxy_filter | ||
tcp_proxy_filter |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
.. _config_network_filters_redis_proxy: | ||
|
||
Redis proxy | ||
=========== | ||
|
||
Redis :ref:`architecture overview <arch_overview_redis>`. | ||
|
||
.. code-block:: json | ||
{ | ||
"name": "redis_proxy", | ||
"config": { | ||
"cluster_name": "...", | ||
"conn_pool": "{...}", | ||
"stat_prefix": "..." | ||
} | ||
} | ||
cluster_name | ||
*(required, string)* Name of cluster from cluster manager. | ||
See the :ref:`configuration section <arch_overview_redis_configuration>` of the architecture | ||
overview for recommendations on configuring the backing cluster. | ||
|
||
conn_pool | ||
*(required, object)* Connection pool configuration. | ||
|
||
stat_prefix | ||
*(required, string)* The prefix to use when emitting :ref:`statistics | ||
<config_network_filters_redis_proxy_stats>`. | ||
|
||
Connection pool configuration | ||
----------------------------- | ||
|
||
.. code-block:: json | ||
{ | ||
"op_timeout_ms": "...", | ||
} | ||
op_timeout_ms | ||
*(required, integer)* Per-operation timeout in milliseconds. The timer starts when the first | ||
command of a pipeline is written to the backend connection. Each response received from Redis | ||
resets the timer since it signifies that the next command is being processed by the backend. | ||
The only exception to this behavior is when a connection to a backend is not yet established. In | ||
that case, the connect timeout on the cluster will govern the timeout until the connection is | ||
ready. | ||
|
||
.. _config_network_filters_redis_proxy_stats: | ||
|
||
Statistics | ||
---------- | ||
|
||
Every configured Redis proxy filter has statistics rooted at *redis.<stat_prefix>.* with the | ||
following statistics: | ||
|
||
.. csv-table:: | ||
:header: Name, Type, Description | ||
:widths: 1, 1, 2 | ||
|
||
downstream_cx_active, Gauge, Total active connections | ||
downstream_cx_protocol_error, Counter, Total protocol errors | ||
downstream_cx_rx_bytes_buffered, Gauge, Total received bytes currently buffered | ||
downstream_cx_rx_bytes_total, Counter, Total bytes received | ||
downstream_cx_total, Counter, Total connections | ||
downstream_cx_tx_bytes_buffered, Gauge, Total sent bytes currently buffered | ||
downstream_cx_tx_bytes_total, Counter, Total bytes sent | ||
downstream_rq_active, Gauge, Total active requests | ||
downstream_rq_total, Counter, Total requests | ||
|
||
|
||
Splitter statistics | ||
------------------- | ||
|
||
The Redis filter will gather statistics for the command splitter in the | ||
*redis.<stat_prefix>.splitter.* with the following statistics: | ||
|
||
.. csv-table:: | ||
:header: Name, Type, Description | ||
:widths: 1, 1, 2 | ||
|
||
invalid_request, Counter, "Number of requests with an incorrect number of arguments" | ||
unsupported_command, Counter, "Number of commands issued which are not recognized by the | ||
command splitter" | ||
|
||
Per command statistics | ||
---------------------- | ||
|
||
The Redis filter will gather statistics for commands in the | ||
*redis.<stat_prefix>.command.<command>.* namespace. | ||
|
||
.. csv-table:: | ||
:header: Name, Type, Description | ||
:widths: 1, 1, 2 | ||
|
||
total, Counter, Number of commands | ||
|
||
.. _config_network_filters_redis_proxy_per_command_stats: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,6 +28,7 @@ Architecture overview | |
tcp_proxy | ||
mongo | ||
dynamo | ||
redis | ||
hot_restart | ||
dynamic_configuration | ||
init |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.