Skip to content

Commit

Permalink
Fixed documentation and some configs
Browse files Browse the repository at this point in the history
  • Loading branch information
smadappa committed Jul 23, 2017
1 parent 2ff1fce commit 9355948
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 29 deletions.
41 changes: 26 additions & 15 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,10 @@ The below properties can be set as a Persisted Property or in the property file
## Client Configuration

Property Name | Override Property Name | Default Value | Dynamic |
:----------- |:-------------:| -----------|-----------:
:----------- |:-------------|:-----------|:-----------
evcache.appsToInit| | | no
evcache.use.simple.node.list.provider| | false | no
EVCacheClientPoolManager.<CACHE\>.alias| | | yes
<CACHE\>.EVCacheClientPool.poolSize| | 1 | yes
<CACHE\>.EVCacheClientPool.refresh.connection.on.readQueueFull| EVCacheClientPool.refresh.connection.on.readQueueFull | false | yes
<CACHE\>.EVCacheClientPool.refresh.connection.on.readQueueFull.size| EVCacheClientPool.refresh.connection.on.readQueueFull.size | 100 | yes
Expand All @@ -24,18 +26,16 @@ evcache.appsToInit| | | no
<CACHE\>.clone.writes.to| | | yes
<CACHE\>.ping.servers| evcache.ping.servers | false | yes
<CACHE\>.<asg\>.EVCacheClientPool.writeOnly| <CACHE\>.<zone\>.EVCacheClientPool.writeOnly| | yes
EVCacheClientPoolManager.<CACHE\>.alias| | | no
evcache.use.simple.node.list.provider| | false | yes
<asg\>.chunk.data | <CACHE\>.chunk.data | false | no
<asg\>.chunk.size | <CACHE\>.chunk.size | 1180 | no
<CACHE\>.<asg\>.write.block.duration | <CACHE\>.write.block.duration | 25 | yes
<CACHE\>.<asg\>.ignore.touch | <CACHE\>.ignore.touch | false | yes
<CACHE\>.<asg\>.bucket.size | <CACHE\>.bucket.size | 160 | yes
EVCacheNodeLocator.<CACHE\>.<asg\>.hash.on.partial.key | EVCacheNodeLocator.<CACHE\>.hash.on.partial.key | false | yes
EVCacheNodeLocator.<CACHE\>.<asg\>.hash.delimiter | EVCacheNodeLocator.<CACHE\>.hash.delimiter | : | yes
EVCacheScheduledExecutor.<CACHE\>.max.size | | (set to processor count) | yes
EVCacheScheduledExecutor.<CACHE\>.core.size | | 1 | yes
evache.mutate.timeout | | <CACHE\>.operation.timeout | yes
<CACHE\>.<asg\>.hash.on.partial.key | <CACHE\>.hash.on.partial.key | false | yes
<CACHE\>.<asg\>.hash.delimiter | <CACHE\>.hash.delimiter | : | yes
<CACHE\>.executor.max.size | | (set to processor count) | yes
<CACHE\>.executor.core.size | | 1 | yes
<CACHE\>.mutate.timeout | | <CACHE\>.operation.timeout | yes
<asg\>.failure.mode | <CACHE\>.failure.mode | Retry | yes
evcache.thread.daemon | | false | no
<CACHE\>.<prefix\>.throw.exception | <CACHE\>.throw.exception | false | yes
Expand All @@ -52,7 +52,7 @@ evcache.request.expiry.optout | | true | yes
## Read & Write Operations

Property Name | Override Property Name | Default Value | Dynamic |
:----------- |:-------------:| -----------|-----------:
:----------- |:-------------|:-----------|:-----------
<CACHE\>.EVCacheClientPool.readTimeout|default.read.timeout| 20 | yes
<CACHE\>.EVCacheClientPool.bulkReadTimeout|| <CACHE\>.EVCacheClientPool.readTimeout | yes
<CACHE\>.operation.timeout| | 2500 | yes
Expand All @@ -65,7 +65,7 @@ Property Name | Override Property Name | Default Value | Dynamic |

