summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage/wiredtiger/wiredtiger_parameters.idl
blob: c02771e1b5cefaff6c88636ceccdda8fefe0d4f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

global:
    cpp_namespace: "mongo"
    cpp_includes:
        - "mongo/db/storage/wiredtiger/wiredtiger_kv_engine.h"
        - "mongo/util/concurrency/ticketholder.h"
        - "mongo/util/debug_util.h"

server_parameters:
    wiredTigerEngineRuntimeConfig:
        description: 'WiredTiger Configuration'
        set_at: runtime
        cpp_class:
            name: WiredTigerEngineRuntimeConfigParameter
            data: 'std::pair<std::string, WiredTigerKVEngine*>'
        # The data element of this param gets initialized in three
        # disparate ways by different parts of the codebase
        # none of which are easily encoded here.
        # Defer the initialization with condition: false
        # and allow those places to manually set themselves up.
        condition: { expr: false }

    wiredTigerSessionCloseIdleTimeSecs:
        description: 'Close idle wiredtiger sessions in the session cache after this many seconds'
        cpp_vartype: 'AtomicWord<std::int32_t>'
        cpp_varname: gWiredTigerSessionCloseIdleTimeSecs
        set_at: [ startup, runtime ]
        default:
            # The default is 5 mins with a shorter default in the debug build to aid testing.
            expr: 'kDebugBuild ? 5 : 300'
        validator:
            gte: 0

    # The "wiredTigerCursorCacheSize" parameter has the following meaning.
    #
    # wiredTigerCursorCacheSize == 0
    # For this setting, cursors are only cached in the WiredTiger storage engine
    # itself. Operations that need exclusive access such as drop or verify will
    # not be blocked by inactive cached cursors with this setting. However, this
    # setting may reduce the performance of certain workloads that normally
    # benefit from cursor caching above the storage engine.
    #
    # wiredTigerCursorCacheSize > 0
    # WiredTiger-level caching of cursors is disabled but cursor caching does
    # occur above the storage engine. The value of this setting represents the
    # maximum number of cursors that are cached. Setting the value to 10000 will
    # give the old (<= 3.6) behavior. Note that cursors remain cached, even when a
    # session is released back to the cache. Thus, exclusive operations may be
    # blocked temporarily, and in some cases, a long time. Drops that fail because
    # of exclusivity silently succeed and are queued for retries.
    #
    # wiredTigerCursorCacheSize < 0
    # This is a hybrid approach of the above two, and is the default. The the
    # absolute value of the setting is used as the number of cursors cached above
    # the storage engine. When a session is released, all cursors are closed, and
    # will be cached in WiredTiger. Exclusive operations should only be blocked
    # for a short time, except if a cursor is held by a long running session. This
    # is a good compromise for most workloads.
    wiredTigerCursorCacheSize:
        description: 'Wired tiger cursor cache size'
        set_at: [ startup, runtime ]
        cpp_vartype: 'AtomicWord<std::int32_t>'
        cpp_varname: gWiredTigerCursorCacheSize
        default: -100

    wiredTigerMaxCacheOverflowSizeGB:
      description: >-
        Maximum amount of disk space to use for cache overflow;
        Defaults to 0 (unbounded)
        Deprecated.
      set_at: runtime
      cpp_vartype: 'AtomicWord<double>'
      cpp_varname: gWiredTigerMaxCacheOverflowSizeGBDeprecated
      default: 0

    wiredTigerEvictionDirtyTargetGB:
      description: >-
         Absolute dirty cache eviction target. Once eviction begins,
         it will proceed until the target of dirty data in the cache
         is reached
         Defaults to 5% cache size
      set_at: startup
      cpp_vartype: 'double'
      cpp_varname: gWiredTigerEvictionDirtyTargetGB
      default: 0
  :
        gte: 0.01
        lte: 10000

    wiredTigerEvictionDirtyMaxGB:
      description: >-
         Absolute threshold at which dirty cache eviction starts operating
         aggressively;
         Defaults to 20% cache size
      set_at: startup
      cpp_vartype: 'double'
      cpp_varname: gWiredTigerEvictionDirtyMaxGB
      default: 0
      validator:
        gte: 0.01
        lte: 10000

    wiredTigerEvictionDebugMode:
      description: >-
         If true, modify internal WiredTiger algorithms to force lookaside eviction to happen more
         aggressively.
      set_at: startup
      cpp_vartype: 'bool'
      cpp_varname: gWiredTigerEvictionDebugMode
      default: false
      # This parameter is only allowed in debug builds.
      condition:
        constexpr: 'kDebugBuild'

    wiredTigerFileHandleCloseIdleTime:
      description: >-
        The amount of time in seconds a file handle in WiredTiger needs to be idle before attempting
        to close it.
      set_at: startup
      cpp_vartype: 'std::int32_t'
      cpp_varname: gWiredTigerFileHandleCloseIdleTime
      default: 600
      validator:
        gte: 1

    wiredTigerExtraDiagnostics:
      description: >-
          Extra diagnostics that can be enabled in release mode including diagnostic assertions that can cause WiredTiger to abort upon
          detected invalid state. Valid options include: ["all", "concurrent_access", "data_validation", "invalid_op", "out_of_order",
          "panic", "slow_operation", "visibility"]
      set_at: [startup, runtime]
      cpp_vartype: 'synchronized_value<std::vector<std::string>>'
      cpp_varname: "gwiredTigerExtraDiagnostics"
      validator:
          callback: validateExtraDiagnostics

    wiredTigerFileHandleCloseMinimum:
      description: >-
        The number of handles open before the WiredTiger file manager will look for handles to close.
      set_at: startup
      cpp_vartype: 'std::int32_t'
      cpp_varname: gWiredTigerFileHandleCloseMinimum
      default: 2000
      validator:
        gte: 1

    wiredTigerFileHandleCloseScanInterval:
      description: >-
        The interval in seconds at which WiredTiger checks for inactive files and closes them.
      set_at: startup
      cpp_vartype: 'std::int32_t'
      cpp_varname: gWiredTigerFileHandleCloseScanInterval
      default: 10
      validator:
        gte: 1

    wiredTigerDirectoryForIndexes:
       description: 'Read-only view of DirectoryForIndexes config parameter'
       set_at: 'readonly'
       cpp_class:
           name: WiredTigerDirectoryForIndexesParameter

    wiredTigerSkipTableLoggingChecksOnStartup:
      description: >-
        Skips table logging setting checks and modifications on startup.
      set_at: startup
      cpp_vartype: 'bool'
      cpp_varname: gWiredTigerSkipTableLoggingChecksOnStartup
      default: false

    wiredTigerStressConfig:
      description: >-
        Encourage more interesting races in WiredTiger.
      set_at: startup
      cpp_vartype: bool
      cpp_varname: gWiredTigerStressConfig
      default: false