[GitHub] gianm closed pull request #6109: update redis-cache documentation

[GitBox <gi...@apache.org>]

gianm closed pull request #6109: update redis-cache documentation
URL: https://github.com/apache/incubator-druid/pull/6109
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/content/development/extensions-contrib/redis-cache.md b/docs/content/development/extensions-contrib/redis-cache.md
index cd16925aa8c..b38d7cb7cb8 100644
--- a/docs/content/development/extensions-contrib/redis-cache.md
+++ b/docs/content/development/extensions-contrib/redis-cache.md
@@ -8,9 +8,14 @@ Druid Redis Cache
 A cache implementation for Druid based on [Redis](https://github.com/antirez/redis).
 
 # Configuration
-Below are the configuration options known to this module:
+Below are the configuration options known to this module.
 
-|`runtime.properties`|Description|Default|Required|
+Note that just adding these properties does not enable the cache. You still need to add the `druid.<nodetype>.cache.useCache` and `druid.<nodetype>.cache.populateCache` properties for the nodes you want to enable the cache on as described in the [cache configuration docs](../../configuration/caching.html).
+
+A possible configuration would be to keep the properties below in your `common.runtime.properties` file (present on all nodes) and then add `druid.<nodetype>.cache.useCache` and `druid.<nodetype>.cache.populateCache` in the `runtime.properties` file of the node types you want to enable caching on.
+
+
+|`common.runtime.properties`|Description|Default|Required|
 |--------------------|-----------|-------|--------|
 |`druid.cache.host`|Redis server host|None|yes|
 |`druid.cache.port`|Redis server port|None|yes|
@@ -29,4 +34,4 @@ In addition to the normal cache metrics, the redis cache implementation also rep
 
 |Metric|Description|Normal value|
 |------|-----------|------------|
-|`query/cache/redis/*/requests`|Count of requests to redis cache|whatever request to redis will increase request count by 1|
\ No newline at end of file
+|`query/cache/redis/*/requests`|Count of requests to redis cache|whatever request to redis will increase request count by 1|


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org