Merge tag 'v3.1.5' into sherlock
[ep-engine.git] / configuration.json
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": "2",
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": "96",
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         "bfilter_enabled": {
79             "default": "true",
80             "desr": "Enable or disable the bloom filter",
81             "type": "bool"
82         },
83         "bfilter_key_count": {
84             "default": "10000",
85             "desr": "Bloomfilter: Estimated key count per vbucket",
86             "type": "size_t"
87         },
88         "bfilter_fp_prob": {
89             "default": "0.01",
90             "desr": "Bloomfilter: Allowed probability for false positives",
91             "type": "float"
92         },
93         "bfilter_residency_threshold": {
94             "default": "0.1",
95             "desr" : "If resident ratio (during full eviction) were found less than this threshold, compaction will include all items into bloomfilter",
96             "type" : "float"
97         },
98         "compaction_exp_mem_threshold": {
99             "default": "85",
100             "desr": "Memory usage threshold after which compaction will not queue expired items for deletion",
101             "type": "size_t",
102             "validator": {
103                 "range": {
104                     "max": 100,
105                     "min": 0
106                 }
107             }
108         },
109         "chk_max_items": {
110             "default": "500",
111             "type": "size_t"
112         },
113         "chk_period": {
114             "default": "5",
115             "type": "size_t"
116         },
117         "chk_remover_stime": {
118             "default": "5",
119             "type": "size_t"
120         },
121         "compaction_write_queue_cap": {
122             "default": "10000",
123             "desr" : "Disk write queue threshold after which compaction tasks will be made to snooze, if there are already pending compaction tasks",
124             "type" : "size_t"
125         },
126         "config_file": {
127             "default": "",
128             "dynamic": false,
129             "type": "std::string"
130         },
131         "conflict_resolution_type": {
132             "default": "seqno",
133             "dynamic": false,
134             "type": "std::string",
135             "validator": {
136                 "enum": [
137                     "seqno"
138                 ]
139             }
140         },
141         "couch_bucket": {
142             "default": "default",
143             "dynamic": false,
144             "type": "std::string"
145         },
146         "data_traffic_enabled": {
147             "default": "true",
148             "descr": "True if we want to enable data traffic after warmup is complete",
149             "type": "bool"
150         },
151         "dbname": {
152             "default": "/tmp/test",
153             "descr": "Path to on-disk storage.",
154             "dynamic": false,
155             "type": "std::string"
156         },
157         "defragmenter_enabled": {
158             "default": "true",
159             "descr": "True if defragmenter task is enabled",
160             "type": "bool"
161         },
162         "defragmenter_interval": {
163             "default": "10",
164             "descr": "How often defragmenter task should be run (in seconds).",
165             "type": "size_t"
166         },
167         "defragmenter_age_threshold": {
168             "default": "10",
169             "descr": "How old (measured in number of defragmenter passes) must a document be to be considered for degragmentation.",
170             "type": "size_t"
171         },
172         "defragmenter_chunk_duration": {
173             "default": "20",
174             "descr": "Maximum time (in ms) defragmentation task will run for before being paused (and resumed at the next defragmenter_interval).",
175             "type": "size_t"
176         },
177         "enable_chk_merge": {
178             "default": "false",
179             "descr": "True if merging closed checkpoints is enabled",
180             "type": "bool"
181         },
182         "exp_pager_stime": {
183             "default": "3600",
184             "type": "size_t"
185         },
186         "failpartialwarmup": {
187             "default": "true",
188             "type": "bool"
189         },
190         "flushall_enabled": {
191             "default": "true",
192             "descr": "True if memcached flush API is enabled",
193             "type": "bool"
194         },
195         "getl_default_timeout": {
196             "default": "15",
197             "descr": "The default timeout for a getl lock in (s)",
198             "type": "size_t"
199         },
200         "getl_max_timeout": {
201             "default": "30",
202             "descr": "The maximum timeout for a getl lock in (s)",
203             "type": "size_t"
204         },
205         "ht_locks": {
206             "default": "47",
207             "type": "size_t"
208         },
209         "ht_size": {
210             "default": "0",
211             "type": "size_t"
212         },
213         "initfile": {
214             "default": "",
215             "type": "std::string"
216         },
217         "item_eviction_policy": {
218             "default": "value_only",
219             "descr": "Item eviction policy on cache, which is used by the item pager",
220             "type": "std::string",
221             "validator": {
222                 "enum": [
223                     "value_only",
224                     "full_eviction"
225                 ]
226             }
227         },
228         "item_num_based_new_chk": {
229             "default": "true",
230             "descr": "True if the number of items in the current checkpoint plays a role in a new checkpoint creation",
231             "type": "bool"
232         },
233         "keep_closed_chks": {
234             "default": "false",
235             "descr": "True if we want to keep the closed checkpoints for each vbucket unless the memory usage is above high water mark",
236             "type": "bool"
237         },
238         "max_checkpoints": {
239             "default": "2",
240             "type": "size_t"
241         },
242         "max_failover_entries": {
243             "default": "25",
244             "descr": "maximum number of failover log entries",
245             "type": "size_t"
246         },
247         "max_item_size": {
248             "default": "(20 * 1024 * 1024)",
249             "descr": "Maximum number of bytes allowed for an item",
250             "type": "size_t"
251         },
252         "max_size": {
253             "default": "0",
254             "type": "size_t"
255         },
256         "max_vbuckets": {
257             "default": "1024",
258             "descr": "Maximum number of vbuckets expected",
259             "dynamic": false,
260             "type": "size_t"
261         },
262         "max_threads": {
263             "default": "0",
264             "descr": "Maximum number of threads in global pool",
265             "dynamic": false,
266             "type": "size_t"
267         },
268         "max_num_shards": {
269             "default": "4",
270             "descr": "Maximum number of shards",
271             "dynamic": false,
272             "type": "size_t"
273         },
274         "max_num_workers": {
275             "default": "4",
276             "descr": "Bucket Priority relative to other buckets",
277             "dynamic": false,
278             "type": "size_t",
279             "validator": {
280                 "range": {
281                     "max": 8,
282                     "min": 1
283                 }
284             }
285         },
286         "max_num_readers": {
287             "default": "0",
288             "descr": "Throttle max number of reader threads",
289             "dynamic": false,
290             "type": "size_t",
291             "validator": {
292                 "range": {
293                     "max": 512,
294                     "min": 0
295                 }
296             }
297         },
298         "max_num_writers": {
299             "default": "0",
300             "descr": "Throttle max number of writer threads",
301             "dynamic": false,
302             "type": "size_t",
303             "validator": {
304                 "range": {
305                     "max": 512,
306                     "min": 0
307                 }
308             }
309         },
310         "max_num_auxio": {
311             "default": "0",
312             "descr": "Throttle max number of aux io threads",
313             "dynamic": false,
314             "type": "size_t",
315             "validator": {
316                 "range": {
317                     "max": 512,
318                     "min": 0
319                 }
320             }
321         },
322         "max_num_nonio": {
323             "default": "0",
324             "descr": "Throttle max number of non io threads",
325             "dynamic": false,
326             "type": "size_t",
327             "validator": {
328                 "range": {
329                     "max": 512,
330                     "min": 0
331                 }
332             }
333         },
334         "mem_high_wat": {
335             "default": "max",
336             "type": "size_t"
337         },
338         "mem_low_wat": {
339             "default": "max",
340             "type": "size_t"
341         },
342         "mutation_mem_threshold": {
343             "default": "93",
344             "desr": "Percentage of memory that can be used before mutations return tmpOOMs",
345             "type": "size_t",
346             "validator" : {
347                 "range" : {
348                     "max": 100,
349                     "min": 0
350                 }
351             }
352         },
353         "pager_active_vb_pcnt": {
354             "default": "40",
355             "descr": "Active vbuckets paging percentage",
356             "type": "size_t",
357             "validator": {
358                 "range": {
359                     "max": 50,
360                     "min": 0
361                 }
362             }
363         },
364         "postInitfile": {
365             "default": "",
366             "type": "std::string"
367         },
368         "tap_ack_grace_period": {
369             "default": "300",
370             "type": "size_t"
371         },
372         "tap_ack_initial_sequence_number": {
373             "default": "1",
374             "type": "size_t"
375         },
376         "tap_ack_interval": {
377             "default": "1000",
378             "type": "size_t"
379         },
380         "tap_ack_window_size": {
381             "default": "10",
382             "type": "size_t"
383         },
384         "tap_backfill_resident": {
385             "default": "0.9",
386             "type": "float"
387         },
388         "tap_backlog_limit": {
389             "default": "5000",
390             "type": "size_t"
391         },
392         "tap_backoff_period": {
393             "default": "5.0",
394             "type": "float"
395         },
396         "tap_bg_max_pending": {
397             "default": "500",
398             "type": "size_t"
399         },
400         "tap_keepalive": {
401             "default": "0",
402             "type": "size_t"
403         },
404         "tap_noop_interval": {
405             "default": "200",
406             "descr": "Number of seconds between a noop is sent on an idle connection",
407             "type": "size_t"
408         },
409         "tap_requeue_sleep_time": {
410             "default": "0.1",
411             "type": "float"
412         },
413         "tap_throttle_cap_pcnt": {
414             "default": "10",
415             "descr": "Percentage of total items in write queue at which we throttle tap input",
416             "type": "size_t",
417             "validator": {
418                 "range": {
419                     "max": 100,
420                     "min": 0
421                 }
422             }
423         },
424         "tap_throttle_queue_cap": {
425             "default": "-1",
426             "descr": "Max size of a write queue to throttle incoming tap input.",
427             "type": "ssize_t",
428             "validator": {
429                 "range": {
430                     "max": 100000000,
431                     "min": -1
432                 }
433             }
434         },
435         "tap_throttle_threshold": {
436             "default": "99",
437             "descr": "Percentage of max mem at which we begin NAKing tap input.",
438             "type": "size_t",
439             "validator": {
440                 "range": {
441                     "max": 100,
442                     "min": 0
443                 }
444             }
445         },
446         "uuid": {
447             "default": "",
448             "descr": "The UUID for the bucket",
449             "dynamic" : false,
450             "type": "std::string"
451         },
452         "dcp_backfill_byte_limit": {
453             "default": "20971832",
454             "descr": "Max bytes a connection can backfill into memory",
455             "dynamic": false,
456             "type": "size_t"
457         },
458         "dcp_conn_buffer_size": {
459             "default": "10485760",
460             "descr": "Size in bytes of an dcp consumer connection buffer",
461             "dynamic": false,
462             "type": "size_t"
463         },
464         "dcp_enable_dynamic_conn_buffer_size": {
465             "default": "true",
466             "descr": "Whether or not the buffer size in dcp flow control be decided dynamically",
467             "dynamic": false,
468             "type": "bool"
469         },
470         "dcp_conn_buffer_size_max": {
471             "default": "52428800",
472             "descr": "Max size in bytes of an dcp consumer connection buffer",
473             "dynamic": false,
474             "type": "size_t"
475         },
476         "dcp_conn_buffer_size_perc": {
477             "default": "1",
478             "descr": "Percentage of memQuota for a dcp consumer connection buffer",
479             "type": "size_t",
480             "dynamic": false,
481             "validator": {
482                 "range": {
483                     "max": 10,
484                     "min": 1
485                 }
486             }
487         },
488         "dcp_conn_buffer_size_aggr_mem_threshold": {
489             "default": "10",
490             "descr": "Aggr mem usage by all dcp conns (as percentage of memQuota) after which only dcp_conn_buffer_size is allocated",
491             "type": "size_t",
492             "dynamic": false,
493             "validator": {
494                 "range": {
495                     "max": 20,
496                     "min": 1
497                 }
498             }
499         },
500         "dcp_enable_flow_control": {
501             "default": "true",
502             "descr": "Whether or not dcp connections should use flow control",
503             "dynamic": false,
504             "type": "bool"
505         },
506         "dcp_enable_noop": {
507             "default": "true",
508             "descr": "Whether or not dcp connections should use no-ops",
509             "dynamic": false,
510             "type": "bool"
511         },
512         "dcp_noop_interval": {
513             "default": "180",
514             "descr": "Number of seconds between a noop",
515             "type": "size_t"
516         },
517         "dcp_max_unacked_bytes": {
518             "default": "524288",
519             "descr": "Amount of processed bytes before an ack is required",
520             "dynamic": false,
521             "type": "size_t"
522         },
523         "dcp_scan_byte_limit": {
524             "default": "4194304",
525             "descr": "Max bytes that can be read in a single disk scan",
526             "dynamic": false,
527             "type": "size_t"
528         },
529         "dcp_scan_item_limit": {
530             "default": "4096",
531             "descr": "Max items that can be read in a single disk scan",
532             "dynamic": false,
533             "type": "size_t"
534         },
535         "dcp_producer_snapshot_marker_yield_limit": {
536             "default": "10",
537             "descr": "The number of snapshots before ActiveStreamCheckpointProcessorTask::run yields.",
538             "type": "size_t",
539             "validator": {
540                 "range": {
541                     "max": 100000000,
542                     "min": 1
543                 }
544             }
545         },
546         "dcp_consumer_process_buffered_messages_yield_limit" : {
547             "default": "10",
548             "descr": "The number of processBufferedMessages iterations before forcing the task to yield.",
549             "type": "size_t",
550             "validator": {
551                 "range": {
552                     "max": 100000000,
553                     "min": 1
554                 }
555             }
556         },
557         "dcp_consumer_process_buffered_messages_batch_size" : {
558             "default": "10",
559             "descr": "The maximum number of items stream->processBufferedMessages will consume.",
560             "type": "size_t",
561             "validator": {
562                 "range": {
563                     "max": 100000000,
564                     "min": 1
565                 }
566             }
567         },
568         "vb0": {
569             "default": "false",
570             "type": "bool"
571         },
572         "waitforwarmup": {
573             "default": "false",
574             "type": "bool"
575         },
576         "warmup": {
577             "default": "true",
578             "type": "bool"
579         },
580         "warmup_batch_size": {
581             "default": "1000",
582             "descr": "The size of each batch loaded during warmup.",
583             "dynamic": false,
584             "type": "size_t",
585             "validator": {
586                 "range": {
587                     "max": 10000,
588                     "min": 1
589                 }
590             }
591         },
592         "warmup_min_memory_threshold": {
593             "default": "100",
594             "descr": "Percentage of max mem warmed up before we enable traffic.",
595             "type": "size_t",
596             "validator": {
597                 "range": {
598                     "max": 100,
599                     "min": 0
600                 }
601             }
602         },
603         "warmup_min_items_threshold": {
604             "default": "100",
605             "descr": "Percentage of total items warmed up before we enable traffic.",
606             "type": "size_t",
607             "validator": {
608                 "range": {
609                     "max": 100,
610                     "min": 0
611                 }
612             }
613         }
614     }
615 }