summaryrefslogtreecommitdiffstats
path: root/configdefinitions/src/vespa/vespa.config.search.dispatch.def
diff options
context:
space:
mode:
Diffstat (limited to 'configdefinitions/src/vespa/vespa.config.search.dispatch.def')
-rw-r--r--configdefinitions/src/vespa/vespa.config.search.dispatch.def73
1 files changed, 73 insertions, 0 deletions
diff --git a/configdefinitions/src/vespa/vespa.config.search.dispatch.def b/configdefinitions/src/vespa/vespa.config.search.dispatch.def
new file mode 100644
index 00000000000..aa40c317d75
--- /dev/null
+++ b/configdefinitions/src/vespa/vespa.config.search.dispatch.def
@@ -0,0 +1,73 @@
+# Copyright 2019 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+# Configuration of dispatch from container nodes to search clusters
+
+namespace=vespa.config.search
+
+# The active docs a group must have as a % of the average active docs of all other groups,
+# for that group to be included in queries
+minActivedocsPercentage double default=97.0
+
+# Minimum coverage for allowing a group to be considered for serving
+minGroupCoverage double default=100
+
+# Maximum number of nodes allowed to be down for group to be considered for serving
+maxNodesDownPerGroup int default=0
+
+# Distribution policy for group selection
+distributionPolicy enum { ROUNDROBIN, ADAPTIVE } default=ADAPTIVE
+
+## Maximum number of hits that will be requested from a single node
+## in this dataset. If not set, there is no limit. Using this option
+## may help reduce network traffic when searching in datasets with big
+## fan-out, but it will also result in incorrect and incomplete results;
+## don't use it if you don't (really) mean it.
+maxHitsPerNode int default=2147483647
+
+## Probability for getting the K best hits (topK).
+## A value of 1.0 will ask all N partitions for K hits.
+## Any value between <0, 1> will use a Student T with 30 degrees freedom and compute a value Q that
+## will give you the globally K best hits according to this formula with the desired probability.
+## q = k/n + qT (p',30) x √(k × (1/n) × (1 − 1/n))
+## With a probability of 0.999 and K=200 and N=10 will give a Q of 38, meaning that you only need to fetch 19% compared to
+## a setting of 1.0. This is a significant optimisation with with very little loss in presicion.
+topKProbability double default=0.9999
+
+# Is multi-level dispatch configured for this cluster
+# Deprecated, will go away soon, NOOP
+useMultilevelDispatch bool default=false
+
+# Dispatch only to local nodes. DEPRECATED: The container will automatically do this when it is appropriate.
+useLocalNode bool default=false
+
+# Number of document copies
+searchableCopies long default=1
+
+# Minimum search coverage required before returning the results of a query
+minSearchCoverage double default=100
+
+# Minimum wait time for full coverage after minimum coverage is achieved, factored based on time left at minimum coverage
+minWaitAfterCoverageFactor double default=0
+
+# Maximum wait time for full coverage after minimum coverage is achieved, factored based on time left at minimum coverage
+maxWaitAfterCoverageFactor double default=1
+
+# Number of JRT transport threads
+numJrtTransportThreads int default=8
+
+# Number of JRT connections per backend node
+numJrtConnectionsPerNode int default=8
+
+# Number of seconds to spend warming up code to prevent JIT cold start issues.
+warmuptime double default=0.1
+
+# The unique key of a search node
+node[].key int
+
+# The index of the group this search node belongs to
+node[].group int default=0
+
+# The host name of this search node
+node[].host string
+
+# The rpc port of this search node
+node[].port int