xref: /3.0.3-GA/ep-engine/configuration.json (revision d23bffa8)
1{
2    "params": {
3        "allow_data_loss_during_shutdown": {
4            "default": "false",
5            "dynamic": false,
6            "type": "bool"
7        },
8        "alog_block_size": {
9            "default": "4096",
10            "descr": "Logging block size.",
11            "dynamic": false,
12            "type": "size_t"
13        },
14        "alog_path": {
15            "default": "",
16            "descr": "Path to the access log.",
17            "dynamic": false,
18            "type": "std::string"
19        },
20        "alog_sleep_time": {
21            "default": "1440",
22            "descr": "Number of minutes between each sweep for the access log",
23            "type": "size_t",
24            "validator": {
25                "range": {
26                    "max": 4320,
27                    "min": 1
28                }
29            }
30        },
31        "alog_task_time": {
32            "default": "10",
33            "descr": "Hour in GMT time when access scanner task is scheduled to run",
34            "type": "size_t",
35            "validator": {
36                "range": {
37                    "max": 23,
38                    "min": 0
39                }
40            }
41        },
42        "backend": {
43            "default": "couchdb",
44            "dynamic": false,
45            "type": "std::string",
46            "validator": {
47                "enum": [
48                    "couchdb"
49                ]
50            }
51        },
52        "bg_fetch_delay": {
53            "default": "0",
54            "type": "size_t",
55            "validator": {
56                "range": {
57                    "max": 900,
58                    "min": 0
59                }
60            }
61        },
62        "chk_max_items": {
63            "default": "5000",
64            "type": "size_t"
65        },
66        "chk_period": {
67            "default": "1800",
68            "type": "size_t"
69        },
70        "chk_remover_stime": {
71            "default": "5",
72            "type": "size_t"
73        },
74        "config_file": {
75            "default": "",
76            "dynamic": false,
77            "type": "std::string"
78        },
79        "conflict_resolution_type": {
80            "default": "seqno",
81            "dynamic": false,
82            "type": "std::string",
83            "validator": {
84                "enum": [
85                    "seqno"
86                ]
87            }
88        },
89        "couch_bucket": {
90            "default": "default",
91            "dynamic": false,
92            "type": "std::string"
93        },
94        "couch_host": {
95            "default": "127.0.0.1",
96            "dynamic": false,
97            "type": "std::string"
98        },
99        "couch_port": {
100            "default": "11213",
101            "dynamic": false,
102            "type": "size_t"
103        },
104        "couch_reconnect_sleeptime": {
105            "default": "250",
106            "dynamic": false,
107            "type": "size_t"
108        },
109        "couch_response_timeout": {
110            "default": "180000",
111            "descr": "Length of time to wait for a response from couchdb before reconnecting (in ms)",
112            "type": "size_t"
113        },
114        "data_traffic_enabled": {
115            "default": "true",
116            "descr": "True if we want to enable data traffic after warmup is complete",
117            "type": "bool"
118        },
119        "dbname": {
120            "default": "/tmp/test",
121            "descr": "Path to on-disk storage.",
122            "dynamic": false,
123            "type": "std::string"
124        },
125        "exp_pager_stime": {
126            "default": "3600",
127            "type": "size_t"
128        },
129        "failpartialwarmup": {
130            "default": "true",
131            "type": "bool"
132        },
133        "flushall_enabled": {
134            "default": "false",
135            "descr": "True if memcached flush API is enabled",
136            "type": "bool"
137        },
138        "getl_default_timeout": {
139            "default": "15",
140            "descr": "The default timeout for a getl lock in (s)",
141            "type": "size_t"
142        },
143        "getl_max_timeout": {
144            "default": "30",
145            "descr": "The maximum timeout for a getl lock in (s)",
146            "type": "size_t"
147        },
148        "ht_locks": {
149            "default": "0",
150            "type": "size_t"
151        },
152        "ht_size": {
153            "default": "0",
154            "type": "size_t"
155        },
156        "initfile": {
157            "default": "",
158            "type": "std::string"
159        },
160        "item_eviction_policy": {
161            "default": "value_only",
162            "descr": "Item eviction policy on cache, which is used by the item pager",
163            "type": "std::string",
164            "validator": {
165                "enum": [
166                    "value_only",
167                    "full_eviction"
168                ]
169            }
170        },
171        "item_num_based_new_chk": {
172            "default": "true",
173            "descr": "True if the number of items in the current checkpoint plays a role in a new checkpoint creation",
174            "type": "bool"
175        },
176        "keep_closed_chks": {
177            "default": "false",
178            "descr": "True if we want to keep the closed checkpoints for each vbucket unless the memory usage is above high water mark",
179            "type": "bool"
180        },
181        "max_checkpoints": {
182            "default": "2",
183            "type": "size_t"
184        },
185        "max_failover_entries": {
186            "default": "25",
187            "descr": "maximum number of failover log entries",
188            "type": "size_t"
189        },
190        "max_item_size": {
191            "default": "(20 * 1024 * 1024)",
192            "descr": "Maximum number of bytes allowed for an item",
193            "type": "size_t"
194        },
195        "max_size": {
196            "default": "0",
197            "type": "size_t"
198        },
199        "max_vbuckets": {
200            "default": "1024",
201            "descr": "Maximum number of vbuckets expected",
202            "dynamic": false,
203            "type": "size_t"
204        },
205        "max_threads": {
206            "default": "0",
207            "descr": "Maximum number of threads in global pool",
208            "dynamic": false,
209            "type": "size_t"
210        },
211        "max_num_shards": {
212            "default": "4",
213            "descr": "Maximum number of shards",
214            "dynamic": false,
215            "type": "size_t"
216        },
217        "max_num_workers": {
218            "default": "4",
219            "descr": "Bucket Priority relative to other buckets",
220            "dynamic": false,
221            "type": "size_t",
222            "validator": {
223                "range": {
224                    "max": 8,
225                    "min": 1
226                }
227            }
228        },
229        "mem_high_wat": {
230            "default": "max",
231            "type": "size_t"
232        },
233        "mem_low_wat": {
234            "default": "max",
235            "type": "size_t"
236        },
237        "mutation_mem_threshold": {
238            "default": "95",
239            "type": "size_t"
240        },
241        "pager_active_vb_pcnt": {
242            "default": "40",
243	    "descr": "Active vbuckets paging percentage",
244            "type": "size_t",
245            "validator": {
246                "range": {
247                    "max": 50,
248                    "min": 0
249                }
250            }
251        },
252        "postInitfile": {
253            "default": "",
254            "type": "std::string"
255        },
256        "tap_ack_grace_period": {
257            "default": "300",
258            "type": "size_t"
259        },
260        "tap_ack_initial_sequence_number": {
261            "default": "1",
262            "type": "size_t"
263        },
264        "tap_ack_interval": {
265            "default": "1000",
266            "type": "size_t"
267        },
268        "tap_ack_window_size": {
269            "default": "10",
270            "type": "size_t"
271        },
272        "tap_backfill_resident": {
273            "default": "0.9",
274            "type": "float"
275        },
276        "tap_backlog_limit": {
277            "default": "5000",
278            "type": "size_t"
279        },
280        "tap_backoff_period": {
281            "default": "5.0",
282            "type": "float"
283        },
284        "tap_bg_max_pending": {
285            "default": "500",
286            "type": "size_t"
287        },
288        "tap_keepalive": {
289            "default": "0",
290            "type": "size_t"
291        },
292        "tap_noop_interval": {
293            "default": "200",
294            "descr": "Number of seconds between a noop is sent on an idle connection",
295            "type": "size_t"
296        },
297        "tap_requeue_sleep_time": {
298            "default": "0.1",
299            "type": "float"
300        },
301        "tap_throttle_cap_pcnt": {
302            "default": "10",
303            "descr": "Percentage of total items in write queue at which we throttle tap input",
304            "type": "size_t",
305            "validator": {
306                "range": {
307                    "max": 100,
308                    "min": 0
309                }
310            }
311        },
312        "tap_throttle_queue_cap": {
313            "default": "1000000",
314            "descr": "Max size of a write queue to throttle incoming tap input.",
315            "type": "ssize_t",
316            "validator": {
317                "range": {
318                    "max": 100000000,
319                    "min": -1
320                }
321            }
322        },
323        "tap_throttle_threshold": {
324            "default": "90",
325            "descr": "Percentage of max mem at which we begin NAKing tap input.",
326            "type": "size_t",
327            "validator": {
328                "range": {
329                    "max": 100,
330                    "min": 0
331                }
332            }
333        },
334        "uuid": {
335            "default": "",
336            "descr": "The UUID for the bucket",
337            "dynamic" : false,
338            "type": "std::string"
339        },
340        "vb0": {
341            "default": "true",
342            "type": "bool"
343        },
344        "waitforwarmup": {
345            "default": "true",
346            "type": "bool"
347        },
348        "warmup": {
349            "default": "true",
350            "type": "bool"
351        },
352        "warmup_batch_size": {
353            "default": "1000",
354            "descr": "The size of each batch loaded during warmup.",
355            "dynamic": false,
356            "type": "size_t",
357            "validator": {
358                "range": {
359                    "max": 10000,
360                    "min": 1
361                }
362            }
363        },
364        "warmup_min_memory_threshold": {
365            "default": "100",
366            "descr": "Percentage of max mem warmed up before we enable traffic.",
367            "type": "size_t",
368            "validator": {
369                "range": {
370                    "max": 100,
371                    "min": 0
372                }
373            }
374        },
375        "warmup_min_items_threshold": {
376            "default": "100",
377            "descr": "Percentage of total items warmed up before we enable traffic.",
378            "type": "size_t",
379            "validator": {
380                "range": {
381                    "max": 100,
382                    "min": 0
383                }
384            }
385        }
386    }
387}
388