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