## Cross Region Replication
Property Name | Override Property Name | Default Value | Dynamic |
:----------- |:-------------:| -----------|-----------:
:----------- |:-------------|:-----------|:-----------
EVCacheReplicationManager.use.schlep | | false | yes
<CACHE\>.region.replication | | false | yes
<CACHE\>.use.kafka | | true | yes
Expand Down Expand Up @@ -94,7 +94,7 @@ EVCacheReplicationManager.<cache\>.partitioner.class | EVCacheReplicationManager

## Fixing Write Failues
Property Name | Override Property Name | Default Value | Dynamic |
:----------- |:-------------:| -----------|-----------:
:----------- |:-------------|:-----------|:-----------
<CACHE\>.WriteFailure.to.kafka | WriteFailure.to.kafka | false | yes
WriteFailureListener.bootstrap.servers | | evcachereplvpc.kafka.us-east-1.dynprod.netflix.net:7101 | yes
WriteFailureListener.retries | | 1 | yes
Expand All @@ -106,7 +106,7 @@ WriteFailureListener.stickyPartitioner.intervalMs | 1000 | yes

## In Memory
Property Name | Override Property Name | Default Value | Dynamic |
:----------- |:-------------:| -----------|-----------:
:----------- |:-------------|:-----------|:-----------
<CACHE\>.use.inmemory.cache | evcache.use.inmemory.cache | false | yes
<CACHE\>.inmemory.expire.after.write.duration.ms | <CACHE\>.inmemory.cache.duration.ms | 0 | yes
<CACHE\>.inmemory.expire.after.access.duration.ms | | 0 | yes
Expand All @@ -118,7 +118,7 @@ Property Name | Override Property Name | Default Value | Dynamic |
## Throttling

Property Name | Override Property Name | Default Value | Dynamic |
:----------- |:-------------:| -----------|-----------:
:----------- |:-------------|:-----------|:-----------
<CACHE\>.enable.throttling | | false | yes
<CACHE\>.disable.writes | | false | yes
<CACHE\>.throttle.percent | | 0 | yes
Expand All @@ -136,8 +136,19 @@ EVCacheThrottler.<CACHE\>.throttle.value | | 3 | yes |
## Simple Node List

System Property | Override Property Name | Default Value |
:----------- |:-------------:| -----------|
:----------- |:-------------|:-----------|
NETFLIX_ENVIRONMENT | @environment <br> or <br> eureka.environment |
EC2_REGION | @region <br> or <br> eureka.region |
<CACHE\>-NODES | |
<CACHE\>.use.batch.port | evcache.use.batch.port | false
<CACHE\>.use.batch.port | evcache.use.batch.port | false


