configuration.json

   1 {
   2     "params": {
   3         "alog_block_size": {
   4             "default": "4096",
   5             "descr": "Logging block size.",
   6             "dynamic": false,
   7             "type": "size_t"
   8         },
   9         "alog_path": {
  10             "default": "",
  11             "descr": "Path to the access log.",
  12             "dynamic": false,
  13             "type": "std::string"
  14         },
  15         "access_scanner_enabled": {
  16             "default": "true",
  17             "descr": "True if access scanner task is enabled",
  18             "type": "bool"
  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": "2",
  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         "alog_resident_ratio_threshold": {
  43             "default": "95",
  44             "desr": "Resident ratio percentage above which we do not generate access log",
  45             "dynamic": false,
  46             "type": "size_t",
  47             "validator": {
  48                 "range": {
  49                     "max": 100,
  50                     "min": 0
  51                 }
  52             }
  53         },
  54         "backend": {
  55             "default": "couchdb",
  56             "dynamic": false,
  57             "type": "std::string",
  58             "validator": {
  59                 "enum": [
  60                     "couchdb",
  61                     "forestdb"
  62                 ]
  63             }
  64         },
  65         "backfill_mem_threshold": {
  66             "default": "96",
  67             "desr": "Percentage of memory that backfill task is allowed to consume",
  68             "type": "size_t",
  69             "validator": {
  70                 "range": {
  71                     "max": 100,
  72                     "min": 0
  73                 }
  74             }
  75         },
  76         "bg_fetch_delay": {
  77             "default": "0",
  78             "type": "size_t",
  79             "validator": {
  80                 "range": {
  81                     "max": 900,
  82                     "min": 0
  83                 }
  84             }
  85         },
  86         "bfilter_enabled": {
  87             "default": "true",
  88             "desr": "Enable or disable the bloom filter",
  89             "type": "bool"
  90         },
  91         "bfilter_key_count": {
  92             "default": "10000",
  93             "desr": "Bloomfilter: Estimated key count per vbucket",
  94             "type": "size_t"
  95         },
  96         "bfilter_fp_prob": {
  97             "default": "0.01",
  98             "desr": "Bloomfilter: Allowed probability for false positives",
  99             "type": "float"
 100         },
 101         "bfilter_residency_threshold": {
 102             "default": "0.1",
 103             "desr" : "If resident ratio (during full eviction) were found less than this threshold, compaction will include all items into bloomfilter",
 104             "type" : "float",
 105             "validator": {
 106                 "range": {
 107                     "max": 1.0,
 108                     "min": 0.0
 109                 }
 110             }
 111         },
 112         "compaction_exp_mem_threshold": {
 113             "default": "85",
 114             "desr": "Memory usage threshold after which compaction will not queue expired items for deletion",
 115             "type": "size_t",
 116             "validator": {
 117                 "range": {
 118                     "max": 100,
 119                     "min": 0
 120                 }
 121             }
 122         },
 123         "chk_max_items": {
 124             "default": "500",
 125             "type": "size_t"
 126         },
 127         "chk_period": {
 128             "default": "5",
 129             "type": "size_t"
 130         },
 131         "chk_remover_stime": {
 132             "default": "5",
 133             "type": "size_t"
 134         },
 135         "compaction_write_queue_cap": {
 136             "default": "10000",
 137             "desr" : "Disk write queue threshold after which compaction tasks will be made to snooze, if there are already pending compaction tasks",
 138             "type" : "size_t",
 139             "validator": {
 140                 "range": {
 141                     "min": 1
 142                 }
 143             }
 144         },
 145         "config_file": {
 146             "default": "",
 147             "dynamic": false,
 148             "type": "std::string"
 149         },
 150         "conflict_resolution_type": {
 151             "default": "seqno",
 152             "dynamic": false,
 153             "type": "std::string",
 154             "validator": {
 155                 "enum": [
 156                     "seqno",
 157                     "lww"
 158                 ]
 159             }
 160         },
 161         "couch_bucket": {
 162             "default": "default",
 163             "dynamic": false,
 164             "type": "std::string"
 165         },
 166         "cursor_dropping_lower_mark": {
 167             "default": "80",
 168             "descr": "Percentage of memQuota, below which checkpoint cursor dropping will not continue",
 169             "type": "size_t",
 170             "validator": {
 171                 "range": {
 172                     "max": 100,
 173                     "min": 0
 174                 }
 175             }
 176         },
 177         "cursor_dropping_upper_mark": {
 178             "default": "95",
 179             "descr": "Percentage of memQuota, above which checkpoint cursor dropping will commence",
 180             "type": "size_t",
 181             "validator": {
 182                 "range": {
 183                     "max": 100,
 184                     "min": 0
 185                 }
 186             }
 187         },
 188         "data_traffic_enabled": {
 189             "default": "true",
 190             "descr": "True if we want to enable data traffic after warmup is complete",
 191             "type": "bool"
 192         },
 193         "dbname": {
 194             "default": "./test",
 195             "descr": "Path to on-disk storage.",
 196             "dynamic": false,
 197             "type": "std::string"
 198         },
 199         "defragmenter_enabled": {
 200             "default": "true",
 201             "descr": "True if defragmenter task is enabled",
 202             "type": "bool"
 203         },
 204         "defragmenter_interval": {
 205             "default": "10",
 206             "descr": "How often defragmenter task should be run (in seconds).",
 207             "type": "size_t"
 208         },
 209         "defragmenter_age_threshold": {
 210             "default": "10",
 211             "descr": "How old (measured in number of defragmenter passes) must a document be to be considered for degragmentation.",
 212             "type": "size_t"
 213         },
 214         "defragmenter_chunk_duration": {
 215             "default": "20",
 216             "descr": "Maximum time (in ms) defragmentation task will run for before being paused (and resumed at the next defragmenter_interval).",
 217             "type": "size_t",
 218             "validator": {
 219                 "range": {
 220                     "min": 1
 221                 }
 222             }
 223         },
 224         "enable_chk_merge": {
 225             "default": "false",
 226             "descr": "True if merging closed checkpoints is enabled",
 227             "type": "bool"
 228         },
 229         "exp_pager_enabled": {
 230             "default": "true",
 231             "descr": "True if expiry pager task is enabled",
 232             "type": "bool"
 233         },
 234         "exp_pager_stime": {
 235             "default": "3600",
 236             "descr": "Number of seconds between expiry pager runs.",
 237             "type": "size_t"
 238         },
 239         "exp_pager_initial_run_time": {
 240             "default": "-1",
 241             "descr": "Hour in GMT time when expiry pager can be scheduled for initial run",
 242             "type": "ssize_t",
 243             "validator": {
 244                 "range": {
 245                     "max": 23,
 246                     "min": -1
 247                 }
 248             }
 249         },
 250         "failpartialwarmup": {
 251             "default": "true",
 252             "type": "bool"
 253         },
 254         "flushall_enabled": {
 255             "default": "true",
 256             "descr": "True if memcached flush API is enabled",
 257             "type": "bool"
 258         },
 259         "getl_default_timeout": {
 260             "default": "15",
 261             "descr": "The default timeout for a getl lock in (s)",
 262             "type": "size_t"
 263         },
 264         "getl_max_timeout": {
 265             "default": "30",
 266             "descr": "The maximum timeout for a getl lock in (s)",
 267             "type": "size_t"
 268         },
 269         "hlc_ahead_threshold_us": {
 270             "default": "5000000",
 271             "descr": "The μs threshold at which we will increment a vbucket's ahead counter.",
 272             "type": "size_t"
 273         },
 274         "hlc_behind_threshold_us": {
 275             "default": "5000000",
 276             "descr": "The μs threshold at which we will increment a vbucket's behind counter.",
 277             "type": "size_t"
 278         },
 279         "ht_locks": {
 280             "default": "47",
 281             "type": "size_t"
 282         },
 283         "ht_size": {
 284             "default": "0",
 285             "type": "size_t"
 286         },
 287         "initfile": {
 288             "default": "",
 289             "type": "std::string"
 290         },
 291         "item_eviction_policy": {
 292             "default": "value_only",
 293             "descr": "Item eviction policy on cache, which is used by the item pager",
 294             "type": "std::string",
 295             "validator": {
 296                 "enum": [
 297                     "value_only",
 298                     "full_eviction"
 299                 ]
 300             }
 301         },
 302         "item_num_based_new_chk": {
 303             "default": "true",
 304             "descr": "True if the number of items in the current checkpoint plays a role in a new checkpoint creation",
 305             "type": "bool"
 306         },
 307         "keep_closed_chks": {
 308             "default": "false",
 309             "descr": "True if we want to keep the closed checkpoints for each vbucket unless the memory usage is above high water mark",
 310             "type": "bool"
 311         },
 312         "max_checkpoints": {
 313             "default": "2",
 314             "type": "size_t"
 315         },
 316         "max_failover_entries": {
 317             "default": "25",
 318             "descr": "maximum number of failover log entries",
 319             "type": "size_t"
 320         },
 321         "max_item_size": {
 322             "default": "(20 * 1024 * 1024)",
 323             "descr": "Maximum number of bytes allowed for an item",
 324             "type": "size_t"
 325         },
 326         "max_size": {
 327             "default": "0",
 328             "type": "size_t"
 329         },
 330         "max_vbuckets": {
 331             "default": "1024",
 332             "descr": "Maximum number of vbuckets expected",
 333             "dynamic": false,
 334             "type": "size_t"
 335         },
 336         "max_threads": {
 337             "default": "0",
 338             "descr": "Maximum number of threads in global pool",
 339             "dynamic": false,
 340             "type": "size_t"
 341         },
 342         "max_num_shards": {
 343             "default": "4",
 344             "descr": "Maximum number of shards",
 345             "dynamic": false,
 346             "type": "size_t"
 347         },
 348         "max_num_workers": {
 349             "default": "4",
 350             "descr": "Bucket Priority relative to other buckets",
 351             "dynamic": false,
 352             "type": "size_t",
 353             "validator": {
 354                 "range": {
 355                     "max": 8,
 356                     "min": 1
 357                 }
 358             }
 359         },
 360         "max_num_readers": {
 361             "default": "0",
 362             "descr": "Throttle max number of reader threads",
 363             "dynamic": false,
 364             "type": "size_t",
 365             "validator": {
 366                 "range": {
 367                     "max": 512,
 368                     "min": 0
 369                 }
 370             }
 371         },
 372         "max_num_writers": {
 373             "default": "0",
 374             "descr": "Throttle max number of writer threads",
 375             "dynamic": false,
 376             "type": "size_t",
 377             "validator": {
 378                 "range": {
 379                     "max": 512,
 380                     "min": 0
 381                 }
 382             }
 383         },
 384         "max_num_auxio": {
 385             "default": "0",
 386             "descr": "Throttle max number of aux io threads",
 387             "dynamic": false,
 388             "type": "size_t",
 389             "validator": {
 390                 "range": {
 391                     "max": 512,
 392                     "min": 0
 393                 }
 394             }
 395         },
 396         "max_num_nonio": {
 397             "default": "0",
 398             "descr": "Throttle max number of non io threads",
 399             "dynamic": false,
 400             "type": "size_t",
 401             "validator": {
 402                 "range": {
 403                     "max": 512,
 404                     "min": 0
 405                 }
 406             }
 407         },
 408         "mem_high_wat": {
 409             "default": "max",
 410             "type": "size_t"
 411         },
 412         "mem_low_wat": {
 413             "default": "max",
 414             "type": "size_t"
 415         },
 416         "mutation_mem_threshold": {
 417             "default": "93",
 418             "desr": "Percentage of memory that can be used before mutations return tmpOOMs",
 419             "type": "size_t",
 420             "validator" : {
 421                 "range" : {
 422                     "max": 100,
 423                     "min": 0
 424                 }
 425             }
 426         },
 427         "pager_active_vb_pcnt": {
 428             "default": "40",
 429             "descr": "Active vbuckets paging percentage",
 430             "type": "size_t",
 431             "validator": {
 432                 "range": {
 433                     "max": 50,
 434                     "min": 0
 435                 }
 436             }
 437         },
 438         "postInitfile": {
 439             "default": "",
 440             "type": "std::string"
 441         },
 442         "tap_ack_grace_period": {
 443             "default": "300",
 444             "type": "size_t"
 445         },
 446         "tap_ack_initial_sequence_number": {
 447             "default": "1",
 448             "type": "size_t"
 449         },
 450         "tap_ack_interval": {
 451             "default": "1000",
 452             "type": "size_t"
 453         },
 454         "tap_ack_window_size": {
 455             "default": "10",
 456             "type": "size_t"
 457         },
 458         "tap_backfill_resident": {
 459             "default": "0.9",
 460             "type": "float"
 461         },
 462         "tap_backlog_limit": {
 463             "default": "5000",
 464             "type": "size_t"
 465         },
 466         "tap_backoff_period": {
 467             "default": "5.0",
 468             "type": "float"
 469         },
 470         "tap_bg_max_pending": {
 471             "default": "500",
 472             "type": "size_t"
 473         },
 474         "tap_keepalive": {
 475             "default": "0",
 476             "type": "size_t"
 477         },
 478         "tap_noop_interval": {
 479             "default": "200",
 480             "descr": "Number of seconds between a noop is sent on an idle connection",
 481             "type": "size_t"
 482         },
 483         "tap_requeue_sleep_time": {
 484             "default": "0.1",
 485             "type": "float"
 486         },
 487         "replication_throttle_cap_pcnt": {
 488             "default": "10",
 489             "descr": "Percentage of total items in write queue at which we throttle tap input",
 490             "type": "size_t",
 491             "validator": {
 492                 "range": {
 493                     "max": 100,
 494                     "min": 0
 495                 }
 496             }
 497         },
 498         "replication_throttle_queue_cap": {
 499             "default": "-1",
 500             "descr": "Max size of a write queue to throttle incoming tap input.",
 501             "type": "ssize_t",
 502             "validator": {
 503                 "range": {
 504                     "max": 100000000,
 505                     "min": -1
 506                 }
 507             }
 508         },
 509         "replication_throttle_threshold": {
 510             "default": "99",
 511             "descr": "Percentage of max mem at which we begin NAKing tap input.",
 512             "type": "size_t",
 513             "validator": {
 514                 "range": {
 515                     "max": 100,
 516                     "min": 0
 517                 }
 518             }
 519         },
 520         "uuid": {
 521             "default": "",
 522             "descr": "The UUID for the bucket",
 523             "dynamic" : false,
 524             "type": "std::string"
 525         },
 526         "dcp_backfill_byte_limit": {
 527             "default": "20971832",
 528             "descr": "Max bytes a connection can backfill into memory",
 529             "dynamic": false,
 530             "type": "size_t"
 531         },
 532         "dcp_flow_control_policy": {
 533             "default": "aggressive",
 534             "descr": "Flow control policy used on consumer side buffer",
 535             "type": "std::string",
 536             "validator": {
 537                 "enum": [
 538                          "none",
 539                          "static",
 540                          "dynamic",
 541                          "aggressive"
 542                         ]
 543             }
 544         },
 545         "dcp_conn_buffer_size": {
 546             "default": "10485760",
 547             "descr": "Size in bytes of an dcp consumer connection buffer",
 548             "dynamic": false,
 549             "type": "size_t"
 550         },
 551         "dcp_conn_buffer_size_max": {
 552             "default": "52428800",
 553             "descr": "Max size in bytes of an dcp consumer connection buffer",
 554             "dynamic": false,
 555             "type": "size_t"
 556         },
 557         "dcp_conn_buffer_size_perc": {
 558             "default": "1",
 559             "descr": "Percentage of memQuota for a dcp consumer connection buffer in dynamic flow ctl policy",
 560             "type": "size_t",
 561             "dynamic": false,
 562             "validator": {
 563                 "range": {
 564                     "max": 10,
 565                     "min": 1
 566                 }
 567             }
 568         },
 569         "dcp_conn_buffer_size_aggr_mem_threshold": {
 570             "default": "10",
 571             "descr": "Aggr mem usage by all dcp conns (as percentage of memQuota) after which only dcp_conn_buffer_size is allocated",
 572             "type": "size_t",
 573             "dynamic": false,
 574             "validator": {
 575                 "range": {
 576                     "max": 20,
 577                     "min": 1
 578                 }
 579             }
 580         },
 581         "dcp_conn_buffer_size_aggressive_perc": {
 582             "default": "5",
 583             "descr": "Percentage of memQuota for all dcp consumer connection buffers in aggressive flow ctl policy",
 584             "type": "size_t",
 585             "dynamic": false,
 586             "validator": {
 587                 "range": {
 588                     "max": 20,
 589                     "min": 1
 590                 }
 591             }
 592         },
 593         "dcp_enable_noop": {
 594             "default": "true",
 595             "descr": "Whether or not dcp connections should use no-ops",
 596             "dynamic": false,
 597             "type": "bool"
 598         },
 599         "dcp_value_compression_enabled": {
 600             "default": "false",
 601             "desr": "Whether or not dcp producer should compress value before transmitting",
 602             "dynamic": false,
 603             "type": "bool"
 604         },
 605         "dcp_min_compression_ratio": {
 606             "default": "0.85",
 607             "desr": "Compression ratio to be achieved above which producer will ship documents as is",
 608             "type": "float",
 609             "validator": {
 610                 "range": {
 611                     "min": 0.0
 612                 }
 613             }
 614         },
 615         "dcp_noop_interval": {
 616             "default": "180",
 617             "descr": "Number of seconds between a noop",
 618             "type": "size_t"
 619         },
 620         "dcp_max_unacked_bytes": {
 621             "default": "524288",
 622             "descr": "Amount of processed bytes before an ack is required",
 623             "dynamic": false,
 624             "type": "size_t"
 625         },
 626         "dcp_scan_byte_limit": {
 627             "default": "4194304",
 628             "descr": "Max bytes that can be read in a single disk scan",
 629             "dynamic": false,
 630             "type": "size_t"
 631         },
 632         "dcp_scan_item_limit": {
 633             "default": "4096",
 634             "descr": "Max items that can be read in a single disk scan",
 635             "dynamic": false,
 636             "type": "size_t"
 637         },
 638         "dcp_takeover_max_time": {
 639             "default": "60",
 640             "descr": "Max amount of time for takeover send (in seconds) after which front end ops would return ETMPFAIL",
 641             "dynamic": false,
 642             "type": "size_t"
 643         },
 644         "dcp_producer_snapshot_marker_yield_limit": {
 645             "default": "10",
 646             "descr": "The number of snapshots before ActiveStreamCheckpointProcessorTask::run yields.",
 647             "type": "size_t",
 648             "validator": {
 649                 "range": {
 650                     "max": 100000000,
 651                     "min": 1
 652                 }
 653             }
 654         },
 655         "dcp_consumer_process_buffered_messages_yield_limit" : {
 656             "default": "10",
 657             "descr": "The number of processBufferedMessages iterations before forcing the task to yield.",
 658             "type": "size_t",
 659             "validator": {
 660                 "range": {
 661                     "max": 100000000,
 662                     "min": 1
 663                 }
 664             }
 665         },
 666         "dcp_consumer_process_buffered_messages_batch_size" : {
 667             "default": "10",
 668             "descr": "The maximum number of items stream->processBufferedMessages will consume.",
 669             "type": "size_t",
 670             "validator": {
 671                 "range": {
 672                     "max": 100000000,
 673                     "min": 1
 674                 }
 675             }
 676         },
 677         "time_synchronization": {
 678             "default": "disabled",
 679             "descr": "No longer supported. This config parameter has no effect.",
 680             "type": "std::string",
 681             "validator": {
 682                 "enum": [
 683                     "disabled",
 684                     "enabled_without_drift",
 685                     "enabled_with_drift"
 686                 ]
 687             }
 688         },
 689         "vb0": {
 690             "default": "false",
 691             "type": "bool"
 692         },
 693         "waitforwarmup": {
 694             "default": "false",
 695             "type": "bool"
 696         },
 697         "warmup": {
 698             "default": "true",
 699             "type": "bool"
 700         },
 701         "warmup_batch_size": {
 702             "default": "10000",
 703             "descr": "The size of each batch loaded during warmup.",
 704             "dynamic": false,
 705             "type": "size_t",
 706             "validator": {
 707                 "range": {
 708                     "max": 100000000,
 709                     "min": 1
 710                 }
 711             }
 712         },
 713         "warmup_min_memory_threshold": {
 714             "default": "100",
 715             "descr": "Percentage of max mem warmed up before we enable traffic.",
 716             "type": "size_t",
 717             "validator": {
 718                 "range": {
 719                     "max": 100,
 720                     "min": 0
 721                 }
 722             }
 723         },
 724         "warmup_min_items_threshold": {
 725             "default": "100",
 726             "descr": "Percentage of total items warmed up before we enable traffic.",
 727             "type": "size_t",
 728             "validator": {
 729                 "range": {
 730                     "max": 100,
 731                     "min": 0
 732                 }
 733             }
 734         }
 735     }
 736 }