summaryrefslogtreecommitdiff
path: root/src/mongo/db/storage/execution_control/concurrency_adjustment_parameters.idl
blob: 9c1e787b4eedd3c7dff89c92ddf95ed64b7b41dd (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
# Copyright (C) 2023-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/execution_control/concurrency_adjustment_validator.h"

enums:
  StorageEngineConcurrencyAdjustmentAlgorithm:
    description: "Algorithm for adjusting the number of concurrent storage engine transactions"
    type: string
    # 'kFixedConcurrentTransactions': Number of concurrent transactions are controlled by
    # storageEngineConcurrentWriteTransactions/storageEngineConcurrentReadTransactions and will
    # not be adjusted automatically based on overall system throughput.
    #
    # 'kThroughputProbing': Number of concurrent transactions are dynamically adjusted, either
    # increasing or decreasing concurrency in the storage engine, based on system throughput.
    values:
      kFixedConcurrentTransactions: "fixedConcurrentTransactions"
      kThroughputProbing: "throughputProbing"

server_parameters:

  storageEngineConcurrencyAdjustmentAlgorithm:
    description: >-
      The algorithm to be used for adjusting the number of concurrent storage engine transactions.
      This is gated behind featureFlagExecutionControl and will have no effect if that feature is
      not enabled.
    set_at: startup
    cpp_vartype: std::string
    cpp_varname: gStorageEngineConcurrencyAdjustmentAlgorithm
    default: "throughputProbing"
    validator:
      callback: validateConcurrencyAdjustmentAlgorithm

  storageEngineConcurrencyAdjustmentIntervalMillis:
    description: >-
      The interval in milliseconds in which to run the concurrency adjustment algorithm, if it is
      not set to fixedConcurrentTransactions.
    set_at: startup
    cpp_vartype: int32_t
    cpp_varname: gStorageEngineConcurrencyAdjustmentIntervalMillis
    default: 100
    validator:
      gt: 0