## changed properties
Old Property | New Property |
:----------- |:-------------|
EVCacheScheduledExecutor.<CACHE\>.max.size | <CACHE\>.executor.max.size
EVCacheScheduledExecutor.<CACHE\>.core.size | <CACHE\>.executor.core.size
EVCacheNodeLocator.<CACHE\>.<asg\>.hash.on.partial.key | <CACHE\>.<asg\>.hash.on.partial.key
EVCacheNodeLocator.<CACHE\>.hash.on.partial.key | <CACHE\>.hash.on.partial.key
EVCacheNodeLocator.<CACHE\>.<asg\>.hash.delimiter | <CACHE\>.<asg\>.hash.delimiter
EVCacheNodeLocator.<CACHE\>.hash.delimiter | <CACHE\>.hash.delimiter
3 changes: 3 additions & 0 deletions docs/css/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.wy-nav-content {
max-width: 1600px;
}
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ public EVCacheNodeLocator(EVCacheClient client, List<MemcachedNode> nodes, HashA
this.config = conf;
this.client = client;

this.partialStringHash = EVCacheConfig.getInstance().getChainedBooleanProperty("EVCacheNodeLocator." + client.getAppName() + "." + client.getServerGroupName() + ".hash.on.partial.key",
"EVCacheNodeLocator." + client.getAppName()+ ".hash.on.partial.key", Boolean.FALSE, null);
this.hashDelimiter = EVCacheConfig.getInstance().getChainedStringProperty("EVCacheNodeLocator." + client.getAppName() + "." + client.getServerGroupName() + ".hash.delimiter",
"EVCacheNodeLocator." + client.getAppName() + ".hash.delimiter", ":", null);
this.partialStringHash = EVCacheConfig.getInstance().getChainedBooleanProperty(client.getAppName() + "." + client.getServerGroupName() + ".hash.on.partial.key",
client.getAppName()+ ".hash.on.partial.key", Boolean.FALSE, null);
this.hashDelimiter = EVCacheConfig.getInstance().getChainedStringProperty(client.getAppName() + "." + client.getServerGroupName() + ".hash.delimiter",
client.getAppName() + ".hash.delimiter", ":", null);

setKetamaNodes(nodes);
}
Expand All @@ -70,10 +70,10 @@ private EVCacheNodeLocator(EVCacheClient client, TreeMap<Long, MemcachedNode> sm
this.config = conf;
this.client = client;

this.partialStringHash = EVCacheConfig.getInstance().getChainedBooleanProperty("EVCacheNodeLocator." + client.getAppName() + "." + client.getServerGroupName() + ".hash.on.partial.key",
"EVCacheNodeLocator." + client.getAppName()+ ".hash.on.partial.key", Boolean.FALSE, null);
this.hashDelimiter = EVCacheConfig.getInstance().getChainedStringProperty("EVCacheNodeLocator." + client.getAppName() + "." + client.getServerGroupName() + ".hash.delimiter",
"EVCacheNodeLocator." + client.getAppName() + ".hash.delimiter", ":", null);
this.partialStringHash = EVCacheConfig.getInstance().getChainedBooleanProperty(client.getAppName() + "." + client.getServerGroupName() + ".hash.on.partial.key",
client.getAppName()+ ".hash.on.partial.key", Boolean.FALSE, null);
this.hashDelimiter = EVCacheConfig.getInstance().getChainedStringProperty(client.getAppName() + "." + client.getServerGroupName() + ".hash.delimiter",
client.getAppName() + ".hash.delimiter", ":", null);
}

/*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ public EVCacheScheduledExecutor(int corePoolSize, int maximumPoolSize, long keep
super(corePoolSize, handler);
this.name = name;

maxAsyncPoolSize = EVCacheConfig.getInstance().getDynamicIntProperty("EVCacheScheduledExecutor." + name + ".max.size", maximumPoolSize);
maxAsyncPoolSize = EVCacheConfig.getInstance().getDynamicIntProperty(name + ".executor.max.size", maximumPoolSize);
setMaximumPoolSize(maxAsyncPoolSize.get());
coreAsyncPoolSize = EVCacheConfig.getInstance().getDynamicIntProperty("EVCacheScheduledExecutor." + name + ".core.size", corePoolSize);
coreAsyncPoolSize = EVCacheConfig.getInstance().getDynamicIntProperty(name + ".executor.core.size", corePoolSize);
setCorePoolSize(coreAsyncPoolSize.get());
setKeepAliveTime(keepAliveTime, unit);
final ThreadFactory asyncFactory = new ThreadFactoryBuilder().setDaemon(true).setNameFormat( "EVCacheScheduledExecutor-" + name + "-%d").build();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ public void complete() {
long retVal = def;
try {
if(mutateOperationTimeout == null) {
mutateOperationTimeout = EVCacheConfig.getInstance().getDynamicLongProperty("evache.mutate.timeout", connectionFactory.getOperationTimeout());
mutateOperationTimeout = EVCacheConfig.getInstance().getDynamicLongProperty(appName + ".mutate.timeout", connectionFactory.getOperationTimeout());
}


Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
site_name: EVCache
site_name: evcache-docs
pages:
- Home: index.md
- Introduction: introduction.md
- Features: features.md
- Using EVCache Client: using.md
# - Using EVCache Client: using.md
- Configuration : config.md

theme: cinder
theme: readthedocs

extra_css:
- css/extra.css

0 comments on commit 9355948

Please sign in to comment.