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