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