xref: /3.0.3-GA/ep-engine/configuration.json (revision 118e7bed)
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        "access_scanner_enabled": {
21            "default": "true",
22            "descr": "True if access scanner task is enabled",
23            "type": "bool"
24        },
25        "alog_sleep_time": {
26            "default": "1440",
27            "descr": "Number of minutes between each sweep for the access log",
28            "type": "size_t",
29            "validator": {
30                "range": {
31                    "max": 4320,
32                    "min": 1
33                }
34            }
35        },
36        "alog_task_time": {
37            "default": "10",
38            "descr": "Hour in GMT time when access scanner task is scheduled to run",
39            "type": "size_t",
40            "validator": {
41                "range": {
42                    "max": 23,
43                    "min": 0
44                }
45            }
46        },
47        "backend": {
48            "default": "couchdb",
49            "dynamic": false,
50            "type": "std::string",
51            "validator": {
52                "enum": [
53                    "couchdb"
54                ]
55            }
56        },
57        "backfill_mem_threshold": {
58            "default": "95",
59            "desr": "Percentage of memory that backfill task is allowed to consume",
60            "type": "size_t",
61            "validator": {
62                "range": {
63                    "max": 100,
64                    "min": 0
65                }
66            }
67        },
68        "bg_fetch_delay": {
69            "default": "0",
70            "type": "size_t",
71            "validator": {
72                "range": {
73                    "max": 900,
74                    "min": 0
75                }
76            }
77        },
78        "chk_max_items": {
79            "default": "500",
80            "type": "size_t"
81        },
82        "chk_period": {
83            "default": "5",
84            "type": "size_t"
85        },
86        "chk_remover_stime": {
87            "default": "5",
88            "type": "size_t"
89        },
90        "config_file": {
91            "default": "",
92            "dynamic": false,
93            "type": "std::string"
94        },
95        "conflict_resolution_type": {
96            "default": "seqno",
97            "dynamic": false,
98            "type": "std::string",
99            "validator": {
100                "enum": [
101                    "seqno"
102                ]
103            }
104        },
105        "couch_bucket": {
106            "default": "default",
107            "dynamic": false,
108            "type": "std::string"
109        },
110        "couch_host": {
111            "default": "127.0.0.1",
112            "dynamic": false,
113            "type": "std::string"
114        },
115        "couch_port": {
116            "default": "11213",
117            "dynamic": false,
118            "type": "size_t"
119        },
120        "couch_reconnect_sleeptime": {
121            "default": "250",
122            "dynamic": false,
123            "type": "size_t"
124        },
125        "couch_response_timeout": {
126            "default": "180000",
127            "descr": "Length of time to wait for a response from couchdb before reconnecting (in ms)",
128            "type": "size_t"
129        },
130        "data_traffic_enabled": {
131            "default": "true",
132            "descr": "True if we want to enable data traffic after warmup is complete",
133            "type": "bool"
134        },
135        "dbname": {
136            "default": "/tmp/test",
137            "descr": "Path to on-disk storage.",
138            "dynamic": false,
139            "type": "std::string"
140        },
141        "enable_chk_merge": {
142            "default": "false",
143            "descr": "True if merging closed checkpoints is enabled",
144            "type": "bool"
145        },
146        "exp_pager_stime": {
147            "default": "3600",
148            "type": "size_t"
149        },
150        "failpartialwarmup": {
151            "default": "true",
152            "type": "bool"
153        },
154        "flushall_enabled": {
155            "default": "false",
156            "descr": "True if memcached flush API is enabled",
157            "type": "bool"
158        },
159        "getl_default_timeout": {
160            "default": "15",
161            "descr": "The default timeout for a getl lock in (s)",
162            "type": "size_t"
163        },
164        "getl_max_timeout": {
165            "default": "30",
166            "descr": "The maximum timeout for a getl lock in (s)",
167            "type": "size_t"
168        },
169        "ht_locks": {
170            "default": "0",
171            "type": "size_t"
172        },
173        "ht_size": {
174            "default": "0",
175            "type": "size_t"
176        },
177        "initfile": {
178            "default": "",
179            "type": "std::string"
180        },
181        "item_eviction_policy": {
182            "default": "value_only",
183            "descr": "Item eviction policy on cache, which is used by the item pager",
184            "type": "std::string",
185            "validator": {
186                "enum": [
187                    "value_only",
188                    "full_eviction"
189                ]
190            }
191        },
192        "item_num_based_new_chk": {
193            "default": "true",
194            "descr": "True if the number of items in the current checkpoint plays a role in a new checkpoint creation",
195            "type": "bool"
196        },
197        "keep_closed_chks": {
198            "default": "false",
199            "descr": "True if we want to keep the closed checkpoints for each vbucket unless the memory usage is above high water mark",
200            "type": "bool"
201        },
202        "max_checkpoints": {
203            "default": "2",
204            "type": "size_t"
205        },
206        "max_failover_entries": {
207            "default": "25",
208            "descr": "maximum number of failover log entries",
209            "type": "size_t"
210        },
211        "max_item_size": {
212            "default": "(20 * 1024 * 1024)",
213            "descr": "Maximum number of bytes allowed for an item",
214            "type": "size_t"
215        },
216        "max_size": {
217            "default": "0",
218            "type": "size_t"
219        },
220        "max_vbuckets": {
221            "default": "1024",
222            "descr": "Maximum number of vbuckets expected",
223            "dynamic": false,
224            "type": "size_t"
225        },
226        "max_threads": {
227            "default": "0",
228            "descr": "Maximum number of threads in global pool",
229            "dynamic": false,
230            "type": "size_t"
231        },
232        "max_num_shards": {
233            "default": "4",
234            "descr": "Maximum number of shards",
235            "dynamic": false,
236            "type": "size_t"
237        },
238        "max_num_workers": {
239            "default": "4",
240            "descr": "Bucket Priority relative to other buckets",
241            "dynamic": false,
242            "type": "size_t",
243            "validator": {
244                "range": {
245                    "max": 8,
246                    "min": 1
247                }
248            }
249        },
250        "max_num_readers": {
251            "default": "0",
252            "descr": "Throttle max number of reader threads",
253            "dynamic": false,
254            "type": "size_t",
255            "validator": {
256                "range": {
257                    "max": 512,
258                    "min": 0
259                }
260            }
261        },
262        "max_num_writers": {
263            "default": "0",
264            "descr": "Throttle max number of writer threads",
265            "dynamic": false,
266            "type": "size_t",
267            "validator": {
268                "range": {
269                    "max": 512,
270                    "min": 0
271                }
272            }
273        },
274        "max_num_auxio": {
275            "default": "0",
276            "descr": "Throttle max number of aux io threads",
277            "dynamic": false,
278            "type": "size_t",
279            "validator": {
280                "range": {
281                    "max": 512,
282                    "min": 0
283                }
284            }
285        },
286        "max_num_nonio": {
287            "default": "0",
288            "descr": "Throttle max number of non io threads",
289            "dynamic": false,
290            "type": "size_t",
291            "validator": {
292                "range": {
293                    "max": 512,
294                    "min": 0
295                }
296            }
297        },
298        "mem_high_wat": {
299            "default": "max",
300            "type": "size_t"
301        },
302        "mem_low_wat": {
303            "default": "max",
304            "type": "size_t"
305        },
306        "mutation_mem_threshold": {
307            "default": "98",
308            "desr": "Percentage of memory that can be used before mutations return tmpOOMs",
309            "type": "size_t",
310            "validator" : {
311                "range" : {
312                    "max": 100,
313                    "min": 0
314                }
315            }
316        },
317        "pager_active_vb_pcnt": {
318            "default": "40",
319            "descr": "Active vbuckets paging percentage",
320            "type": "size_t",
321            "validator": {
322                "range": {
323                    "max": 50,
324                    "min": 0
325                }
326            }
327        },
328        "postInitfile": {
329            "default": "",
330            "type": "std::string"
331        },
332        "tap_ack_grace_period": {
333            "default": "300",
334            "type": "size_t"
335        },
336        "tap_ack_initial_sequence_number": {
337            "default": "1",
338            "type": "size_t"
339        },
340        "tap_ack_interval": {
341            "default": "1000",
342            "type": "size_t"
343        },
344        "tap_ack_window_size": {
345            "default": "10",
346            "type": "size_t"
347        },
348        "tap_backfill_resident": {
349            "default": "0.9",
350            "type": "float"
351        },
352        "tap_backlog_limit": {
353            "default": "5000",
354            "type": "size_t"
355        },
356        "tap_backoff_period": {
357            "default": "5.0",
358            "type": "float"
359        },
360        "tap_bg_max_pending": {
361            "default": "500",
362            "type": "size_t"
363        },
364        "tap_keepalive": {
365            "default": "0",
366            "type": "size_t"
367        },
368        "tap_noop_interval": {
369            "default": "200",
370            "descr": "Number of seconds between a noop is sent on an idle connection",
371            "type": "size_t"
372        },
373        "tap_requeue_sleep_time": {
374            "default": "0.1",
375            "type": "float"
376        },
377        "tap_throttle_cap_pcnt": {
378            "default": "10",
379            "descr": "Percentage of total items in write queue at which we throttle tap input",
380            "type": "size_t",
381            "validator": {
382                "range": {
383                    "max": 100,
384                    "min": 0
385                }
386            }
387        },
388        "tap_throttle_queue_cap": {
389            "default": "1000000",
390            "descr": "Max size of a write queue to throttle incoming tap input.",
391            "type": "ssize_t",
392            "validator": {
393                "range": {
394                    "max": 100000000,
395                    "min": -1
396                }
397            }
398        },
399        "tap_throttle_threshold": {
400            "default": "90",
401            "descr": "Percentage of max mem at which we begin NAKing tap input.",
402            "type": "size_t",
403            "validator": {
404                "range": {
405                    "max": 100,
406                    "min": 0
407                }
408            }
409        },
410        "uuid": {
411            "default": "",
412            "descr": "The UUID for the bucket",
413            "dynamic" : false,
414            "type": "std::string"
415        },
416        "dcp_conn_buffer_size": {
417            "default": "10485760",
418            "descr": "Size in bytes of an dcp consumer connection buffer",
419            "dynamic": false,
420            "type": "size_t"
421        },
422        "dcp_enable_flow_control": {
423            "default": "true",
424            "descr": "Whether or not dcp connections should use flow control",
425            "dynamic": false,
426            "type": "bool"
427        },
428        "dcp_enable_noop": {
429            "default": "true",
430            "descr": "Whether or not dcp connections should use no-ops",
431            "dynamic": false,
432            "type": "bool"
433        },
434        "dcp_noop_interval": {
435            "default": "180",
436            "descr": "Number of seconds between a noop",
437            "type": "size_t"
438        },
439        "dcp_max_unacked_bytes": {
440            "default": "524288",
441            "descr": "Amount of processed bytes before an ack is required",
442            "dynamic": false,
443            "type": "size_t"
444        },
445        "vb0": {
446            "default": "true",
447            "type": "bool"
448        },
449        "waitforwarmup": {
450            "default": "true",
451            "type": "bool"
452        },
453        "warmup": {
454            "default": "true",
455            "type": "bool"
456        },
457        "warmup_batch_size": {
458            "default": "1000",
459            "descr": "The size of each batch loaded during warmup.",
460            "dynamic": false,
461            "type": "size_t",
462            "validator": {
463                "range": {
464                    "max": 10000,
465                    "min": 1
466                }
467            }
468        },
469        "warmup_min_memory_threshold": {
470            "default": "100",
471            "descr": "Percentage of max mem warmed up before we enable traffic.",
472            "type": "size_t",
473            "validator": {
474                "range": {
475                    "max": 100,
476                    "min": 0
477                }
478            }
479        },
480        "warmup_min_items_threshold": {
481            "default": "100",
482            "descr": "Percentage of total items warmed up before we enable traffic.",
483            "type": "size_t",
484            "validator": {
485                "range": {
486                    "max": 100,
487                    "min": 0
488                }
489            }
490        }
491    }
492}
493